Merge pull request #8 from alleyinteractive/feature/update-command

Bring the command up to date

Author: mboynes

.distignore

@@ -0,0 +1,18 @@
+.DS_Store
+.git
+.gitignore
+.gitlab-ci.yml
+.editorconfig
+.travis.yml
+behat.yml
+circle.yml
+phpcs.xml.dist
+phpunit.xml.dist
+bin/
+features/
+utils/
+*.zip
+*.tar.gz
+*.swp
+*.txt
+*.log

.editorconfig

@@ -4,6 +4,8 @@
 # WordPress Coding Standards
 # https://make.wordpress.org/core/handbook/coding-standards/
 
+# From https://github.com/WordPress/wordpress-develop/blob/trunk/.editorconfig with a couple of additions.
+
 root = true
 
 [*]
@@ -12,11 +14,13 @@ end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
 indent_style = tab
-indent_size = 4
 
-[{.jshintrc,*.json,*.yml}]
+[{*.yml,*.feature,.jshintrc,*.json}]
 indent_style = space
 indent_size = 2
 
+[*.md]
+trim_trailing_whitespace = false
+
 [{*.txt,wp-config-sample.php}]
 end_of_line = crlf

.github/ISSUE_TEMPLATE

@@ -0,0 +1,11 @@
+<!--
+
+Thanks for creating a new issue!
+
+Found a bug or want to suggest an enhancement? Before completing your issue, please review our best practices: https://make.wordpress.org/cli/handbook/bug-reports/
+
+Need help with something? GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support
+
+You can safely delete this comment.
+
+-->

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,16 @@
+<!--
+
+Thanks for submitting a pull request!
+
+Please review our contributing guidelines if you haven't recently: https://make.wordpress.org/cli/handbook/contributing/#creating-a-pull-request
+
+Here's an overview to our process:
+
+1. One of the project committers will soon provide a code review: https://make.wordpress.org/cli/handbook/code-review/
+2. You are expected to address the code review comments in a timely manner (if we don't hear from you in two weeks, we'll consider your pull request abandoned).
+3. Please make sure to include functional tests for your changes.
+4. The reviewing committer will merge your pull request as soon as it passes code review (and provided it fits within the scope of the project).
+
+You can safely delete this comment.
+
+-->

.github/settings.yml

@@ -0,0 +1,23 @@
+# Used by Probot Settings: https://probot.github.io/apps/settings/
+repository:
+labels:
+  - name: bug
+    color: fc2929
+  - name: scope:documentation
+    color: 0e8a16
+  - name: scope:testing
+    color: 5319e7
+  - name: good-first-issue
+    color: eb6420
+  - name: help-wanted
+    color: 159818
+  - name: maybelater
+    color: c2e0c6
+  - name: state:unconfirmed
+    color: bfe5bf
+  - name: state:unsupported
+    color: bfe5bf
+  - name: wontfix
+    color: c2e0c6
+  - name: command:hello-world
+    color: c5def5

.github/workflows/testing.yml

@@ -0,0 +1,52 @@
+name: Testing
+
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+  workflow_dispatch:
+  workflow_call:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  behat:
+    strategy:
+      matrix:
+        php-version: ['8.3', '8.2', '7.4']
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:8
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+          MYSQL_DATABASE: wp_cli_test
+          MYSQL_USER: wp_cli_test
+          MYSQL_PASSWORD: password1
+          MYSQL_HOST: 127.0.0.1
+        ports:
+          - 3306
+        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+    steps:
+      - name: Check out source code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+
+      - name: Install composer packages
+        run: composer install
+
+      - name: Run Behat
+        run: composer behat
+        env:
+          WP_CLI_TEST_DBUSER: wp_cli_test
+          WP_CLI_TEST_DBPASS: password1
+          WP_CLI_TEST_DBNAME: wp_cli_test
+          WP_CLI_TEST_DBHOST: 127.0.0.1:${{ job.services.mysql.ports[3306] }}

.gitignore

@@ -1,3 +1,13 @@
 .DS_Store
+wp-cli.local.yml
 node_modules/
 vendor/
+*.zip
+*.tar.gz
+*.swp
+*.txt
+*.log
+composer.lock
+phpunit.xml
+phpcs.xml
+.phpcs.xml

.travis.yml

@@ -0,0 +1,8 @@
+Contributing
+============
+
+We appreciate you taking the initiative to contribute to this project.
+
+Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
+
+For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.

CONTRIBUTING.md

@@ -5,19 +5,18 @@ View PHPDoc of any class, method, property, or function.
 
 [![Build Status](https://travis-ci.org/alleyinteractive/wp-doc-command.svg?branch=master)](https://travis-ci.org/alleyinteractive/wp-doc-command)
 
-Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
+Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)
 
 ## Using
 
-
 ~~~
 wp doc <function-or-class> [<method-or-property>] [--raw]
 ~~~
 
 **OPTIONS**
 
-	[--raw]
-		Return the raw docblock instead of formatting it
+    [--raw]
+        Return the raw docblock instead of formatting it.
 
 **EXAMPLES**
 
@@ -28,15 +27,47 @@ wp doc <function-or-class> [<method-or-property>] [--raw]
     wp doc WP_Query parse_query
 
 
-
 ## Installing
 
-Installing this package requires WP-CLI v0.23.0 or greater. Update to the latest stable release with `wp cli update`.
+Installing this package requires WP-CLI v2.5 or greater. Update to the latest stable release with `wp cli update`.
+
+Once you've done so, you can install the latest stable version of this package with:
+
+```bash
+wp package install alleyinteractive/wp-doc-command:@stable
+```
+
+To install the latest development version of this package, use the following command instead:
 
-Once you've done so, you can install this package with `wp package install alleyinteractive/wp-doc-command`
+```bash
+wp package install alleyinteractive/wp-doc-command:dev-master
+```
 
 ## Contributing
 
-Code and ideas are more than welcome.
+We appreciate you taking the initiative to contribute to this project.
+
+Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
+
+For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.
+
+### Reporting a bug
+
+Think you’ve found a bug? We’d love for you to help us get it fixed.
+
+Before you create a new issue, you should [search existing issues](https://github.com/alleyinteractive/wp-doc-command/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
+
+Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/alleyinteractive/wp-doc-command/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).
+
+### Creating a pull request
+
+Want to contribute a new feature? Please first [open a new issue](https://github.com/alleyinteractive/wp-doc-command/issues/new) to discuss whether the feature is a good fit for the project.
+
+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.
+
+## Support
+
+GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support
+
 
-Please [open an issue](https://github.com/alleyinteractive/wp-doc-command/issues) with questions, feedback, and violent dissent. Pull requests are expected to include test coverage.
+*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*