Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add PHPCompatibility sniffs to scaffolded #154

Merged
merged 3 commits into from
Jun 3, 2018
Merged

Add PHPCompatibility sniffs to scaffolded #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82fc347
Add test case to fail
yousan Jun 3, 2018
de660c8
add PHP CS 5.3 upwards
yousan Jun 3, 2018
eaf6f9e
Fixed indent
yousan Jun 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions features/scaffold.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@ Feature: WordPress code scaffolding
.git
.gitignore
"""
And the {PLUGIN_DIR}/hello-world/phpcs.xml.dist file should contain:
"""
<rule ref="PHPCompatibility"/>
<config name="testVersion" value="5.3-"/>
"""
And the {PLUGIN_DIR}/hello-world/hello-world.php file should contain:
"""
* Plugin Name: Hello World
Expand Down
3 changes: 3 additions & 0 deletions templates/phpcs.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
<ruleset name="WordPress Coding Standards for Plugins">
<description>Generally-applicable sniffs for WordPress plugins</description>

<rule ref="PHPCompatibility"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"/>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your reviewing.

Can vendor directory place at template directory?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I see other plugin which uses Composer, and adapt it for scaffolded?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

<config name="testVersion" value="5.3-"/>

<rule ref="WordPress-Core" />
<rule ref="WordPress-Docs" />

Expand Down