Merge pull request #186 from pattonwebz/feature/add-custom-ruleset-wp_cli_cs

Author: schlessera

.distignore

@@ -6,6 +6,8 @@
 .travis.yml
 behat.yml
 circle.yml
+phpcs.xml.dist
+phpunit.xml.dist
 bin/
 features/
 utils/

.gitignore

@@ -8,3 +8,6 @@ vendor/
 *.txt
 *.log
 composer.lock
+phpunit.xml
+phpcs.xml
+.phpcs.xml

bin/install-package-tests.sh

@@ -28,14 +28,13 @@ jobs:
     - run: |
         dockerize -wait tcp://127.0.0.1:3306 -timeout 1m
     - run: |
-        composer require wp-cli/wp-cli:dev-master
+        composer validate
         composer install
         composer prepare-tests
     - run: |
         echo 'export PATH=$HOME/wp-cli/package-tests/vendor/bin:$PATH' >> $BASH_ENV
         source $BASH_ENV
     - run: |
-        composer validate
         WP_VERSION=latest composer test
         rm -rf '/tmp/wp-cli-test core-download-cache'
         WP_VERSION=trunk composer test

bin/test.sh

@@ -230,6 +230,7 @@ Feature: Scaffold a README.md file for an existing package
       *This README.md is generated dynamically from the project's codebase
       """
 
+  @broken
   Scenario: Error when commands are specified but not present
     Given an empty directory
     And a foo/composer.json file:

circle.yml

@@ -56,9 +56,6 @@ Feature: Scaffold the test suite for an existing package
     When I run `wp scaffold package-tests community-command`
     Then STDOUT should not be empty
     And the community-command/.travis.yml file should exist
-      """
-      require-wp
-      """
     And the community-command/features directory should contain:
       """
       load-wp-cli.feature
@@ -124,9 +121,10 @@ Feature: Scaffold the test suite for an existing package
       """
           - MY_APPEND_ENV="my-append-env"
       """
-    And a community-command/travis-matrix-append.yml file:
+    And a community-command/travis-jobs-append.yml file:
       """
-          - php: 99.97
+          - stage: test
+            php: 99.97
             env: WP_VERSION=9997.9997
       """
     And a community-command/travis-before_install-append.yml file:
@@ -138,10 +136,6 @@ Feature: Scaffold the test suite for an existing package
       """
         - bash bin/my-append-install.sh
       """
-    And a community-command/travis-before_script-append.yml file:
-      """
-        - bash bin/my-append-before_script.sh
-      """
     And a community-command/travis-script-append.yml file:
       """
         - bash bin/my-append-script.sh
@@ -176,15 +170,16 @@ Feature: Scaffold the test suite for an existing package
       """
           - MY_APPEND_ENV="my-append-env"
 
-      matrix:
+      before_install:
       """
     And the community-command/.travis.yml file should contain:
       """
-          - php: 7.2
+            php: 7.4
       """
     And the community-command/.travis.yml file should contain:
       """
-          - php: 99.97
+          - stage: test
+            php: 99.97
             env: WP_VERSION=9997.9997
 
       before_install:
@@ -202,27 +197,21 @@ Feature: Scaffold the test suite for an existing package
       """
     And the community-command/.travis.yml file should contain:
       """
-        - bash bin/install-package-tests.sh
+        - composer prepare-tests
       """
     And the community-command/.travis.yml file should contain:
       """
         - bash bin/my-append-install.sh
 
-      before_script:
+      script:
       """
     And the community-command/.travis.yml file should contain:
       """
         - composer validate
       """
     And the community-command/.travis.yml file should contain:
       """
-        - bash bin/my-append-before_script.sh
-
-      script:
-      """
-    And the community-command/.travis.yml file should contain:
-      """
-        - bash bin/test.sh
+        - composer behat || composer behat-rerun
         - bash bin/my-append-script.sh
       """
     And the community-command/.travis.yml file should contain:

features/scaffold-package-readme.feature

@@ -37,7 +37,7 @@ Feature: Scaffold WP-CLI commands
               "wp-cli/wp-cli": "^2.5"
           },
       """
-    And the {PACKAGE_PATH}/local/wp-cli/foo/command.php file should exist
+    And the {PACKAGE_PATH}/local/wp-cli/foo/hello-world-command.php file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/CONTRIBUTING.md file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/CONTRIBUTING.md file should contain:
       """
@@ -48,17 +48,24 @@ Feature: Scaffold WP-CLI commands
     And the {PACKAGE_PATH}/local/wp-cli/foo/.github/PULL_REQUEST_TEMPLATE file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/.github/ISSUE_TEMPLATE file should exist
 
-    When I run `wp --require={PACKAGE_PATH}/local/wp-cli/foo/command.php hello-world`
+    When I run `wp hello-world`
+    Then STDOUT should be:
+      """
+      Success: Hello World!
+      """
+
+    When I run `composer -q -n --working-dir={PACKAGE_PATH}/local/wp-cli/foo/ install`
+    And I run `wp --require={PACKAGE_PATH}/local/wp-cli/foo/hello-world-command.php hello-world`
     Then STDOUT should be:
       """
-      Success: Hello world.
+      Success: Hello World!
       """
 
     When I run `cat {PACKAGE_PATH}/local/wp-cli/foo/wp-cli.yml`
     Then STDOUT should contain:
       """
       require:
-        - command.php
+        - hello-world-command.php
       """
 
     When I run `cat {PACKAGE_PATH}/local/wp-cli/foo/.gitignore`
@@ -91,7 +98,7 @@ Feature: Scaffold WP-CLI commands
     When I run `wp hello-world`
     Then STDOUT should be:
       """
-      Success: Hello world.
+      Success: Hello World!
       """
 
     When I run `wp package uninstall wp-cli/without-require`
@@ -121,14 +128,15 @@ Feature: Scaffold WP-CLI commands
     And the custom-directory/.gitignore file should exist
     And the custom-directory/.editorconfig file should exist
     And the custom-directory/composer.json file should exist
-    And the custom-directory/command.php file should exist
+    And the custom-directory/hello-world-command.php file should exist
     And the custom-directory/wp-cli.yml file should exist
     And the custom-directory/.travis.yml file should not exist
 
-    When I run `wp --require=custom-directory/command.php hello-world`
+    When I run `composer -q -n --working-dir=custom-directory/ install`
+    And I run `wp --require=custom-directory/hello-world-command.php hello-world`
     Then STDOUT should be:
       """
-      Success: Hello world.
+      Success: Hello World!
       """
     When I run `wp package uninstall wp-cli/custom-directory`
     Then STDOUT should contain:
@@ -148,6 +156,7 @@ Feature: Scaffold WP-CLI commands
       s
       s
       s
+      s
       """
 
     When I run `wp scaffold package wp-cli/same-package --skip-tests --skip-github`
@@ -187,14 +196,15 @@ Feature: Scaffold WP-CLI commands
     And the {PACKAGE_PATH}/local/wp-cli/with-tests/.gitignore file should exist
     And the {PACKAGE_PATH}/local/wp-cli/with-tests/.editorconfig file should exist
     And the {PACKAGE_PATH}/local/wp-cli/with-tests/composer.json file should exist
-    And the {PACKAGE_PATH}/local/wp-cli/with-tests/command.php file should exist
+    And the {PACKAGE_PATH}/local/wp-cli/with-tests/hello-world-command.php file should exist
     And the {PACKAGE_PATH}/local/wp-cli/with-tests/wp-cli.yml file should exist
     And the {PACKAGE_PATH}/local/wp-cli/with-tests/.travis.yml file should exist
 
-    When I run `wp --require={PACKAGE_PATH}/local/wp-cli/with-tests/command.php hello-world`
+    When I run `composer -q -n --working-dir={PACKAGE_PATH}/local/wp-cli/with-tests/ install`
+    And I run `wp --require={PACKAGE_PATH}/local/wp-cli/with-tests/hello-world-command.php hello-world`
     Then STDOUT should be:
       """
-      Success: Hello world.
+      Success: Hello World!
       """
     When I run `wp package uninstall wp-cli/with-tests`
     Then STDOUT should contain:

features/scaffold-package-tests.feature

@@ -0,0 +1,54 @@
+<?xml version="1.0"?>
+<ruleset name="WP-CLI-scaffold-package">
+	<description>Custom ruleset for WP-CLI scaffold-package-command</description>
+
+	<!--
+	#############################################################################
+	COMMAND LINE ARGUMENTS
+	For help understanding this file: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
+	For help using PHPCS: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage
+	#############################################################################
+	-->
+
+	<!-- What to scan. -->
+	<file>.</file>
+
+	<!-- Show progress. -->
+	<arg value="p"/>
+
+	<!-- Strip the filepaths down to the relevant bit. -->
+	<arg name="basepath" value="./"/>
+
+	<!-- Check up to 8 files simultaneously. -->
+	<arg name="parallel" value="8"/>
+
+	<!--
+	#############################################################################
+	USE THE WP_CLI_CS RULESET
+	#############################################################################
+	-->
+
+	<rule ref="WP_CLI_CS"/>-
+
+	<!--
+	#############################################################################
+	PROJECT SPECIFIC CONFIGURATION FOR SNIFFS
+	#############################################################################
+	-->
+
+	<!-- For help understanding the `testVersion` configuration setting:
+		 https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
+	<config name="testVersion" value="5.6-"/>
+
+	<!-- Verify that everything in the global namespace is either namespaced or prefixed.
+		 See: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#naming-conventions-prefix-everything-in-the-global-namespace -->
+	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
+		<properties>
+			<property name="prefixes" type="array">
+				<element value="WP_CLI"/><!-- Namespaces. -->
+				<element value="wpcli_scaffold_package"/><!-- Global variables and such. -->
+			</property>
+		</properties>
+	</rule>
+
+</ruleset>

features/scaffold-package.feature

@@ -6,9 +6,9 @@
 	return;
 }
 
-$autoload = dirname( __FILE__ ) . '/vendor/autoload.php';
-if ( file_exists( $autoload ) ) {
-	require_once $autoload;
+$wpcli_scaffold_package_autoload = dirname( __FILE__ ) . '/vendor/autoload.php';
+if ( file_exists( $wpcli_scaffold_package_autoload ) ) {
+	require_once $wpcli_scaffold_package_autoload;
 }
 
 WP_CLI::add_command( 'scaffold package', [ ScaffoldPackageCommand::class, 'package' ] );