From f8347a12a37eeefb9ced3593b2ae10f3d9603b91 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Mon, 6 May 2024 09:25:45 -0300 Subject: [PATCH 1/3] Fix docs --- README.md | 32 ++++++-------------------------- composer.json | 4 ++-- docs/internals.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 53 insertions(+), 28 deletions(-) create mode 100644 docs/internals.md diff --git a/README.md b/README.md index 1223244..375bcfb 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,10 @@ The package contains various network utilities useful for: ## Installation -The package could be installed with composer: +The package could be installed with [Composer](https://getcomposer.org): ```shell -composer require yiisoft/network-utilities --prefer-dist +composer require yiisoft/network-utilities ``` ## General usage @@ -74,32 +74,12 @@ if (!DnsHelper::existsA('yiiframework.com')) { } ``` -## Testing +## Documentation -### Unit testing +- [Internals](docs/internals.md) -The package is tested with [PHPUnit](https://phpunit.de/). To run tests: - -```shell -./vendor/bin/phpunit -``` - -### Mutation testing - -The package tests are checked with [Infection](https://infection.github.io/) mutation framework with -[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it: - -```shell -./vendor/bin/roave-infection-static-analysis-plugin -``` - -### Static analysis - -The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis: - -```shell -./vendor/bin/psalm -``` +If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. +You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). ## License diff --git a/composer.json b/composer.json index d6009a7..5efaef8 100644 --- a/composer.json +++ b/composer.json @@ -14,7 +14,7 @@ "issues": "https://github.com/yiisoft/network-utilities/issues?state=open", "forum": "https://www.yiiframework.com/forum/", "wiki": "https://www.yiiframework.com/wiki/", - "irc": "irc://irc.freenode.net/yii", + "irc": "ircs://irc.libera.chat:6697/yii", "chat": "https://t.me/yii3en", "source": "https://github.com/yiisoft/network-utilities" }, @@ -48,4 +48,4 @@ "composer/package-versions-deprecated": true } } -} +} \ No newline at end of file diff --git a/docs/internals.md b/docs/internals.md new file mode 100644 index 0000000..8dc4049 --- /dev/null +++ b/docs/internals.md @@ -0,0 +1,45 @@ +# Internals + +## Unit testing + +The package is tested with [PHPUnit](https://phpunit.de/). To run tests: + +```shell +./vendor/bin/phpunit +``` + +## Mutation testing + +The package tests are checked with [Infection](https://infection.github.io/) mutation framework with +[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it: + +```shell +./vendor/bin/roave-infection-static-analysis-plugin +``` + +## Static analysis + +The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis: + +```shell +./vendor/bin/psalm +``` + +## Rector + +Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or +use either newest or any specific version of PHP: + +```shell +./vendor/bin/rector +``` + +## Composer require checker + +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. + +To run the checker, execute the following command: + +```shell +./vendor/bin/composer-require-checker +``` From fcac95077c439f38b5c143dbb08709cf188f4b8e Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Sat, 18 May 2024 07:24:03 +0300 Subject: [PATCH 2/3] Update composer.json --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 5efaef8..4beab3f 100644 --- a/composer.json +++ b/composer.json @@ -48,4 +48,4 @@ "composer/package-versions-deprecated": true } } -} \ No newline at end of file +} From 0d95d00180fd3468e3bf4a7521c66125ee5ded0d Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Sat, 18 May 2024 07:24:40 +0300 Subject: [PATCH 3/3] Update internals.md --- docs/internals.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/docs/internals.md b/docs/internals.md index 8dc4049..b37b5b8 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -24,22 +24,3 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ```shell ./vendor/bin/psalm ``` - -## Rector - -Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or -use either newest or any specific version of PHP: - -```shell -./vendor/bin/rector -``` - -## Composer require checker - -This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. - -To run the checker, execute the following command: - -```shell -./vendor/bin/composer-require-checker -```