dev: php-tuf#142 Add PHPCS (php-tuf#145)

Author: star-szr

DEVELOP.md

@@ -21,6 +21,19 @@ To run a single test use PHPUnit's `--filter` option:
 ddev exec phpunit ./tests --debug --filter=testCannotProtectNonComposerRepository
 ```
 
+## Linting and fixing
+
+Linting for syntax, then style:
+```
+ddev composer lint
+ddev composer phpcs
+```
+
+Fixing style errors that can be automatically fixed:
+```
+ddev composer phpcbf
+```
+
 ## Static analysis
 
 To run PHPStan against the codebase:

composer.json

@@ -39,12 +39,22 @@
         "phpunit/phpunit": "^9.5",
         "symfony/process": "^6",
         "dms/phpunit-arraysubset-asserts": "^0.5.0",
-        "phpstan/phpstan": "^2.1"
+        "phpstan/phpstan": "^2.1",
+        "squizlabs/php_codesniffer": "^4.0",
+        "slevomat/coding-standard": "^8.28"
     },
     "scripts": {
+        "phpcs": "phpcs",
+        "phpcbf": "phpcbf",
         "phpstan": "phpstan",
         "test": [
             "phpunit ./tests --debug"
-        ]
+        ],
+        "lint": "find src -name '*.php' -exec php -l {} \\;"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }

phpcs.xml.dist

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset -->
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         name="PhpTuf"
+         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
+>
+
+    <description>PHP TUF Composer Integration</description>
+
+    <arg name="colors"/>
+    <arg name="parallel" value="10"/>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <!-- We basically follow PSR-2 -->
+    <rule ref="PSR2">
+        <exclude name="Generic.Files.LineLength.TooLong"/>
+    </rule>
+
+    <!-- Since PSR-2 / PSR-12 say nothing about variable lettercase, we choose a standard. -->
+    <rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps"/>
+    <rule ref="Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps"/>
+    <rule ref="Squiz.NamingConventions.ValidVariableName.StringNotCamelCaps"/>
+
+    <!-- PSR-2 doesn't enforce commenting standards.
+         https://github.com/squizlabs/PHP_CodeSniffer/issues/2314#issuecomment-448008052
+         https://www.php-fig.org/psr/psr-2/#7-conclusion
+         Add PEAR's rule to make sure comment indentation matches code.
+         @todo - breaks on switch statements.
+         @see https://github.com/php-tuf/php-tuf/issues/58
+    <rule ref="PEAR.WhiteSpace"/>
+    -->
+
+    <!-- Specify array formatting -->
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <rule ref="Generic.Arrays.ArrayIndent"/>
+    <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
+    <rule ref="Squiz.Arrays.ArrayDeclaration">
+        <!-- Disable some child rules that cause incorrect formatting. -->
+        <exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned"/>
+        <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned"/>
+        <exclude name="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed"/>
+        <exclude name="Squiz.Arrays.ArrayDeclaration.KeyNotAligned"/>
+        <exclude name="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned"/>
+    </rule>
+
+    <!-- Find unused code -->
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses"/>
+
+</ruleset>