From af9090900b6216d30c984a832d88338d9a533ca7 Mon Sep 17 00:00:00 2001 From: jrfnl Date: Mon, 12 Feb 2024 14:52:13 +0100 Subject: [PATCH] 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: * 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) --- _posts/02-01-01-Code-Style-Guide.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_posts/02-01-01-Code-Style-Guide.md b/_posts/02-01-01-Code-Style-Guide.md index 06f7c8f..b890309 100644 --- a/_posts/02-01-01-Code-Style-Guide.md +++ b/_posts/02-01-01-Code-Style-Guide.md @@ -39,8 +39,8 @@ And you can run phpcs manually from shell: phpcs -sw --standard=PSR1 file.php It will show errors and describe how to fix them. -It can also be helpful to include this command in a git hook. -That way, branches which contain violations against the chosen standard cannot enter the repository until those +It can also be helpful to include the `phpcs` command in a git pre-commit hook with the `--filter=GitStaged` CLI argument. +That way, code which contain violations against the chosen standard cannot enter the repository until those violations have been fixed. 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/ [pear-cs]: https://pear.php.net/manual/en/standards.php [symfony-cs]: https://symfony.com/doc/current/contributing/code/standards.html -[phpcs]: https://github.com/squizlabs/PHP_CodeSniffer -[phpcbf]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically +[phpcs]: https://github.com/PHPCSStandards/PHP_CodeSniffer +[phpcbf]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically [st-cs]: https://github.com/benmatselby/sublime-phpcs [phpcsfixer]: https://cs.symfony.com/ [cleancode]: https://github.com/jupeter/clean-code-php