Updated documentation, composer dependencies, fixed php-cs-fixer code…

… quality tool.
systemsdk · Feb 11, 2023 · 224445f · 224445f
1 parent 43087c9
commit 224445f
Show file tree

Hide file tree

Showing 32 changed files with 1,476 additions and 1,139 deletions.
diff --git a/composer.json b/composer.json
@@ -87,11 +87,7 @@
 			"Symplify\\CodingStandard\\": "tools/03_ecs/vendor/symplify/easy-coding-standard/vendor/symplify/coding-standard/src",
 			"Symplify\\EasyCodingStandard\\": "tools/03_ecs/vendor/symplify/easy-coding-standard/src",
 			"ECSPrefix20210928\\Symplify\\RuleDocGenerator\\": "tools/03_ecs/vendor/symplify/easy-coding-standard/vendor/symplify/rule-doc-generator-contracts/src",
-			"Rector\\Core\\": "tools/08_rector/vendor/rector/rector/src",
-			"Rector\\Php74\\": "tools/08_rector/vendor/rector/rector/rules/Php74",
-			"Rector\\Php80\\": "tools/08_rector/vendor/rector/rector/rules/Php80",
-			"Rector\\Php81\\": "tools/08_rector/vendor/rector/rector/rules/Php81",
-			"Rector\\Set\\": "tools/08_rector/vendor/rector/rector/packages/Set"
+			"Rector\\": "tools/08_rector/vendor/rector/"
 		}
 	},
 	"minimum-stability": "dev",

diff --git a/composer.lock b/composer.lock
diff --git a/docs/images/phpstorm_01.png b/docs/images/phpstorm_01.png
diff --git a/docs/images/phpstorm_02.png b/docs/images/phpstorm_02.png
diff --git a/docs/images/phpstorm_03.png b/docs/images/phpstorm_03.png
diff --git a/docs/images/phpstorm_04.png b/docs/images/phpstorm_04.png
diff --git a/docs/images/phpstorm_05.png b/docs/images/phpstorm_05.png
diff --git a/docs/images/phpstorm_06.png b/docs/images/phpstorm_06.png
diff --git a/docs/images/phpstorm_07.png b/docs/images/phpstorm_07.png
diff --git a/docs/images/phpstorm_08.png b/docs/images/phpstorm_08.png
diff --git a/docs/images/phpstorm_09.png b/docs/images/phpstorm_09.png
diff --git a/docs/images/phpstorm_10.png b/docs/images/phpstorm_10.png
diff --git a/docs/images/phpstorm_11.png b/docs/images/phpstorm_11.png
diff --git a/docs/images/phpstorm_11_1.png b/docs/images/phpstorm_11_1.png
diff --git a/docs/images/phpstorm_11_2.png b/docs/images/phpstorm_11_2.png
diff --git a/docs/images/phpstorm_11_3.png b/docs/images/phpstorm_11_3.png
diff --git a/docs/images/xdebug_01.png b/docs/images/xdebug_01.png
diff --git a/docs/phpstorm.md b/docs/phpstorm.md
@@ -55,9 +55,14 @@ In order to use Xdebug as debugging tool please follow [Using Xdebug](xdebug.md)
 ![Path mappings](images/phpstorm_09.png)
 ![Path mappings](images/phpstorm_10.png)
 
-* Go to `Settings -> Editor -> Inspections` and import profile `Systemsdk` (Inspections.xml) from [docs/phpstorm](phpstorm) and make sure that you have proper path to `phpmd_ruleset.xml`:
+* Set other configurations for code quality tools and make sure that you have proper path for the MessDetector ruleset `phpmd_ruleset.xml`:
 
-![Path mappings](images/phpstorm_11.png)
+![Path mappings](images/phpstorm_11_1.png)
+![Path mappings](images/phpstorm_11_2.png)
+
+* Go to `Settings -> Editor -> Inspections` and import profile `Systemsdk` (Inspections.xml) from [docs/phpstorm](phpstorm):
+
+![Path mappings](images/phpstorm_11_3.png)
 
 * Go to `Settings -> Tools -> External tools` and create ecs tool:
 

diff --git a/docs/phpstorm/Inspections.xml b/docs/phpstorm/Inspections.xml
@@ -109,7 +109,6 @@
     <option name="CODING_STANDARD" value="PSR12" />
     <option name="CUSTOM_RULESET_PATH" value=".php-cs-fixer.dist.php" />
     <option name="SHOW_SNIFF_NAMES" value="true" />
-    <option name="EXTENSIONS" value="php,js,css,inc" />
   </inspection_tool>
   <inspection_tool class="PhpDivisionByZeroInspection" enabled="true" level="WARNING" enabled_by_default="true" />
   <inspection_tool class="PhpDocMissingReturnTagInspection" enabled="true" level="WARNING" enabled_by_default="true">
@@ -118,18 +117,12 @@
   <inspection_tool class="PhpDocMissingThrowsInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
     <option name="SKIP_ON_EMPTY_PHPDOC" value="false" />
   </inspection_tool>
-  <inspection_tool class="PhpDocSignatureInspection" enabled="true" level="WARNING" enabled_by_default="true">
-    <option name="ALLOW_MISSING_PARAMETERS" value="true" />
-  </inspection_tool>
+  <inspection_tool class="PhpDocSignatureInspection" enabled="true" level="WARNING" enabled_by_default="true" />
   <inspection_tool class="PhpMethodOrClassCallIsNotCaseSensitiveInspection" enabled="true" level="WARNING" enabled_by_default="true" />
-  <inspection_tool class="PhpMissingDocCommentInspection" enabled="true" level="WARNING" enabled_by_default="true">
-    <option name="SKIP_EMPTY_FUNCTION" value="false" />
-    <option name="SKIP_EMPTY_METHOD" value="false" />
-  </inspection_tool>
+  <inspection_tool class="PhpMissingDocCommentInspection" enabled="true" level="WARNING" enabled_by_default="true" />
   <inspection_tool class="PhpMissingParentCallCommonInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
   <inspection_tool class="PhpMissingParentCallMagicInspection" enabled="true" level="WARNING" enabled_by_default="true" />
   <inspection_tool class="PhpMissingStrictTypesDeclarationInspection" enabled="true" level="WARNING" enabled_by_default="true" />
-  <inspection_tool class="PhpShortOpenTagInspection" enabled="true" level="WARNING" enabled_by_default="true" />
   <inspection_tool class="PhpStanGlobal" enabled="true" level="WEAK WARNING" enabled_by_default="true">
     <option name="level" value="8" />
     <option name="config" value="phpstan.neon.dist" />

diff --git a/php-cs-fixer.php b/php-cs-fixer.php
@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+# Temporary solution for PhpStorm quality tools as php-cs-fixer is not supporting php 8.2 currently
+putenv('PHP_CS_FIXER_IGNORE_ENV=1');
+include __DIR__ . '/vendor/bin/php-cs-fixer';
diff --git a/tools/01_phpunit/composer.json b/tools/01_phpunit/composer.json
@@ -3,7 +3,7 @@
 	"description": "",
 	"require": {},
 	"require-dev": {
-		"phpunit/phpunit": "9.5.*",
+		"phpunit/phpunit": "9.6.*",
 		"roave/security-advisories": "dev-latest"
 	},
 	"config": {

diff --git a/tools/01_phpunit/composer.lock b/tools/01_phpunit/composer.lock