Merge branch 'main' into copilot/add-non-interactive-option

Author: swissspidy

.github/workflows/code-quality.yml

@@ -6,6 +6,8 @@ on:
     branches:
       - main
       - master
+  schedule:
+     - cron: '17 2 * * *' # Run every day on a seemly random time.
 
 jobs:
   code-quality:

.typos.toml

@@ -7,5 +7,5 @@ extend-ignore-re = [
 
 [files]
 extend-exclude = [
-	"tests/JsonManipulatorTest.php"
+	"tests/phpunit/JsonManipulatorTest.php"
 ]

README.md

@@ -125,6 +125,70 @@ There are no optionally available fields.
 
 
 
+### wp package get
+
+Gets information about an installed WP-CLI package.
+
+~~~
+wp package get <name> [--fields=<fields>] [--format=<format>] [--skip-update-check]
+~~~
+
+**OPTIONS**
+
+	<name>
+		Name of the package to get information for.
+
+	[--fields=<fields>]
+		Limit the output to specific fields. Defaults to all fields.
+
+	[--format=<format>]
+		Render output in a particular format.
+		---
+		default: table
+		options:
+		  - table
+		  - csv
+		  - json
+		  - yaml
+		---
+
+	[--skip-update-check]
+		Skip checking for updates. This is faster and avoids authentication issues with GitHub or Composer repositories.
+
+**AVAILABLE FIELDS**
+
+These fields will be displayed by default for each package:
+
+* name
+* authors
+* version
+* update
+* update_version
+
+These fields are optionally available:
+
+* description
+
+**EXAMPLES**
+
+    # Get information about an installed package.
+    $ wp package get wp-cli/scaffold-package-command
+    +----------------+---------------------------------+
+    | Field          | Value                           |
+    +----------------+---------------------------------+
+    | name           | wp-cli/scaffold-package-command |
+    | authors        | Daniel Bachhuber                |
+    | version        | dev-main                        |
+    | update         | available                       |
+    | update_version | 2.x-dev                         |
+    +----------------+---------------------------------+
+
+    # Get the version of a package.
+    $ wp package get wp-cli/server-command --fields=version --format=json
+    {"version":"dev-main"}
+
+
+
 ### wp package install
 
 Installs a WP-CLI package.
@@ -254,8 +318,6 @@ Updates installed WP-CLI packages to their latest version.
 wp package update [<package-name>...]
 ~~~
 
-**OPTIONS**
-
 	[<package-name>...]
 		One or more package names to update. If not specified, all packages will be updated.
 

composer.json

@@ -13,8 +13,8 @@
   ],
   "require": {
     "ext-json": "*",
-    "composer/composer": "^2.2.25",
-    "wp-cli/wp-cli": "^2.12"
+    "composer/composer": "^2.9.5",
+    "wp-cli/wp-cli": "^2.13"
   },
   "require-dev": {
     "wp-cli/scaffold-command": "^1 || ^2",
@@ -38,6 +38,7 @@
     "commands": [
       "package",
       "package browse",
+      "package get",
       "package install",
       "package list",
       "package update",

features/package.feature

@@ -250,3 +250,69 @@ Feature: Manage WP-CLI packages
 
     When I run `wp package uninstall runcommand/hook`
     Then STDERR should be empty
+
+  Scenario: Get information about a single package
+    Given an empty directory
+
+    When I try `wp package get runcommand/hook`
+    Then STDERR should contain:
+      """
+      Error: Package 'runcommand/hook' is not installed.
+      """
+    And the return code should be 1
+
+    When I run `wp package install runcommand/hook`
+    Then STDERR should be empty
+
+    When I run `wp package get runcommand/hook`
+    Then STDOUT should contain:
+      """
+      runcommand/hook
+      """
+    And STDOUT should contain:
+      """
+      version
+      """
+
+    When I run `wp package get runcommand/hook --fields=name,version`
+    Then STDOUT should contain:
+      """
+      runcommand/hook
+      """
+    And STDOUT should contain:
+      """
+      version
+      """
+
+    When I run `wp package get runcommand/hook --fields=version --format=json`
+    Then STDOUT should contain:
+      """
+      "version"
+      """
+
+    When I run `wp package get runcommand/hook --format=json`
+    Then STDOUT should contain:
+      """
+      "name":"runcommand\/hook"
+      """
+    And STDOUT should contain:
+      """
+      "version"
+      """
+
+    When I run `wp package get runcommand/hook --skip-update-check --fields=name,update,update_version`
+    Then STDOUT should contain:
+      """
+      runcommand/hook
+      """
+    And STDOUT should contain:
+      """
+      none
+      """
+    And STDOUT should not contain:
+      """
+      available
+      """
+
+    When I run `wp package uninstall runcommand/hook`
+    Then STDERR should be empty

phpcs.xml.dist

@@ -18,7 +18,7 @@
 	<exclude-pattern>*/src/WP_CLI/JsonManipulator\.php$</exclude-pattern>
 	<exclude-pattern>*/src/WP_CLI/Package/Compat/Min_Composer_1_10/NullIOMethodsTrait\.php$</exclude-pattern>
 	<exclude-pattern>*/src/WP_CLI/Package/Compat/Min_Composer_2_3/NullIOMethodsTrait\.php$</exclude-pattern>
-	<exclude-pattern>*/tests/JsonManipulatorTest\.php$</exclude-pattern>
+	<exclude-pattern>*/tests/phpunit/JsonManipulatorTest\.php$</exclude-pattern>
 
 	<!-- Show progress. -->
 	<arg value="p"/>
@@ -63,4 +63,5 @@
 		<exclude-pattern>*/src/Package_Command\.php$</exclude-pattern>
 	</rule>
 
+	<exclude-pattern>*/tests/phpstan/scan-files\.php$</exclude-pattern>
 </ruleset>

phpstan.neon.dist

@@ -1,12 +1,13 @@
 parameters:
-  level: 1
+  level: 5
   paths:
     - src
     - package-command.php
   scanDirectories:
     - vendor/wp-cli/wp-cli/php
   scanFiles:
     - vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
+    - tests/phpstan/scan-files.php
   treatPhpDocTypesAsCertain: false
   ignoreErrors:
     # WP_CLI_VERSION is defined in wp-cli core at runtime

phpunit.xml.dist

@@ -13,7 +13,7 @@
 		 colors="true"
 		 verbose="true">
 	<testsuite name="wp-cli/package-command tests">
-		<directory suffix="Test.php">tests</directory>
+		<directory suffix="Test.php">tests/phpunit</directory>
 	</testsuite>
 
 	<filter>