Check coding-style in the repo

alies-dev · alies-dev · commit d98629e05019 · 2023-04-14T21:14:08.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+max_line_length = 120
+tab_width = 4
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
diff --git a/.github/workflows/format_php.yml b/.github/workflows/format_php.yml
@@ -0,0 +1,78 @@
+name: Format (PHP)
+
+on:
+  push:
+    paths:
+      - '**.php'
+      - 'composer.*'
+      - 'phpcs.xml'
+      - 'IxDFCodingStandard/ruleset.xml'
+
+jobs:
+  format_php:
+    name: Format PHP
+    runs-on: ubuntu-latest
+    timeout-minutes: 7
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          coverage: none
+          tools: cs2pr
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: |
+          echo "composer_dir={$(composer config cache-files-dir)}" >> $GITHUB_OUTPUT
+
+      - name: Retrieve Composer‘s cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.composer_dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+
+      - name: Install composer dependencies
+        run: "composer install --no-interaction --no-progress --no-scripts"
+
+      - name: Retrieve PHPCS‘s cache
+        uses: actions/cache@v3
+        with:
+          path: .phpcs.cache
+          key: ${{ runner.os }}-phpcs-${{ hashFiles('phpcs.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-phpcs-
+
+      - name: Detect PHP coding style issues
+        id: lint_php
+        run: composer cs:lint
+        continue-on-error: true
+
+      - name: Fix detected PHP coding style issues (if any)
+        if: ${{ steps.lint_php.outcome == 'failure' }}
+        id: fix_php
+        run: composer cs:fix
+        continue-on-error: true
+
+      - name: Commit PHP code-style fixes (if any)
+        if: ${{ steps.lint_php.outcome == 'failure' }}
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: "#15000 🪄️ Apply coding style fixes to PHP"
+          author_name: GitHub Actions
+          author_email: actions@github.com
+          add: '*.php'
+          pull: '--rebase --autostash'
+
+      - name: Lint PHP coding style issues (if previously detected)
+        if: ${{ steps.lint_php.outcome == 'failure' }}
+        run: composer cs:check -- --report-full --report-checkstyle=./phpcs-report.xml
+
+      - name: Show PHPCS results in on GitHub UI
+        if: ${{ steps.lint_php.outcome == 'failure' }}
+        run: cs2pr ./phpcs-report.xml
diff --git a/IxDFCodingStandard/Sniffs/Classes/ForbidMethodDeclarationSniff.php b/IxDFCodingStandard/Sniffs/Classes/ForbidMethodDeclarationSniff.php
@@ -43,7 +43,11 @@ public function process(File $phpcsFile, $classPointer): void
                 continue;
             }
 
-            $phpcsFile->addError(sprintf('Method “%s” is forbidden, use “%s” instead.', $typeAndMethod, $replacement), $classPointer, self::FORBIDDEN_METHOD_DECLARATION);
+            $phpcsFile->addError(
+                sprintf('Method “%s” is forbidden, use “%s” instead.', $typeAndMethod, $replacement),
+                $classPointer,
+                self::FORBIDDEN_METHOD_DECLARATION
+            );
         }
     }
 }
diff --git a/IxDFCodingStandard/Sniffs/Files/BemCasedFilenameSniff.php b/IxDFCodingStandard/Sniffs/Files/BemCasedFilenameSniff.php
@@ -8,10 +8,14 @@
 /** Checks that all file names are BEM-cased. */
 final class BemCasedFilenameSniff implements Sniff
 {
+    private const ERROR_TOO_MANY_DELIMITERS = 'TooManyElementModifiers';
+    private const ERROR_TOO_MANY_MODIFIERS = 'TooManyElementModifiers';
+    private const ERROR_INVALID_CHARACTERS = 'InvalidCharacters';
+
     private const MODIFIER_DELIMITER = '--';
     private const ELEMENT_DELIMITER = '__';
-    private const BEM_FILE_NAME_PATTERN = '/^(?:(?:(?:__)?[a-z][a-zA-Z0-9]*)(?:(?:--)[\w][a-zA-Z0-9]*)?)+?\.blade\.php$/';
-    private const BLADE_COMPONENT_FILE_NAME_PATTERN = '/^([a-z]+(\-[a-z]+)+)\.blade\.php$/';
+    private const BEM_FILE_NAME_PATTERN = '/^(?:(?:__)?[a-z][a-zA-Z0-9]*(?:--[\w][a-zA-Z0-9]*)?)+?\.blade\.php$/';
+    private const BLADE_COMPONENT_FILE_NAME_PATTERN = '/^([a-z]+(-[a-z]+)+)\.blade\.php$/';
 
     /** @var array<string, bool> */
     private array $checkedFiles = [];
@@ -23,9 +27,12 @@ public function register(): array
     }
 
     /** @inheritDoc */
-    public function process(File $phpcsFile, $stackPtr): int
+    public function process(File $phpcsFile, $stackPtr): int // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
     {
         $filename = $phpcsFile->getFilename();
+        if (! str_ends_with($filename, '.blade.php')) {
+            return 0;
+        }
 
         $hash = md5($filename);
         if (isset($this->checkedFiles[$hash]) || $filename === 'STDIN') {
@@ -40,7 +47,7 @@ public function process(File $phpcsFile, $stackPtr): int
             $phpcsFile->addError(
                 'Filename “%s” has too many element delimiters',
                 $stackPtr,
-                'TooManyElementDelimiters',
+                self::ERROR_TOO_MANY_DELIMITERS,
                 [$filename]
             );
             $phpcsFile->recordMetric($stackPtr, 'BEM element delimiters', 'no');
@@ -52,7 +59,7 @@ public function process(File $phpcsFile, $stackPtr): int
             $phpcsFile->addError(
                 'Filename “%s” has to many element modifiers',
                 $stackPtr,
-                'TooManyElementModifiers',
+                self::ERROR_TOO_MANY_MODIFIERS,
                 [$filename]
             );
             $phpcsFile->recordMetric($stackPtr, 'BEM element modifiers', 'no');
@@ -64,7 +71,7 @@ public function process(File $phpcsFile, $stackPtr): int
             $phpcsFile->recordMetric($stackPtr, 'BEM case filename', 'yes');
         } else {
             $error = 'Filename “%s” does not match the expected BEM filename convention';
-            $phpcsFile->addError($error, $stackPtr, 'InvalidCharacters', [$filename]);
+            $phpcsFile->addError($error, $stackPtr, self::ERROR_INVALID_CHARACTERS, [$filename]);
             $phpcsFile->recordMetric($stackPtr, 'BEM case filename', 'no');
         }
 
@@ -79,7 +86,9 @@ private function hasInvalidNumberOfElements(string $filename): bool
 
     private function hasCorrectFileName(string $filename): bool
     {
-        return $this->isBemFilename($filename) || $this->isComponentFileName($filename) || $this->isErrorPage($filename);
+        return $this->isBemFilename($filename)
+            || $this->isComponentFileName($filename)
+            || $this->isErrorPage($filename);
     }
 
     private function isBemFilename(string $filename): bool
diff --git a/IxDFCodingStandard/Sniffs/Laravel/NonExistingBladeTemplateSniff.php b/IxDFCodingStandard/Sniffs/Laravel/NonExistingBladeTemplateSniff.php
@@ -10,9 +10,11 @@ final class NonExistingBladeTemplateSniff implements Sniff
 {
     private const INVALID_METHOD_CALL = 'Invalid method call';
 
-    private const INCLUDE_BLADE_DIRECTIVE = '/@(include|component|extends)\(\'([^\']++)\'/'; // @include
+    // @include
+    private const INCLUDE_BLADE_DIRECTIVE = '/@(include|component|extends)\(\'([^\']++)\'/';
 
-    private const CONDITIONAL_INCLUDE_BLADE_DIRECTIVE = '/@(includeIf|includeWhen)\([^,]++,\s*+\'([^\']++)\'/'; // @includeIf
+    // @includeIf
+    private const CONDITIONAL_INCLUDE_BLADE_DIRECTIVE = '/@(includeIf|includeWhen)\([^,]++,\s*+\'([^\']++)\'/';
 
     /** @var array<string, bool> */
     private array $checkedFiles = [];
@@ -27,7 +29,7 @@ public function register(): array
     }
 
     /** @inheritDoc */
-    public function process(File $phpcsFile, $stackPtr): int // phpcs:ignore Generic.Metrics.CyclomaticComplexity.MaxExceeded
+    public function process(File $phpcsFile, $stackPtr): int // phpcs:ignore Generic.Metrics.CyclomaticComplexity.MaxExceeded, SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
     {
         $tokens = $phpcsFile->getTokens();
 
@@ -162,7 +164,7 @@ private function isViewFacade(array $tokens, int $position): bool
     }
 
     /** @param array<array<string>> $tokens */
-    private function getViewFacadeTemplateName(array $tokens, int $position): string
+    private function getViewFacadeTemplateName(array $tokens, int $position): string // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
     {
         if (! $this->isViewFacade($tokens, $position)) {
             throw new BadMethodCallException(self::INVALID_METHOD_CALL);
@@ -193,7 +195,7 @@ private function isViewFunctionFactory(array $tokens, int $position): bool
     }
 
     /** @param array<array<string>> $tokens */
-    private function getViewFunctionFactoryTemplateName(array $tokens, int $position): string
+    private function getViewFunctionFactoryTemplateName(array $tokens, int $position): string // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
     {
         if (! $this->isViewFunctionFactory($tokens, $position)) {
             throw new BadMethodCallException(self::INVALID_METHOD_CALL);
diff --git a/IxDFCodingStandard/Sniffs/NamingConventions/CamelCaseRouteNameSniff.php b/IxDFCodingStandard/Sniffs/NamingConventions/CamelCaseRouteNameSniff.php
@@ -41,7 +41,11 @@ public function processRouteName(File $phpcsFile, int $stackPtr, array $tokens):
         $routeName = $tokens[$routeNameLocation]['content'];
 
         if (!$this->isCamelCase($routeName)) {
-            $phpcsFile->addError('Route names must be in camel case', $routeNameLocation, self::CODE_NOT_CAMEL_CASE_ROUTE_NAME);
+            $phpcsFile->addError(
+                'Route name is not camel cased',
+                $routeNameLocation,
+                self::CODE_NOT_CAMEL_CASE_ROUTE_NAME
+            );
         }
     }
 
diff --git a/IxDFCodingStandard/Sniffs/NamingConventions/MeaningfulVariableNameSniff.php b/IxDFCodingStandard/Sniffs/NamingConventions/MeaningfulVariableNameSniff.php
@@ -56,11 +56,13 @@ protected function processMemberVar(File $phpcsFile, $stackPtr): void
      * @param int|string $stackPtr The position of the double-quoted string.
      * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      */
-    protected function processVariableInString(File $phpcsFile, $stackPtr): void
+    protected function processVariableInString(File $phpcsFile, $stackPtr): void // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
     {
         $tokens = $phpcsFile->getTokens();
 
-        if (preg_match_all('|[^\\\]\$([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)|', $tokens[$stackPtr]['content'], $matches) !== 0) {
+        $subject = $tokens[$stackPtr]['content'];
+
+        if (preg_match_all('|[^\\\]\$([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)|', $subject, $matches) !== 0) {
             foreach ($matches[1] as $varName) {
                 // If it’s a php reserved var, then it's ok.
                 if (isset($this->phpReservedVars[$varName]) === true) {
diff --git a/README.md b/README.md
@@ -17,8 +17,8 @@ composer require --dev interaction-design-foundation/coding-standard
 2. Add composer scripts into your `composer.json`:
 ```json
 "scripts": {
-  "cs:check": "phpcs",
-  "cs:fix": "phpcbf"
+  "cs:check": "phpcs -p -s --colors --report-full --report-summary",
+  "cs:fix": "phpcbf -p --colors"
 }
 ```
 
diff --git a/composer.json b/composer.json
@@ -31,8 +31,8 @@
         }
     },
     "scripts": {
-        "cs-check": "phpcs",
-        "cs-fix": "phpcbf",
+        "cs:check": "phpcs -p -s --colors --report-full --report-summary --cache=./.cache/phpcs",
+        "cs:fix": "phpcbf -p --colors --cache=./.cache/phpcs",
         "test": "phpunit",
         "psalm": "psalm"
     }
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/ideas.md b/docs/ideas.md
@@ -1,4 +1,4 @@
-# Ideas for new sniffs
+# Ideas for new Laravel sniffs
 
 1. Validation rule syntax: don’t use user’s input in unique rule (security)
 1. Validation rule syntax: prefer an array instead `|`
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<ruleset name="IxDFCodingStandard (package version)">
+    <!-- Include all rules from the IxDF Coding Standard -->
+    <rule ref="./IxDFCodingStandard/ruleset.xml"/>
+
+    <rule ref="Generic.Files.LineLength.TooLong">
+        <severity>1</severity>
+        <properties>
+            <property name="lineLimit" value="150"/>
+            <property name="absoluteLineLimit" value="150"/>
+            <property name="ignoreComments" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
+        <exclude-pattern>./tests*</exclude-pattern>
+    </rule>
+
+    <!-- Paths to check -->
+    <file>IxDFCodingStandard</file>
+    <file>tests</file>
+</ruleset>
diff --git a/phpunit.xml b/phpunit.xml
@@ -2,23 +2,23 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd"
          bootstrap="tests/bootstrap.php"
-         cacheDirectory=".phpunit.cache"
+         cacheDirectory=".cache/phpunit/phpunit.cache"
          executionOrder="depends,defects"
          requireCoverageMetadata="true"
          beStrictAboutCoverageMetadata="true"
          beStrictAboutOutputDuringTests="true"
-         convertDeprecationsToExceptions="true"
          failOnRisky="true"
-         failOnWarning="true">
-    <testsuites>
-        <testsuite name="default">
-            <directory suffix="Test.php">./tests/</directory>
-        </testsuite>
-    </testsuites>
-
-    <coverage>
-        <include>
-            <directory suffix=".php">IxDFCodingStandard</directory>
-        </include>
-    </coverage>
+         failOnWarning="true"
+>
+  <testsuites>
+    <testsuite name="default">
+      <directory suffix="Test.php">./tests/</directory>
+    </testsuite>
+  </testsuites>
+  <coverage/>
+  <source>
+    <include>
+      <directory suffix=".php">IxDFCodingStandard</directory>
+    </include>
+  </source>
 </phpunit>

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,11 @@ public function process(File $phpcsFile, $classPointer): void`
`43`	`43`	`continue;`
`44`	`44`	`}`
`45`	`45`
`46`		`- $phpcsFile->addError(sprintf('Method “%s” is forbidden, use “%s” instead.', $typeAndMethod, $replacement), $classPointer, self::FORBIDDEN_METHOD_DECLARATION);`
	`46`	`+ $phpcsFile->addError(`
	`47`	`+ sprintf('Method “%s” is forbidden, use “%s” instead.', $typeAndMethod, $replacement),`
	`48`	`+ $classPointer,`
	`49`	`+ self::FORBIDDEN_METHOD_DECLARATION`
	`50`	`+ );`
`47`	`51`	`}`
`48`	`52`	`}`
`49`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,11 @@ final class NonExistingBladeTemplateSniff implements Sniff`
`10`	`10`	`{`
`11`	`11`	`private const INVALID_METHOD_CALL = 'Invalid method call';`
`12`	`12`
`13`		`- private const INCLUDE_BLADE_DIRECTIVE = '/@(include\|component\|extends)\(\'([^\']++)\'/'; // @include`
	`13`	`+ // @include`
	`14`	`+ private const INCLUDE_BLADE_DIRECTIVE = '/@(include\|component\|extends)\(\'([^\']++)\'/';`
`14`	`15`
`15`		`- private const CONDITIONAL_INCLUDE_BLADE_DIRECTIVE = '/@(includeIf\|includeWhen)\([^,]++,\s*+\'([^\']++)\'/'; // @includeIf`
	`16`	`+ // @includeIf`
	`17`	`+ private const CONDITIONAL_INCLUDE_BLADE_DIRECTIVE = '/@(includeIf\|includeWhen)\([^,]++,\s*+\'([^\']++)\'/';`
`16`	`18`
`17`	`19`	`/** @var array<string, bool> */`
`18`	`20`	`private array $checkedFiles = [];`
`@@ -27,7 +29,7 @@ public function register(): array`
`27`	`29`	`}`
`28`	`30`
`29`	`31`	`/** @inheritDoc */`
`30`		`- public function process(File $phpcsFile, $stackPtr): int // phpcs:ignore Generic.Metrics.CyclomaticComplexity.MaxExceeded`
	`32`	`+ public function process(File $phpcsFile, $stackPtr): int // phpcs:ignore Generic.Metrics.CyclomaticComplexity.MaxExceeded, SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh`
`31`	`33`	`{`
`32`	`34`	`$tokens = $phpcsFile->getTokens();`
`33`	`35`
`@@ -162,7 +164,7 @@ private function isViewFacade(array $tokens, int $position): bool`
`162`	`164`	`}`
`163`	`165`
`164`	`166`	`/** @param array<array<string>> $tokens */`
`165`		`- private function getViewFacadeTemplateName(array $tokens, int $position): string`
	`167`	`+ private function getViewFacadeTemplateName(array $tokens, int $position): string // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh`
`166`	`168`	`{`
`167`	`169`	`if (! $this->isViewFacade($tokens, $position)) {`
`168`	`170`	`throw new BadMethodCallException(self::INVALID_METHOD_CALL);`
`@@ -193,7 +195,7 @@ private function isViewFunctionFactory(array $tokens, int $position): bool`
`193`	`195`	`}`
`194`	`196`
`195`	`197`	`/** @param array<array<string>> $tokens */`
`196`		`- private function getViewFunctionFactoryTemplateName(array $tokens, int $position): string`
	`198`	`+ private function getViewFunctionFactoryTemplateName(array $tokens, int $position): string // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh`
`197`	`199`	`{`
`198`	`200`	`if (! $this->isViewFunctionFactory($tokens, $position)) {`
`199`	`201`	`throw new BadMethodCallException(self::INVALID_METHOD_CALL);`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,11 @@ public function processRouteName(File $phpcsFile, int $stackPtr, array $tokens):`
`41`	`41`	`$routeName = $tokens[$routeNameLocation]['content'];`
`42`	`42`
`43`	`43`	`if (!$this->isCamelCase($routeName)) {`
`44`		`- $phpcsFile->addError('Route names must be in camel case', $routeNameLocation, self::CODE_NOT_CAMEL_CASE_ROUTE_NAME);`
	`44`	`+ $phpcsFile->addError(`
	`45`	`+ 'Route name is not camel cased',`
	`46`	`+ $routeNameLocation,`
	`47`	`+ self::CODE_NOT_CAMEL_CASE_ROUTE_NAME`
	`48`	`+ );`
`45`	`49`	`}`
`46`	`50`	`}`
`47`	`51`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,8 @@`
`31`	`31`	`}`
`32`	`32`	`},`
`33`	`33`	`"scripts": {`
`34`		`- "cs-check": "phpcs",`
`35`		`- "cs-fix": "phpcbf",`
	`34`	`+ "cs:check": "phpcs -p -s --colors --report-full --report-summary --cache=./.cache/phpcs",`
	`35`	`+ "cs:fix": "phpcbf -p --colors --cache=./.cache/phpcs",`
`36`	`36`	`"test": "phpunit",`
`37`	`37`	`"psalm": "psalm"`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Ideas for new sniffs`
	`1`	`+# Ideas for new Laravel sniffs`
`2`	`2`
`3`	`3`	`1. Validation rule syntax: don’t use user’s input in unique rule (security)`
`4`	`4`	1. Validation rule syntax: prefer an array instead `\|`