Merge pull request #562 from wp-cli/update/handbook

Author: swissspidy

bin/command.php

@@ -408,6 +408,7 @@ public function gen_hb_manifest() {
 				'parent'          => null,
 			];
 		}
+
 		// Internal API pages.
 		foreach ( glob( WP_CLI_HANDBOOK_PATH . '/internal-api/*.md' ) as $file ) {
 			$slug     = basename( $file, '.md' );
@@ -426,6 +427,26 @@ public function gen_hb_manifest() {
 				'parent'          => 'internal-api',
 			];
 		}
+
+		// Behat steps pages.
+		foreach ( glob( WP_CLI_HANDBOOK_PATH . '/behat-steps/*.md' ) as $file ) {
+			$slug     = basename( $file, '.md' );
+			$title    = '';
+			$contents = file_get_contents( $file );
+			if ( preg_match( '/^#\s(.+)/', $contents, $matches ) ) {
+				$title = $matches[1];
+			}
+			$manifest[ $slug ] = [
+				'title'           => $title,
+				'slug'            => $slug,
+				'markdown_source' => sprintf(
+					'https://github.com/wp-cli/handbook/blob/main/behat-steps/%s.md',
+					$slug
+				),
+				'parent'          => 'ibehat-stepsapi',
+			];
+		}
+
 		file_put_contents( WP_CLI_HANDBOOK_PATH . '/bin/handbook-manifest.json', json_encode( $manifest, JSON_PRETTY_PRINT ) );
 		WP_CLI::success( 'Generated bin/handbook-manifest.json' );
 	}

bin/handbook-manifest.json

@@ -11,7 +11,7 @@ Schedule a callback to be executed at a certain point.
 <div>
 <strong>$when</strong> (string) Identifier for the hook.<br />
 <strong>$callback</strong> (mixed) Callback to execute when hook is called.<br />
-<strong>@return</strong> (null) <br />
+<strong>@return</strong> (void) <br />
 </div>
 
 

internal-api/wp-cli-add-hook.md

@@ -11,7 +11,7 @@ Display debug message prefixed with "Debug: " when `--debug` is used.
 <div>
 <strong>$message</strong> (string|WP_Error|Exception|Throwable) Message to write to STDERR.<br />
 <strong>$group</strong> (string|bool) Organize debug message to a specific group.<br />
-<strong>@return</strong> (null) <br />
+<strong>@return</strong> (void) <br />
 </div>
 
 

internal-api/wp-cli-debug.md

@@ -10,7 +10,7 @@ Display informational message without prefix, and ignore `--quiet`.
 
 <div>
 <strong>$message</strong> (string) Message to display to the end user.<br />
-<strong>@return</strong> (null) <br />
+<strong>@return</strong> (void) <br />
 </div>
 
 

internal-api/wp-cli-line.md

@@ -10,7 +10,7 @@ Run a WP-CLI command.
 
 <div>
 <strong>$command</strong> (string) WP-CLI command to run, including arguments.<br />
-<strong>$options</strong> (array) Configuration options for command execution.<br />
+<strong>$options</strong> (array) {<br />    Configuration options for command execution.<br />    @type bool        $launch     Launches a new process (true) or reuses the existing process (false). Default: true.<br />    @type bool        $exit_error Halts the script on error. Default: true.<br />    @type bool|string $return     Returns output as an object when set to 'all' (string), return just the 'stdout', 'stderr', or 'return_code' (string) of command, or print directly to stdout/stderr (false). Default: false.<br />    @type bool|string $parse      Parse returned output as 'json' (string); otherwise, output is unchanged (false). Default: false.<br />@param array $command_args Contains additional command line arguments for the command. Each element represents a single argument. Default: empty array.<br />}<br />
 <strong>@return</strong> (mixed) <br />
 </div>
 

internal-api/wp-cli-runcommand.md

@@ -10,15 +10,15 @@ Display success message prefixed with "Success: ".
 
 <div>
 <strong>$message</strong> (string) Message to write to STDOUT.<br />
-<strong>@return</strong> (null) <br />
+<strong>@return</strong> (void) <br />
 </div>
 
 
 ***
 
 ## Notes
 
-Success message is written to STDOUT.
+Success message is written to STDOUT, or discarded when `--quiet` flag is supplied.
 
 Typically recommended to inform user of successful script conclusion.
 

internal-api/wp-cli-success.md

@@ -10,8 +10,8 @@ Render a collection of items as an ASCII table, JSON, CSV, YAML, list of ids, or
 
 <div>
 <strong>$format</strong> (string) Format to use: 'table', 'json', 'csv', 'yaml', 'ids', 'count'.<br />
-<strong>$items</strong> (array) An array of items to output.<br />
-<strong>$fields</strong> (array|string) Named fields for each item of data. Can be array or comma-separated list.<br />
+<strong>$items</strong> (array&lt;mixed&gt;) An array of items to output.<br />
+<strong>$fields</strong> (array&lt;string&gt;|string) Named fields for each item of data. Can be array or comma-separated list.<br />
 </div>
 
 

internal-api/wp-cli-utils-format-items.md

@@ -9,7 +9,7 @@ Return the flag value or, if it's not set, the $default value.
     WP_CLI\Utils\get_flag_value( $assoc_args, $flag, $default = null )
 
 <div>
-<strong>$assoc_args</strong> (array) Arguments array.<br />
+<strong>$assoc_args</strong> (array&lt;string,string|bool&gt;) Arguments array.<br />
 <strong>$flag</strong> (string) Flag to get the value.<br />
 <strong>$default</strong> (mixed) Default value for the flag. Default: NULL.<br />
 <strong>@return</strong> (mixed) <br />

internal-api/wp-cli-utils-get-flag-value.md

@@ -9,6 +9,8 @@ Parse a SSH url for its host, port, and path.
     WP_CLI\Utils\parse_ssh_url( $url, $component = -1 )
 
 <div>
+<strong>$url</strong> (string) <br />
+<strong>$component</strong> (int) <br />
 <strong>@return</strong> (mixed) <br />
 </div>