Merge pull request #19 from xwp/update/phpcs

Use phpcs.xml.dist instead of custom-named phpcs.ruleset.xml

Author: schlessera

README.md

@@ -152,7 +152,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.ruleset.xml` is a collenction of PHP_CodeSniffer rules.
+* `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 
 **OPTIONS**
 
@@ -222,7 +222,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.ruleset.xml` is a collenction of PHP_CodeSniffer rules.
+* `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 
 Learn more from the [plugin unit tests documentation](http://wp-cli.org/docs/plugin-unit-tests/).
 
@@ -360,7 +360,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.ruleset.xml` is a collenction of PHP_CodeSniffer rules.
+* `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 
 Learn more from the [plugin unit tests documentation](http://wp-cli.org/docs/plugin-unit-tests/).
 

features/scaffold-plugin-tests.feature

@@ -36,7 +36,7 @@ Feature: Scaffold plugin unit tests
       install-wp-tests.sh
       """
     And the {PLUGIN_DIR}/hello-world/phpunit.xml.dist file should exist
-    And the {PLUGIN_DIR}/hello-world/phpcs.ruleset.xml 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/.gitlab-ci.yml file should not exist
     And the {PLUGIN_DIR}/hello-world/.travis.yml file should contain:
@@ -49,7 +49,7 @@ Feature: Scaffold plugin unit tests
           fi
         - |
           if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
-            phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
+            phpcs
           fi
       """
     And the {PLUGIN_DIR}/hello-world/.travis.yml file should contain:

features/scaffold-theme-tests.feature

@@ -33,7 +33,7 @@ Feature: Scaffold theme unit tests
       install-wp-tests.sh
       """
     And the {THEME_DIR}/p2child/phpunit.xml.dist file should exist
-    And the {THEME_DIR}/p2child/phpcs.ruleset.xml 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/.gitlab-ci.yml file should not exist
     And the {THEME_DIR}/p2child/.travis.yml file should contain:
@@ -46,7 +46,7 @@ Feature: Scaffold theme unit tests
           fi
         - |
           if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
-            phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
+            phpcs
           fi
       """
     And the {THEME_DIR}/p2child/.travis.yml file should contain:

src/Scaffold_Command.php

@@ -453,7 +453,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.ruleset.xml` is a collenction of PHP_CodeSniffer rules.
+	 * * `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 	 *
 	 * ## OPTIONS
 	 *
@@ -584,7 +584,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.ruleset.xml` is a collenction of PHP_CodeSniffer rules.
+	 * * `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 	 *
 	 * Learn more from the [plugin unit tests documentation](http://wp-cli.org/docs/plugin-unit-tests/).
 	 *
@@ -636,7 +636,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.ruleset.xml` is a collenction of PHP_CodeSniffer rules.
+	 * * `phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 	 *
 	 * Learn more from the [plugin unit tests documentation](http://wp-cli.org/docs/plugin-unit-tests/).
 	 *
@@ -762,7 +762,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.ruleset.xml'   => $target_dir,
+			'phpcs.xml.dist'   => $target_dir,
 		);
 
 		foreach ( $to_copy as $file => $dir ) {

templates/phpcs.ruleset.xml renamed to templates/phpcs.xml.dist

@@ -5,6 +5,13 @@
 	<rule ref="WordPress-Core" />
 	<rule ref="WordPress-Docs" />
 
+	<!-- Check all PHP files in directory tree by default. -->
+	<arg name="extensions" value="php"/>
+	<file>.</file>
+
+	<!-- Show sniff codes in all reports -->
+	<arg value="s"/>
+
 	<exclude-pattern>*/node_modules/*</exclude-pattern>
 	<exclude-pattern>*/vendor/*</exclude-pattern>
 </ruleset>

templates/plugin-circle.mustache

@@ -17,7 +17,7 @@ test:
       composer global require wp-coding-standards/wpcs
       phpcs --config-set installed_paths $HOME/.composer/vendor/wp-coding-standards/wpcs
   override:
-    - phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
+    - phpcs
     {{#wp_versions_to_test}}
     - |
       rm -rf $WP_TESTS_DIR $WP_CORE_DIR

templates/plugin-distignore.mustache

@@ -18,7 +18,8 @@ phpunit.xml
 phpunit.xml.dist
 multisite.xml
 multisite.xml.dist
-phpcs.ruleset.xml
+phpcs.xml
+phpcs.xml.dist
 README.md
 wp-cli.local.yml
 tests

templates/plugin-gitlab.mustache

@@ -29,13 +29,13 @@ PHPunit:PHP5.3:MySQL:
   services:
     - mysql:5.6
   script:
-  - phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
-  - phpunit --configuration phpunit.xml.dist
+  - phpcs
+  - phpunit
 
 PHPunit:PHP5.6:MySQL:
   image: tetraweb/php:5.6
   services:
     - mysql:5.6
   script:
-  - phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
-  - phpunit --configuration phpunit.xml.dist
+  - phpcs
+  - phpunit

templates/plugin-travis.mustache

@@ -56,5 +56,5 @@ script:
     fi
   - |
     if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
-      phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
+      phpcs
     fi