Skip to content

Commit af90909

Browse files
committed
Code Style Guide: update URL for PHP_CodeSniffer
... 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: * squizlabs/PHP_CodeSniffer#3932 (about the repo URL change) * squizlabs/PHP_CodeSniffer#2137 (about the GitStaged filter)
1 parent 71ce0ad commit af90909

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

_posts/02-01-01-Code-Style-Guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ And you can run phpcs manually from shell:
3939
phpcs -sw --standard=PSR1 file.php
4040

4141
It will show errors and describe how to fix them.
42-
It can also be helpful to include this command in a git hook.
43-
That way, branches which contain violations against the chosen standard cannot enter the repository until those
42+
It can also be helpful to include the `phpcs` command in a git pre-commit hook with the `--filter=GitStaged` CLI argument.
43+
That way, code which contain violations against the chosen standard cannot enter the repository until those
4444
violations have been fixed.
4545

4646
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
6565
[per-cs]: https://www.php-fig.org/per/coding-style/
6666
[pear-cs]: https://pear.php.net/manual/en/standards.php
6767
[symfony-cs]: https://symfony.com/doc/current/contributing/code/standards.html
68-
[phpcs]: https://github.com/squizlabs/PHP_CodeSniffer
69-
[phpcbf]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically
68+
[phpcs]: https://github.com/PHPCSStandards/PHP_CodeSniffer
69+
[phpcbf]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically
7070
[st-cs]: https://github.com/benmatselby/sublime-phpcs
7171
[phpcsfixer]: https://cs.symfony.com/
7272
[cleancode]: https://github.com/jupeter/clean-code-php

0 commit comments

Comments
 (0)