Simplify and document running phpcs locally
#986
Conversation
bin/run-phpcs.sh
Outdated
| -not \( -path './node_modules' \) \ | ||
| -not \( -path './vendor' \) \ | ||
| -name '*.php' \ | ||
| | xargs -d'\n' phpcs --standard=phpcs.ruleset.xml -s |
There was a problem hiding this comment.
FYI: If phpcs.ruleset.xml is renamed to phpcs.xml.dist or phpcs.xml then you don't have to supply --standard at all. I suggest that this could eliminate the need for bin/run-phpcs.sh entirely. See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards#using-a-custom-ruleset
Additionally, the ruleset file can be configured to exclude the node_modules and vendor directories, eliminating the need for using find and xargs.
There was a problem hiding this comment.
The ruleset just needs to include these lines:
<exclude-pattern>*/node_modules/*</exclude-pattern>
<exclude-pattern>*/vendor/*</exclude-pattern>There was a problem hiding this comment.
Nice! I'll try this out, and then move the setup documentation to a better place.
One more question: is it possible to enable the -s option via the config as well? I find it much easier to parse the output this way.
There was a problem hiding this comment.
It turns out we need to whitelist directories and files using the <file> tag instead.
With the suggested exclude entries in place, running phpcs -s . is extremely, extremely slow (2 minutes and counting before I killed it). strace reveals that phpcs still recurses into all directories, ignoring the exclude entries. This is a known issue, fixed in the 3.x releases, which we can't use yet: squizlabs/PHP_CodeSniffer#1113
is it possible to enable the
-soption via the config as well
From looking through the code, the answer to this is no.
There was a problem hiding this comment.
From looking at https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml I just found that you can indeed do this! See 7f0fff5.
Now all you need to do to run PHPCS is just do phpcs without any args at all.
nylen
changed the title
phpcs locallyphpcs locally
docs/coding-guidelines.md
Outdated
|
|
||
| https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards#standalone | ||
|
|
||
| You should now be able to run `phpcs -s` from the root directory of this |
There was a problem hiding this comment.
We can now remove -s from the instructions since it is defined as a default arg in phpcs.xml
.travis.yml
Outdated
| -not \( -path './vendor' \) \ | ||
| -name '*.php' \ | ||
| | xargs -d'\n' phpcs --standard=phpcs.ruleset.xml -s | ||
| phpcs -s |
There was a problem hiding this comment.
Per below, the -s can now be removed since it is the default.
| not yet compatible with the WordPress coding standards. For more information see | ||
| [this issue](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/718). | ||
|
|
||
| The easiest way to get `phpcs` is to download the .phar archive from the latest |
There was a problem hiding this comment.
I wonder if it would be easier to make phpcs 2.9.x a Composer dependency instead? If we add a composer.json which has wp-coding-standards/wpcs among its dev-requirements then all a contributor (and Travis CI alike) would need to do is composer install and then do ./vendor/bin/phpcs.
There was a problem hiding this comment.
I tried this out, and am getting the following error:
PHP Fatal error: Uncaught exception 'PHP_CodeSniffer_Exception' with message 'Referenced sniff "WordPress-Core" does not exist'
Is it expected that we need to call vendor/bin/phpcs --config-set?
- Name the phpcs ruleset with a default filename - Whitelist PHP files to include in the checks
|
I'll merge this and explore using |
This PR makes it easier to run
phpcslocally.To test
phpcsstep, still passes.phpcsfollowing the instructions in the comments ofbin/run-phpcs.sh. Run the script and verify that it works (no output, exit code0).