Add PHPCompatibility sniffs to scaffolded #154
Conversation
yousan
changed the title
yousan
changed the title
| @@ -2,6 +2,9 @@ | |||
| <ruleset name="WordPress Coding Standards for Plugins"> | |||
| <description>Generally-applicable sniffs for WordPress plugins</description> | |||
|
|
|||
| <rule ref="PHPCompatibility"/> | |||
There was a problem hiding this comment.
Instead of pulling in the general PHPCodeSniffer rule, you should pull in the Framework-specific version for WordPress, which contains some exclusions to avoid false positives. This is needed because WordPress includes a lot of compatibility code and polyfills, so the checks need to take this into account. You can see the current exclusions here: https://github.com/wimg/PHPCompatibility/blob/master/framework-rulesets/wordpress.xml
Here's the adapted rule to use:
<rule ref="./vendor/wimg/php-compatibility/framework-rulesets/wordpress.xml"/>
There was a problem hiding this comment.
Thank you for your reviewing.
Can vendor directory place at template directory?
There was a problem hiding this comment.
No, that would be pulled in via Composer. But now that you're mentioning it, I don't think we're using Composer for the scaffolded plugins...
Let's merge this PR as-is for now and create an issue for evaluating how to use the Framework-specific ruleset in the future.
There was a problem hiding this comment.
Can I see other plugin which uses Composer, and adapt it for scaffolded?
There was a problem hiding this comment.
I don't think adding Composer support directly is a good idea at this point. Most plugin developers will not know what this means.
This needs more thought and exploration first. I've created a corresponding issue for now: #155
|
Thanks for the pull-request, @yousan ! |
Add PHPCompatibility sniffs to scaffolded
Add PHPCompatibility sniffs to scaffolded
fixes #60