Merge pull request #6133 from wp-cli/copilot/show-default-values-prompt

Author: swissspidy

features/prompt.feature

@@ -292,6 +292,135 @@ Feature: Prompt user for input
       wp test-sensitive --username='admin' --password='[REDACTED]' --api-key='[REDACTED]'
       """
 
+  Scenario: Flag prompt should accept Y for yes
+    Given an empty directory
+    And a cmd.php file:
+      """
+      <?php
+      /**
+       * Test that flag prompt accepts Y.
+       *
+       * ## OPTIONS
+       *
+       * [--flag]
+       * : An optional flag
+       *
+       * @when before_wp_load
+       */
+      WP_CLI::add_command( 'test-flag-y', function( $_, $assoc_args ){
+        $flag_value = isset( $assoc_args['flag'] ) ? 'true' : 'false';
+        WP_CLI::line( 'flag: ' . $flag_value );
+      });
+      """
+    And a yes-response file:
+      """
+      Y
+      """
+    And a wp-cli.yml file:
+      """
+      require:
+        - cmd.php
+      """
+
+    When I run `wp test-flag-y --prompt < yes-response`
+    Then STDOUT should contain:
+      """
+      wp test-flag-y --flag
+      """
+    And STDOUT should contain:
+      """
+      flag: true
+      """
+
+  Scenario: Assoc param with default should apply default on empty input
+    Given an empty directory
+    And a cmd.php file:
+      """
+      <?php
+      /**
+       * Test that default value is applied for assoc params.
+       *
+       * ## OPTIONS
+       *
+       * [--format=<format>]
+       * : Output format
+       * ---
+       * default: table
+       * options:
+       *   - table
+       *   - csv
+       *   - json
+       * ---
+       *
+       * @when before_wp_load
+       */
+      WP_CLI::add_command( 'test-assoc-default', function( $_, $assoc_args ){
+        WP_CLI::line( 'format: ' . $assoc_args['format'] );
+      });
+      """
+    And a empty-response file:
+      """
+
+      """
+    And a wp-cli.yml file:
+      """
+      require:
+        - cmd.php
+      """
+
+    When I run `wp test-assoc-default --prompt < empty-response`
+    Then STDOUT should contain:
+      """
+      wp test-assoc-default --format='table'
+      """
+    And STDOUT should contain:
+      """
+      format: table
+      """
+
+  Scenario: Positional arg with default should apply default on empty input
+    Given an empty directory
+    And a cmd.php file:
+      """
+      <?php
+      /**
+       * Test that default value is applied for positional args.
+       *
+       * ## OPTIONS
+       *
+       * [<name>]
+       * : The name
+       * ---
+       * default: World
+       * ---
+       *
+       * @when before_wp_load
+       */
+      WP_CLI::add_command( 'test-positional-default', function( $args, $_ ){
+        $name = isset( $args[0] ) ? $args[0] : 'Nobody';
+        WP_CLI::line( 'Hello ' . $name );
+      });
+      """
+    And a empty-response file:
+      """
+
+      """
+    And a wp-cli.yml file:
+      """
+      require:
+        - cmd.php
+      """
+
+    When I run `wp test-positional-default --prompt < empty-response`
+    Then STDOUT should contain:
+      """
+      wp test-positional-default 'World'
+      """
+    And STDOUT should contain:
+      """
+      Hello World
+      """
+
   Scenario: Prompt should display argument descriptions
     Given an empty directory
     And a cmd.php file:

php/WP_CLI/Dispatcher/Subcommand.php

@@ -183,6 +183,9 @@ private function prompt_args( $args, $assoc_args ) {
 			return [ $args, $assoc_args ];
 		}
 
+		// Create a docparser to get default values and descriptions
+		$docparser = $this->get_docparser();
+
 		// To skip the already provided positional arguments, we need to count
 		// how many we had already received.
 		$arg_index = 0;
@@ -276,7 +279,8 @@ function ( $spec_arg ) use ( $args, $assoc_args, &$arg_index ) {
 				} while ( $repeat );
 
 			} else {
-				$prompt = $current_prompt . $spec_arg['token'];
+				$prompt      = $current_prompt . $spec_arg['token'];
+				$default_val = null;
 
 				// Add description if available
 				$longdesc    = $this->get_longdesc();
@@ -286,16 +290,30 @@ function ( $spec_arg ) use ( $args, $assoc_args, &$arg_index ) {
 					$prompt .= ' (' . $description . ')';
 				}
 
+				// Get default value for the argument (not for flags)
 				if ( 'flag' === $spec_arg['type'] ) {
 					$prompt .= ' (Y/n)';
+				} elseif ( 'positional' === $spec_arg['type'] || 'assoc' === $spec_arg['type'] ) {
+					$spec_args = ( 'positional' === $spec_arg['type'] )
+						? $docparser->get_arg_args( $spec_arg['name'] )
+						: $docparser->get_param_args( $spec_arg['name'] );
+					if ( null !== $spec_args && isset( $spec_args['default'] ) ) {
+						$default_val = $spec_args['default'];
+						$prompt     .= ' [' . $default_val . ']';
+					}
 				}
 
 				$response = $this->prompt( $prompt );
 				if ( false === $response ) {
 					return [ $args, $assoc_args ];
 				}
 
-				if ( $response ) {
+				// If response is empty and there's a default (not a flag), use the default
+				if ( '' === $response && null !== $default_val ) {
+					$response = $default_val;
+				}
+
+				if ( '' !== $response ) {
 					switch ( $spec_arg['type'] ) {
 						case 'positional':
 							if ( $spec_arg['repeating'] ) {