Merge branch 'main' into copilot/fix-readme-output-issue

Author: swissspidy

.gitattributes

@@ -0,0 +1,14 @@
+/.actrc export-ignore
+/.distignore export-ignore
+/.editorconfig export-ignore
+/.github export-ignore
+/.gitignore export-ignore
+/.typos.toml export-ignore
+/AGENTS.md export-ignore
+/behat.yml export-ignore
+/features export-ignore
+/phpcs.xml.dist export-ignore
+/phpstan.neon.dist export-ignore
+/phpunit.xml.dist export-ignore
+/tests export-ignore
+/wp-cli.yml export-ignore

.github/workflows/copilot-setup-steps.yml

@@ -17,17 +17,15 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Check existence of composer.json file
         id: check_composer_file
-        uses: andstor/file-existence-action@v3
-        with:
-          files: "composer.json"
+        run: echo "files_exists=$(test -f composer.json && echo true || echo false)" >> "$GITHUB_OUTPUT"
 
       - name: Set up PHP environment
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
         with:
           php-version: 'latest'
           ini-values: zend.assertions=1, error_reporting=-1, display_errors=On
@@ -38,7 +36,7 @@ jobs:
 
       - name: Install Composer dependencies & cache dependencies
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda # v3
         env:
           COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }}
         with:

.github/workflows/issue-triage.yml

@@ -13,6 +13,13 @@ name: Issue and PR Triage
         required: false
         type: string
 
+permissions:
+  issues: write
+  pull-requests: write
+  actions: write
+  contents: read
+  models: read
+
 jobs:
   issue-triage:
     uses: wp-cli/.github/.github/workflows/reusable-issue-triage.yml@main

.github/workflows/regenerate-readme.yml

@@ -10,6 +10,10 @@ on:
       - "features/**"
       - "README.md"
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   regenerate-readme:
     uses: wp-cli/.github/.github/workflows/reusable-regenerate-readme.yml@main

.github/workflows/welcome-new-contributors.yml

@@ -7,6 +7,9 @@ on:
       - main
       - master
 
+permissions:
+  pull-requests: write
+
 jobs:
   welcome:
     uses: wp-cli/.github/.github/workflows/reusable-welcome-new-contributors.yml@main

README.md

@@ -22,7 +22,8 @@ wp scaffold package <name> [--description=<description>] [--homepage=<homepage>]
 Default behavior is to create the following files:
 - command.php
 - composer.json (with package name, description, and license)
-- .gitignore, .editorconfig, and .distignore
+- LICENSE
+- .gitignore, .editorconfig, .distignore, and phpcs.xml.dist
 - README.md (via wp scaffold package-readme)
 - Test harness (via wp scaffold package-tests)
 
@@ -52,7 +53,7 @@ WP-CLI `packages/local/` directory.
 	[--require_wp_cli=<version>]
 		Required WP-CLI version for the package.
 		---
-		default: ^2.12
+		default: ^2.13
 		---
 
 	[--require_wp_cli_tests=<version>]
@@ -193,7 +194,7 @@ WP-CLI Behat framework uses Behat ~2.5, which is installed with Composer.
 Generate a README.md for your command.
 
 ~~~
-wp scaffold package-readme <dir> [--force] [--branch=<branch>]
+wp scaffold package-readme <dir> [--force] [--branch=<branch>] [--license=<license>]
 ~~~
 
 Creates a README.md with Using, Installing, and Contributing instructions
@@ -230,15 +231,15 @@ composer.json includes:
         ],
         "readme": {
             "shields": [
-                "[![Build Status](https://travis-ci.org/runcommand/reset-password.svg?branch=master)](https://travis-ci.org/runcommand/reset-password)"
+                "[![Build Status](https://travis-ci.org/runcommand/reset-password.svg?branch=main)](https://travis-ci.org/runcommand/reset-password)"
             ],
             "sections": [
                 "Using",
                 "Installing",
                 "Support"
             ],
             "support": {
-                "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/master/bin/readme-partials/support-open-source.md"
+                "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/main/bin/readme-partials/support-open-source.md"
             },
             "show_powered_by": false
         }
@@ -257,7 +258,7 @@ For sections, "pre", "body" and "post" are supported. Example:
 ```
 "support": {
   "pre": "highlight.md",
-  "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/master/bin/readme-partials/support-open-source.md",
+  "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/main/bin/readme-partials/support-open-source.md",
   "post": "This is additional text to show after main body content."
 },
 ```
@@ -276,7 +277,13 @@ In this example:
 		Overwrite the readme if it already exists.
 
 	[--branch=<branch>]
-		Name of default branch of the underlying repository. Defaults to master.
+		Name of default branch of the underlying repository. Defaults to main.
+
+	[--license=<license>]
+		License for the package.
+		---
+		default: MIT
+		---
 
 
 
@@ -341,6 +348,10 @@ Want to contribute a new feature? Please first [open a new issue](https://github
 
 Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See "[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)" for details specific to working on this package locally.
 
+### License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
 ## Support
 
 GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support

features/scaffold-package-readme.feature

@@ -40,19 +40,19 @@ Feature: Scaffold a README.md file for an existing package
     And the {PACKAGE_PATH}/local/wp-cli/default-readme/README.md file should exist
     And the {PACKAGE_PATH}/local/wp-cli/default-readme/README.md file should contain:
       """
-      Installing this package requires WP-CLI v2.12 or greater. Update to the latest stable release with `wp cli update`.
+      Installing this package requires WP-CLI v2.13 or greater. Update to the latest stable release with `wp cli update`.
       """
     And the {PACKAGE_PATH}/local/wp-cli/default-readme/README.md file should contain:
       """
-      [![Build Status](https://travis-ci.org/wp-cli/default-readme.svg?branch=master)
+      [![Build Status](https://travis-ci.org/wp-cli/default-readme.svg?branch=main)
       """
     And the {PACKAGE_PATH}/local/wp-cli/default-readme/README.md file should contain:
       """
       *This README.md is generated dynamically from the project's codebase
       """
     And the {PACKAGE_PATH}/local/wp-cli/default-readme/README.md file should contain:
       """
-      wp package install wp-cli/default-readme:dev-master
+      wp package install wp-cli/default-readme:dev-main
       """
     When I run `wp package uninstall wp-cli/default-readme`
     Then STDOUT should contain:
@@ -76,7 +76,7 @@ Feature: Scaffold a README.md file for an existing package
     And the {PACKAGE_PATH}/local/wp-cli/custom-branch/README.md file should exist
     And the {PACKAGE_PATH}/local/wp-cli/custom-branch/README.md file should contain:
       """
-      Installing this package requires WP-CLI v2.12 or greater. Update to the latest stable release with `wp cli update`.
+      Installing this package requires WP-CLI v2.13 or greater. Update to the latest stable release with `wp cli update`.
       """
     And the {PACKAGE_PATH}/local/wp-cli/custom-branch/README.md file should contain:
       """
@@ -152,7 +152,7 @@ Feature: Scaffold a README.md file for an existing package
               "files": [ "command.php" ]
           },
           "require": {
-              "wp-cli/wp-cli": "^2.12"
+              "wp-cli/wp-cli": "^2.13"
           },
           "require-dev": {
               "wp-cli/wp-cli-tests": "^5.0.0"
@@ -376,7 +376,7 @@ Feature: Scaffold a README.md file for an existing package
               "files": [ "command.php" ]
           },
           "require": {
-              "wp-cli/wp-cli": "^2.12"
+              "wp-cli/wp-cli": "^2.13"
           },
           "require-dev": {
               "wp-cli/wp-cli-tests": "^5.0.0"
@@ -395,3 +395,46 @@ Feature: Scaffold a README.md file for an existing package
       """
       **Alias:** `cpt`
       """
+
+  Scenario: README correctly indents multi-paragraph parameter descriptions
+    Given an empty directory
+    And a foo/command.php file:
+      """
+      <?php
+      /**
+       * Multi-paragraph test command.
+       */
+      class Multi_Para_Test_Command {
+          /**
+           * Test command with a multi-paragraph parameter description.
+           *
+           * ## OPTIONS
+           *
+           * [<file>]
+           * : Read content from <file>. If this value is present, the
+           *     `--content` argument will be ignored.
+           *
+           *   Passing `-` will cause content to
+           *   be read from STDIN.
+           *
+           * @when before_wp_load
+           */
+          public function __invoke( $args, $assoc_args ) {}
+      }
+      WP_CLI::add_command( 'multi-para-test', 'Multi_Para_Test_Command' );
+      """
+    And a foo/composer.json file:
+      """
+      {
+          "name": "wp-cli/multi-para-test",
+          "description": "Test",
+          "extra": {
+              "commands": ["multi-para-test"]
+          }
+      }
+      """
+
+    When I run `wp --require=foo/command.php scaffold package-readme foo`
+    Then the foo/README.md file should exist
+    And the contents of the foo/README.md file should match /\t\t.*Read content from/
+    And the contents of the foo/README.md file should match /\t\t.*Passing/

features/scaffold-package.feature

@@ -18,6 +18,15 @@ Feature: Scaffold WP-CLI commands
       """
       .gitignore
       """
+    And the {PACKAGE_PATH}/local/wp-cli/foo/phpcs.xml.dist file should exist
+    And the {PACKAGE_PATH}/local/wp-cli/foo/phpcs.xml.dist file should contain:
+      """
+      WP_CLI_CS
+      """
+    And the {PACKAGE_PATH}/local/wp-cli/foo/phpcs.xml.dist file should contain:
+      """
+      wpcli_foo
+      """
     And the {PACKAGE_PATH}/local/wp-cli/foo/composer.json file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/composer.json file should contain:
       """
@@ -34,7 +43,7 @@ Feature: Scaffold WP-CLI commands
     And the {PACKAGE_PATH}/local/wp-cli/foo/composer.json file should contain:
       """
           "require": {
-              "wp-cli/wp-cli": "^2.12"
+              "wp-cli/wp-cli": "^2.13"
           },
       """
     And the {PACKAGE_PATH}/local/wp-cli/foo/hello-world-command.php file should exist
@@ -43,6 +52,15 @@ Feature: Scaffold WP-CLI commands
       """
       Contributing
       """
+    And the {PACKAGE_PATH}/local/wp-cli/foo/LICENSE file should exist
+    And the {PACKAGE_PATH}/local/wp-cli/foo/LICENSE file should contain:
+      """
+      The MIT License (MIT)
+      """
+    And the {PACKAGE_PATH}/local/wp-cli/foo/LICENSE file should contain:
+      """
+      wp-cli/foo Contributors
+      """
     And the {PACKAGE_PATH}/local/wp-cli/foo/wp-cli.yml file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/.travis.yml file should not exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/.github/PULL_REQUEST_TEMPLATE file should exist
@@ -127,7 +145,9 @@ 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/phpcs.xml.dist file should exist
     And the custom-directory/composer.json file should exist
+    And the custom-directory/LICENSE 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
@@ -157,6 +177,8 @@ Feature: Scaffold WP-CLI commands
       s
       s
       s
+      s
+      s
       """
 
     When I try `wp scaffold package wp-cli/same-package --skip-tests --skip-github`
@@ -195,6 +217,7 @@ 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/phpcs.xml.dist 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/hello-world-command.php file should exist
     And the {PACKAGE_PATH}/local/wp-cli/with-tests/wp-cli.yml file should exist
@@ -260,5 +283,40 @@ Feature: Scaffold WP-CLI commands
       Installing package
       """
     And the {PACKAGE_PATH}/local/wp-cli/foo/.gitignore file should exist
+    And the {PACKAGE_PATH}/local/wp-cli/foo/phpcs.xml.dist file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/.github/PULL_REQUEST_TEMPLATE file should not exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/.github/ISSUE_TEMPLATE file should not exist
+
+  Scenario: Scaffolded package includes autoloader documentation
+    Given an empty directory
+
+    When I run `wp package path`
+    Then save STDOUT as {PACKAGE_PATH}
+
+    When I run `wp scaffold package wp-cli/foo --skip-tests --skip-readme --skip-github --skip-install`
+    Then STDOUT should contain:
+      """
+      Success: Created package files
+      """
+    And STDOUT should contain:
+      """
+      Next steps:
+      """
+    And STDOUT should contain:
+      """
+      composer dump-autoload
+      """
+
+    When I run `cat {PACKAGE_PATH}/local/wp-cli/foo/src/HelloWorldCommand.php`
+    Then STDOUT should contain:
+      """
+      IMPORTANT: After modifying this file or adding new command classes, you need to
+      """
+    And STDOUT should contain:
+      """
+      composer dump-autoload --working-dir=$(wp package path)
+      """
+    And STDOUT should contain:
+      """
+      https://getcomposer.org/doc/01-basic-usage.md#autoloading
+      """