Merge pull request #267 from PHPCSStandards/feature/add-phpstan

Add PHPStan to QA checks

Author: jrfnl

.gitattributes

@@ -12,6 +12,7 @@
 .remarkrc                export-ignore
 .yamllint.yml            export-ignore
 phpcs.xml.dist           export-ignore
+phpstan.neon.dist        export-ignore
 phpunit.xml.dist         export-ignore
 phpunit-bootstrap.php    export-ignore
 /.github/                export-ignore

.github/workflows/basics.yml

@@ -95,6 +95,33 @@ jobs:
       - name: Check sniff feature completeness
         run: composer check-complete
 
+  phpstan:
+    name: "PHPStan"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          coverage: none
+          tools: phpstan
+
+      # Install dependencies and handle caching in one go.
+      # Dependencies need to be installed to make sure the PHPCS and PHPUnit classes are recognized.
+      # @link https://github.com/marketplace/actions/install-composer-dependencies
+      - name: Install Composer dependencies
+        uses: "ramsey/composer-install@v2"
+        with:
+          # Bust the cache at least once a month - output format: YYYY-MM.
+          custom-cache-suffix: $(date -u "+%Y-%m")
+
+      - name: Run PHPStan
+        run: phpstan analyse
+
   remark:
     name: 'QA Markdown'
     runs-on: ubuntu-latest

.gitignore

@@ -5,3 +5,4 @@ vendor/
 /phpcs.xml
 /phpunit.xml
 /.phpunit.result.cache
+phpstan.neon

phpstan.neon.dist

@@ -0,0 +1,52 @@
+parameters:
+    #phpVersion: 50400 # Needs to be 70100 or higher... sigh...
+    level: 6
+    paths:
+        - Modernize
+        - NormalizedArrays
+        - Universal
+    bootstrapFiles:
+        - phpunit-bootstrap.php
+    treatPhpDocTypesAsCertain: false
+
+    ignoreErrors:
+        # Level 1
+        # Keep to stay in line with parent class.
+        -
+            message: '`^Constructor of class PHPCSExtra\\Universal\\Helpers\\DummyTokenizer has an unused parameter \$content\.$`'
+            path: Universal\Helpers\DummyTokenizer.php
+            count: 1
+
+        # Level 4
+        # PHPStan doesn't seem to like uninitialized properties...
+        -
+            message: '`^Property \S+Sniff::\$(phpVersion|tabWidth) \(int\) in isset\(\) is not nullable\.$`'
+            paths:
+              - Modernize\Sniffs\FunctionCalls\DirnameSniff.php
+              - Universal\Sniffs\Arrays\DuplicateArrayKeySniff.php
+              - Universal\Sniffs\CodeAnalysis\ConstructorDestructorReturnSniff.php
+              - Universal\Sniffs\WhiteSpace\CommaSpacingSniff.php
+              - Universal\Sniffs\WhiteSpace\DisallowInlineTabsSniff.php
+              - Universal\Sniffs\WhiteSpace\PrecisionAlignmentSniff.php
+        -
+            message: '`^Strict comparison using === between true and false will always evaluate to false\.$`'
+            paths:
+              - Modernize\Sniffs\FunctionCalls\DirnameSniff.php
+              - Universal\Sniffs\Arrays\DuplicateArrayKeySniff.php
+              - Universal\Sniffs\CodeAnalysis\ConstructorDestructorReturnSniff.php
+              - Universal\Sniffs\WhiteSpace\CommaSpacingSniff.php
+              - Universal\Sniffs\WhiteSpace\DisallowInlineTabsSniff.php
+              - Universal\Sniffs\WhiteSpace\PrecisionAlignmentSniff.php
+        -
+            message: '`^Property PHPCSExtra\\Universal\\Sniffs\\Arrays\\DuplicateArrayKeySniff\:\:\$currentMaxIntKey[GL]t8 \(int\) in isset\(\) is not nullable\.$`'
+            path: Universal\Sniffs\Arrays\DuplicateArrayKeySniff.php
+            count: 5
+        -
+            message: '`^Result of && is always false\.$`'
+            path: Universal\Sniffs\Arrays\DuplicateArrayKeySniff.php
+            count: 1
+
+        # Level 5
+        # We're not using strict types, so this will be juggled without any issues.
+        - '#^Parameter \#3 \$value of method \S+File::recordMetric\(\) expects string, \(?(float|int|bool)(<[^>]+>)?(\|(float|int|bool)(<[^>]+>)?)*\)? given\.$#'
+        - '#^Parameter \#2 \$content of method \S+Fixer::replaceToken\(\) expects string, \(?(float|int|bool)(<[^>]+>)?(\|(float|int|bool)(<[^>]+>)?)*\)? given\.$#'