Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.There are some discrepencies between the results when you run:
phpcs -n --standard=Drupal --extensions=php,module,install,test,profile,theme [foldername]
and when just running the code sniffer pre-commit hook with:
drush coder-review --git
To get around this, I've added the --sniffer option for my pre-commit hook (to run the PHP CodeSniffer review):
drush coder-review --sniffer --git
The problem is that PHP CodeSniffer checks ALL files, even those with irrelevant extensions, when you aren't checking a folder. This means I was getting pre-commit errors on things like gifs and pngs and couldn't commit!
I created a patch to check for these extensions in the pre-commit, which I will attach in the next comment, in case anyone else would find it useful.
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | coder-check_extensions_before_precommit-1930744-4.patch | 2.24 KB | mariacha1 |
| #1 | coder-check_extensions_before_precommit-1930744-2.patch | 2.47 KB | mariacha1 |
Comments
Comment #1
mariacha1 CreditAttribution: mariacha1 commentedHere is the patch.
Comment #2
douggreen CreditAttribution: douggreen commentedDid you test why CoderReviewCodeSnifferClient didn't handle the allowed extensions? That seems to be where I tried to handle it.
Comment #3
mariacha1 CreditAttribution: mariacha1 commentedI might be misunderstanding what CoderReviewCodeSnifferClient does, but as far as I can tell it looks like it just turns the command line into the phpcs object. Once it's finished, it essentially passes this:
phpcs -n --standard=Drupal --extensions=php,inc,module,install,test,profile,theme path/to/my/image.pngThe problem is that php-codesniffer only checks extensions if it is passed a folder. See:
http://pear.php.net/manual/en/package.php.php-codesniffer.usage.php
"<extensions> A comma separated list of file extensions to check (only valid if checking a directory)"
Since I'm not checking a folder but a file, the extensions are ignored. The only way I can see to keep these files from being checked is to never send them to phpcs to begin with.
There might be better solutions, of course.
Comment #4
mariacha1 CreditAttribution: mariacha1 commentedI just discovered that my previous patch didn't work, and was, in fact, keeping the sniffer from running at all! So, here's an updated patch that seems to be working -- the results are matching up with what I see when running phpcs, but the sniffer isn't checking files that it shouldn't (like pngs).
Comment #5
klausiComment #6
klausiCoder 7.x is frozen now and will not receive updates. Coder 8.x-2.x can be used to check code for any Drupal version, Coder 8.x-2.x also supports the phpcbf command to automatically fix conding standard errors. Please check if this issue is still relevant and reopen against that version if necessary.