Remove api-dump from the list of commands on the website

danielbachhuber · danielbachhuber · commit aafa1133bf8c · 2016-08-01T05:46:45.000-07:00
diff --git a/Phakefile.php b/Phakefile.php
@@ -29,7 +29,7 @@ function generate_synopsis( $command, $path = '' ) {
 			echo $full_path . ' ' . $command['synopsis'] . "\n";
 		} else {
 			foreach ( $command['subcommands'] as $subcommand ) {
-				if ( 'website' === $subcommand['name'] ) {
+				if ( in_array( $subcommand['name'], array( 'website', 'api-dump' ) ) ) {
 					continue;
 				}
 				generate_synopsis( $subcommand, $full_path );
@@ -91,11 +91,11 @@ function gen_cmd_pages( $cmd, $parent = array() ) {
 	$wp = invoke_wp_cli( 'wp --skip-packages cli cmd-dump', $app );
 
 	foreach( $wp['subcommands'] as $k => $cmd ) {
-		if ( 'website' === $cmd['name'] ) {
+		if ( in_array( $cmd['name'], array( 'website', 'api-dump' ) ) ) {
 			unset( $wp['subcommands'][ $k ] );
-			$wp['subcommands'] = array_values( $wp['subcommands'] );
 		}
 	}
+	$wp['subcommands'] = array_values( $wp['subcommands'] );
 
 	// generate main page
 	file_put_contents( '_includes/cmd-list.html', render( 'cmd-list.mustache', $wp ) );
@@ -149,7 +149,7 @@ function gen_cmd_pages( $cmd, $parent = array() ) {
 
 desc( 'Update the /docs/internal-api/ page.' );
 task( 'internal-api-list', function( $app ) {
-	$apis = invoke_wp_cli( 'wp cli api-dump', $app );
+	$apis = invoke_wp_cli( 'wp api-dump', $app );
 	$categories = array(
 		'Registration' => array(),
 		'Output' => array(),
diff --git a/command.php b/command.php
@@ -91,6 +91,8 @@ function generate_contributing() {
  *
  * Used to build user-facing docs of public APIs.
  *
+ * @when before_wp_load
+ *
  * @subcommand api-dump
  */
 function api_dump() {
@@ -121,7 +123,7 @@ function api_dump() {
 	}
 	echo json_encode( $apis );
 }
-\WP_CLI::add_command( 'cli api-dump', '\WP_CLI_Org\api_dump' );
+\WP_CLI::add_command( 'api-dump', '\WP_CLI_Org\api_dump' );
 
 /**
  * Get a simple representation of a function or method
diff --git a/commands/cli/api-dump/index.md b/commands/cli/api-dump/index.md
diff --git a/commands/cli/cmd-dump/index.md b/commands/cli/cmd-dump/index.md
@@ -10,7 +10,9 @@ display_global_parameters: true
 
 <hr />
 
-# Dump the list of installed commands
+### EXAMPLES
+
+    # Dump the list of installed commands
     $ wp cli cmd-dump
     {"name":"wp","description":"Manage WordPress through the command-line.","longdesc":"\n\n
 
diff --git a/commands/cli/index.md b/commands/cli/index.md
@@ -43,10 +43,6 @@ display_global_parameters: true
 			<td><a href="/commands/cli/alias/">alias</a></td>
 			<td>List available aliases.</td>
 		</tr>
-		<tr>
-			<td><a href="/commands/cli/api-dump/">api-dump</a></td>
-			<td>Dump the list of internal APIs, as JSON.</td>
-		</tr>
 		<tr>
 			<td><a href="/commands/cli/check-update/">check-update</a></td>
 			<td>Check for update via Github API. Returns the available versions if there are updates, or empty if no update available.</td>
diff --git a/commands/theme/mod/index.md b/commands/theme/mod/index.md
@@ -12,15 +12,15 @@ display_global_parameters: true
 
 ### EXAMPLES
 
-    # Set theme mod
+    # Set theme mod.
     $ wp theme mod set background_color 000000
     Success: Theme mod background_color set to 000000
 
-    # Get single theme mod in JSON format
+    # Get single theme mod in JSON format.
     $ wp theme mod get background_color --format=json
     [{"key":"background_color","value":"dd3333"}]
 
-    # Remove all theme mods
+    # Remove all theme mods.
     $ wp theme mod remove --all
     Success: Theme mods removed.
 
diff --git a/commands/theme/mod/remove/index.md b/commands/theme/mod/remove/index.md
@@ -16,19 +16,19 @@ display_global_parameters: true
 : One or more mods to remove.
 
 [\--all]
-: Remove all theme mods
+: Remove all theme mods.
 
 ### EXAMPLES
 
-    # Remove all theme mods
+    # Remove all theme mods.
     $ wp theme mod remove --all
     Success: Theme mods removed.
 
-    # Remove single theme mods
+    # Remove single theme mod.
     $ wp theme mod remove background_color
-    Success: 1 mods removed.
+    Success: 1 mod removed.
 
-    # Remove multiple theme mods
+    # Remove multiple theme mods.
     $ wp theme mod remove background_color header_textcolor
     Success: 2 mods removed.
 

Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,8 @@ function generate_contributing() {`
`91`	`91`	`*`
`92`	`92`	`* Used to build user-facing docs of public APIs.`
`93`	`93`	`*`
	`94`	`+ * @when before_wp_load`
	`95`	`+ *`
`94`	`96`	`* @subcommand api-dump`
`95`	`97`	`*/`
`96`	`98`	`function api_dump() {`
`@@ -121,7 +123,7 @@ function api_dump() {`
`121`	`123`	`}`
`122`	`124`	`echo json_encode( $apis );`
`123`	`125`	`}`
`124`		`-\WP_CLI::add_command( 'cli api-dump', '\WP_CLI_Org\api_dump' );`
	`126`	`+\WP_CLI::add_command( 'api-dump', '\WP_CLI_Org\api_dump' );`
`125`	`127`
`126`	`128`	`/**`
`127`	`129`	`* Get a simple representation of a function or method`