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.

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

Update PHPCS default rule set #161

Merged
merged 10 commits into from Jul 29, 2018
Merged

Update PHPCS default rule set #161

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1e581ba
change to .phpcs.xml.dist and update rules
Jul 20, 2018
e4a3d1b
add comments for blank values
Jul 20, 2018
b64faae
updates per pr feedback
Jul 20, 2018
d1047f2
update based on more PR feedback
Jul 20, 2018
c449067
add placeholder for prefix and textdomain rules
Jul 20, 2018
4160c12
add comments and update rule ref
Jul 20, 2018
d0ac996
remove leading .
Jul 20, 2018
2f23c5c
update tests and distignore for .phpcs.xml.dist
Jul 20, 2018
c22db9a
update to handle additional phpcs rule files
Jul 20, 2018
64920e5
update test for verifying the ruleset contents
Jul 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Expand Up @@ -218,7 +218,7 @@ The following files are also included unless the `--skip-tests` is used:
* `bin/install-wp-tests.sh` configures the WordPress test suite and a test database.
* `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite.
* `tests/test-sample.php` is a sample file containing test cases.
* `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
* `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.

**OPTIONS**

Expand Down Expand Up @@ -288,7 +288,7 @@ The following files are generated by default:
* `bin/install-wp-tests.sh` configures the WordPress test suite and a test database.
* `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite.
* `tests/test-sample.php` is a sample file containing the actual tests.
* `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
* `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.

Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).

Expand Down Expand Up @@ -426,7 +426,7 @@ The following files are generated by default:
* `bin/install-wp-tests.sh` configures the WordPress test suite and a test database.
* `tests/bootstrap.php` is the file that makes the current theme active when running the test suite.
* `tests/test-sample.php` is a sample file containing the actual tests.
* `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
* `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.

Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).

Expand Down
2 changes: 1 addition & 1 deletion features/scaffold-plugin-tests.feature
View file
Open in desktop
Expand Up @@ -39,7 +39,7 @@ Feature: Scaffold plugin unit tests
"""
<exclude>./tests/test-sample.php</exclude>
"""
And the {PLUGIN_DIR}/hello-world/phpcs.xml.dist file should exist
And the {PLUGIN_DIR}/hello-world/.phpcs.xml.dist file should exist
And the {PLUGIN_DIR}/hello-world/circle.yml file should not exist
And the {PLUGIN_DIR}/hello-world/.circleci directory should not exist
And the {PLUGIN_DIR}/hello-world/bitbucket-pipelines.yml file should not exist
Expand Down
2 changes: 1 addition & 1 deletion features/scaffold-theme-tests.feature
View file
Open in desktop
Expand Up @@ -37,7 +37,7 @@ Feature: Scaffold theme unit tests
"""
<exclude>./tests/test-sample.php</exclude>
"""
And the {THEME_DIR}/p2child/phpcs.xml.dist file should exist
And the {THEME_DIR}/p2child/.phpcs.xml.dist file should exist
And the {THEME_DIR}/p2child/circle.yml file should not exist
And the {THEME_DIR}/p2child/.circleci directory should not exist
And the {THEME_DIR}/p2child/bitbucket-pipelines.yml file should not exist
Expand Down
2 changes: 1 addition & 1 deletion features/scaffold.feature
View file
Open in desktop
Expand Up @@ -224,7 +224,7 @@ Feature: WordPress code scaffolding
.git
.gitignore
"""
And the {PLUGIN_DIR}/hello-world/phpcs.xml.dist file should contain:
And the {PLUGIN_DIR}/hello-world/.phpcs.xml.dist file should contain:
"""
<rule ref="PHPCompatibility"/>
<config name="testVersion" value="5.3-"/>
Expand Down
8 changes: 4 additions & 4 deletions src/Scaffold_Command.php
View file
Open in desktop
Expand Up @@ -575,7 +575,7 @@ private function get_output_path( $assoc_args, $subdir ) {
* * `bin/install-wp-tests.sh` configures the WordPress test suite and a test database.
* * `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite.
* * `tests/test-sample.php` is a sample file containing test cases.
* * `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
* * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
*
* ## OPTIONS
*
Expand Down Expand Up @@ -706,7 +706,7 @@ function plugin( $args, $assoc_args ) {
* * `bin/install-wp-tests.sh` configures the WordPress test suite and a test database.
* * `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite.
* * `tests/test-sample.php` is a sample file containing the actual tests.
* * `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
* * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
*
* Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).
*
Expand Down Expand Up @@ -759,7 +759,7 @@ public function plugin_tests( $args, $assoc_args ) {
* * `bin/install-wp-tests.sh` configures the WordPress test suite and a test database.
* * `tests/bootstrap.php` is the file that makes the current theme active when running the test suite.
* * `tests/test-sample.php` is a sample file containing the actual tests.
* * `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
* * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
*
* Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).
*
Expand Down Expand Up @@ -889,7 +889,7 @@ private function scaffold_plugin_theme_tests( $args, $assoc_args, $type ) {
$to_copy = array(
'install-wp-tests.sh' => $bin_dir,
'phpunit.xml.dist' => $target_dir,
'phpcs.xml.dist' => $target_dir,
'.phpcs.xml.dist' => $target_dir,
);

foreach ( $to_copy as $file => $dir ) {
Expand Down
48 changes: 48 additions & 0 deletions templates/.phpcs.xml.dist
View file
Open in desktop
@@ -0,0 +1,48 @@
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards based custom ruleset for your plugin">
<description>Generally-applicable sniffs for WordPress plugins.</description>

<!-- What to scan -->
<file>.</file>
<exclude-pattern>/vendor/</exclude-pattern>

<!-- How to scan -->
<!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
<!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
<arg value="sp"/> <!-- Show sniff and progress -->
<arg name="basepath" value="./"/><!-- Strip the file paths down to the relevant bit -->
<arg name="colors"/>
<arg name="extensions" value="php"/>
<arg name="parallel" value="8"/><!-- Enables parallel processing when available for faster results. -->

<!-- Rules: Check PHP version compatibility -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Indentation is off here. Tabs vs spaces.

Copy link
Contributor

Choose a reason for hiding this comment

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

As per the earlier comments, using PHPCompatibilityWP will be the better choice.

I'd also recommend adding a link to the PHPCompatibilityWP repo as a comment, again to help people to more easily find out more info: https://github.com/PHPCompatibility/PHPCompatibilityWP

Maybe also add a link for more info about what the testVersion means and how it works: https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions

You may also want to add a comment saying that people can change the testVersion to suit their project.

<!-- https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
<config name="testVersion" value="5.3-"/>
<!-- https://github.com/PHPCompatibility/PHPCompatibilityWP -->
<rule ref="PHPCompatibilityWP"/>

<!-- Rules: WordPress Coding Standards -->
<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties -->
<config name="minimum_supported_wp_version" value="4.6"/>
<rule ref="WordPress">
<exclude name="WordPress.VIP"/>
</rule>
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<!-- Value: replace the function, class, and variable prefixes used. Separate multiple prefixes with a comma. -->
<property name="prefixes" type="array" value="my-plugin"/>
</properties>
</rule>
<rule ref="WordPress.WP.I18n">
<properties>
<!-- Value: replace the text domain used. -->
<property name="text_domain" type="array" value="my-plugin"/>
</properties>
</rule>
<rule ref="WordPress.WhiteSpace.ControlStructureSpacing">
<properties>
<property name="blank_line_check" value="true"/>
</properties>
</rule>
</ruleset>
20 changes: 0 additions & 20 deletions templates/phpcs.xml.dist
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion templates/plugin-distignore.mustache
View file
Open in desktop
Expand Up @@ -21,7 +21,7 @@ phpunit.xml.dist
multisite.xml
multisite.xml.dist
phpcs.xml
Copy link
Contributor

Choose a reason for hiding this comment

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

You may also want to add .phpcs.xml here and possibly to the .gitignore file too ?

Copy link
Author

Choose a reason for hiding this comment

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

@jrfnl thanks! I added .phpcs.xml but .gitignore is already in the file higher up.

phpcs.xml.dist
.phpcs.xml.dist
README.md
wp-cli.local.yml
yarn.lock
Expand Down