Add composer commands for tools

opencultureconsulting · Jul 11, 2024 · c249ac7 · c249ac7
1 parent e3c315d
commit c249ac7
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 /.phpdoc/cache/
 /.vscode/
 /vendor/
+.php-cs-fixer.cache
 .php-cs-fixer.php
 composer.lock
 phpcs.xml

diff --git a/composer.json b/composer.json
@@ -42,15 +42,49 @@
         "php": "^8.1"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.10",
-        "phpstan/phpstan-strict-rules": "^1.5",
-        "friendsofphp/php-cs-fixer": "^3.52",
-        "squizlabs/php_codesniffer": "^3.9",
-        "vimeo/psalm": "^5.23"
+        "phpdocumentor/shim": "^3.5",
+        "phpstan/phpstan": "^1.11",
+        "phpstan/phpstan-strict-rules": "^1.6",
+        "friendsofphp/php-cs-fixer": "^3.59",
+        "squizlabs/php_codesniffer": "^3.10",
+        "vimeo/psalm": "^5.25"
     },
     "autoload": {
         "psr-4": {
             "OCC\\Basics\\": "src/"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "phpdocumentor/shim": true
+        }
+    },
+    "scripts": {
+        "php-cs-fixer:check": [
+            "@php vendor/bin/php-cs-fixer check"
+        ],
+        "php-cs-fixer:fix": [
+            "@php vendor/bin/php-cs-fixer fix"
+        ],
+        "phpcs:check": [
+            "@php vendor/bin/phpcs"
+        ],
+        "phpdoc:build": [
+            "@php vendor/bin/phpdoc"
+        ],
+        "phpstan:check": [
+            "@php vendor/bin/phpstan"
+        ],
+        "psalm:check": [
+            "@php vendor/bin/psalm"
+        ]
+    },
+    "scripts-descriptions": {
+        "php-cs-fixer:check": "Runs a code check with PHP Coding Standards Fixer and reports problems. If a custom configuration file '.php-cs-fixer.php' exists, it will be used instead of the default settings in '.php-cs-fixer.dist.php'.",
+        "php-cs-fixer:fix": "Runs a code check with PHP Coding Standards Fixer and tries to fix all issues. If a custom configuration file '.php-cs-fixer.php' exists, it will be used instead of the default settings in '.php-cs-fixer.dist.php'.",
+        "phpcs:check": "Runs a code check with PHP_CodeSniffer and reports problems. If a custom configuration file '.phpcs.xml' exists, it will be used instead of the default settings in '.phpcs.xml.dist'.",
+        "phpdoc:build": "Builds the documentation from source files in ./src and additional templates in .phpdoc/. If a custom configuration file 'phpdoc.xml' exists, it will be used instead of the default settings in 'phpdoc.dist.xml'.",
+        "phpstan:check": "Runs a code check with PHPStan static code analyzer and reports problems. If a custom configuration file 'phpstan.neon' exists, it will be used instead of the default settings in 'phpstan.dist.neon'.",
+        "psalm:check": "Runs a code check with Psalm static code analyzer and reports problems. If a custom configuration file 'psalm.xml' exists, it will be used instead of the default settings in 'psalm.xml.dist'."
     }
 }