From 33daa0b1ea6d41d7cfbe96666c9e6d16c0d8b539 Mon Sep 17 00:00:00 2001 From: Pierre Rudloff Date: Sun, 24 Dec 2017 00:01:10 +0100 Subject: [PATCH 1/2] Custom PHPCS ruleset --- ruleset.xml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 ruleset.xml diff --git a/ruleset.xml b/ruleset.xml new file mode 100644 index 000000000..c5f439e58 --- /dev/null +++ b/ruleset.xml @@ -0,0 +1,6 @@ + + + + + + From c7544e41c0d38f65925eb52de326ce1b89c915fd Mon Sep 17 00:00:00 2001 From: Pierre Rudloff Date: Sun, 24 Dec 2017 00:40:40 +0100 Subject: [PATCH 2/2] Update doc to show how to use new ruleset --- doc/Developers-Intro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index f40186f1d..699c6fe23 100644 --- a/doc/Developers-Intro.md +++ b/doc/Developers-Intro.md @@ -79,7 +79,7 @@ This tool checks your files against a variety of coding standards, including PSR You can simply install it through PEAR: `pear install PHP_CodeSniffer` Once it is installed and available in your PATH, here's the command to run before committing your work: - $> phpcs --standard=PSR2 + $> phpcs --standard=ruleset.xml The output is a list of all the coding standards violations that you should fix before committing your work. Additionally, `phpcs` integrates with a few IDEs (Eclipse, Netbeans, PHPStorm...) so that you don't have to fiddle with the command line. @@ -90,7 +90,7 @@ If you're getting a massive list of standards violations when running `phpcs`, i Thankfully, PHP Code Sniffer is shipped with an automatic code fixer that can take care of the tedious task for you. Here's the command to automatically fix the files you created/modified: - $> phpcbf --standard=PSR2 + $> phpcbf --standard=ruleset.xml If the command-line tools `diff` and `patch` are unavailabe for you, `phpcbf` can use slightly slower PHP equivalents by using the `--no-patch` argument.