Skip to content

Commit

Permalink
[TASK] Drop PHP_CodeSniffer (#468)
Browse files Browse the repository at this point in the history
This tool is not well-maintained anymore, and it has no PER2 coding
standard, which is a blocker for us moving to PER2.

PHP-CS-Fixer already has a PER2 coding standard. If we use PHP-CS-Fixer
on PER2 and PHP_CodeSniffer on PSR12 (the latest available standard there),
both tools would keep overwriting each other's changes endlessly, and
they would never agree on the correct formatting.
  • Loading branch information
oliverklee committed Feb 13, 2024
1 parent 52ff901 commit 8bb6080
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 28 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ jobs:
fail-fast: false
matrix:
command:
- sniffer
- fixer
- stan
php-version:
Expand Down Expand Up @@ -120,7 +119,7 @@ jobs:
- name: Install development tools
run: |
phive --no-progress install --trust-gpg-keys BBAB5DF0A0D6672989CF1869E82B2FB314E9906E,95DE904AB800754A11D80B605E6DDE998AB73B8E
phive --no-progress install --trust-gpg-keys BBAB5DF0A0D6672989CF1869E82B2FB314E9906E
- name: Run Command
run: composer ci:php:${{ matrix.command }}
2 changes: 0 additions & 2 deletions .phive/phars.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<phive xmlns="https://phar.io/phive">
<phar name="php-cs-fixer" version="^3.49.0" installed="3.49.0" location="./.phive/php-cs-fixer.phar" copy="false"/>
<phar name="phpcbf" version="^3.8.1" installed="3.8.1" location="./.phive/phpcbf.phar" copy="false"/>
<phar name="phpcs" version="^3.8.1" installed="3.8.1" location="./.phive/phpcs.phar" copy="false"/>
</phive>
8 changes: 1 addition & 7 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,30 +65,24 @@
"@ci:static"
],
"ci:php:fixer": "@php ./.phive/php-cs-fixer.phar --config=config/php-cs-fixer.php fix --dry-run -v --show-progress=dots bin src tests",
"ci:php:sniffer": "@php ./.phive/phpcs.phar --standard=config/phpcs.xml bin src tests",
"ci:php:stan": "phpstan --no-progress --configuration=config/phpstan.neon",
"ci:static": [
"@ci:php:fixer",
"@ci:php:sniffer",
"@ci:php:stan"
],
"fix:php": [
"@fix:php:fixer",
"@fix:php:sniffer"
"@fix:php:fixer"
],
"fix:php:fixer": "@php ./.phive/php-cs-fixer.phar --config=config/php-cs-fixer.php fix bin src tests",
"fix:php:sniffer": "@php ./.phive/phpcbf.phar --standard=config/phpcs.xml bin src tests",
"phpstan:baseline": "phpstan --configuration=config/phpstan.neon --generate-baseline=config/phpstan-baseline.neon"
},
"scripts-descriptions": {
"ci": "Runs all dynamic and static code checks (i.e. currently, only the static checks).",
"ci:php:fixer": "Checks the code style with PHP CS Fixer.",
"ci:php:sniffer": "Checks the code style with PHP_CodeSniffer.",
"ci:php:stan": "Checks the types with PHPStan.",
"ci:static": "Runs all static code analysis checks for the code.",
"fix:php": "Autofixes all autofixable issues in the PHP code.",
"fix:php:fixer": "Fixes autofixable issues found by PHP CS Fixer.",
"fix:php:sniffer": "Fixes autofixable issues found by PHP_CodeSniffer.",
"phpstand:baseline": "Updates the PHPStan baseline file to match the code."
}
}
17 changes: 0 additions & 17 deletions config/phpcs.xml

This file was deleted.

0 comments on commit 8bb6080

Please sign in to comment.