info/php-the-right-way
1
0
Fork 0
mirror of https://github.com/codeguy/php-the-right-way.git synced 2025-08-08 06:56:33 +02:00
Code Issues Projects Releases Wiki Activity

Code Style Guide: update URL for PHP_CodeSniffer

Browse Source 
... and small improvement to the text about running PHPCS in a git hook.

_When this text was originally written, the `--filter=GitStaged` option didn't exist yet, but now it does, it seems like a good pointer to add to the text._

Ref:
* https://github.com/squizlabs/PHP_CodeSniffer/issues/3932 (about the repo URL change)
* https://github.com/squizlabs/PHP_CodeSniffer/pull/2137 (about the GitStaged filter)
This commit is contained in:
jrfnl
2024-02-12 14:52:13 +01:00
parent 71ce0addba
commit af9090900b
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
_posts/02-01-01-Code-Style-Guide.md
View File

@@ -39,8 +39,8 @@ And you can run phpcs manually from shell:
phpcs -sw --standard=PSR1 file.php phpcs -sw --standard=PSR1 file.php
It will show errors and describe how to fix them. It will show errors and describe how to fix them.
It can also be helpful to include this command in a git hook. It can also be helpful to include the `phpcs` command in a git pre-commit hook with the `--filter=GitStaged` CLI argument.
That way, branches which contain violations against the chosen standard cannot enter the repository until those That way, code which contain violations against the chosen standard cannot enter the repository until those
violations have been fixed. violations have been fixed.
If you have PHP_CodeSniffer, then you can fix the code layout problems reported by it, automatically, with the If you have PHP_CodeSniffer, then you can fix the code layout problems reported by it, automatically, with the
@@ -65,8 +65,8 @@ Finally, a good supplementary resource for writing clean PHP code is [Clean Code
[per-cs]: https://www.php-fig.org/per/coding-style/ [per-cs]: https://www.php-fig.org/per/coding-style/
[pear-cs]: https://pear.php.net/manual/en/standards.php [pear-cs]: https://pear.php.net/manual/en/standards.php
[symfony-cs]: https://symfony.com/doc/current/contributing/code/standards.html [symfony-cs]: https://symfony.com/doc/current/contributing/code/standards.html
[phpcs]: https://github.com/squizlabs/PHP_CodeSniffer [phpcs]: https://github.com/PHPCSStandards/PHP_CodeSniffer
[phpcbf]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically [phpcbf]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically
[st-cs]: https://github.com/benmatselby/sublime-phpcs [st-cs]: https://github.com/benmatselby/sublime-phpcs
[phpcsfixer]: https://cs.symfony.com/ [phpcsfixer]: https://cs.symfony.com/
[cleancode]: https://github.com/jupeter/clean-code-php [cleancode]: https://github.com/jupeter/clean-code-php