Merge pull request #329 from ernilambar/fix/scaffold-command-docs

swissspidy · web-flow · commit 996639049198 · 2024-04-26T12:03:59.000+02:00
diff --git a/README.md b/README.md
@@ -21,18 +21,18 @@ wp scaffold
 
 **EXAMPLES**
 
-    # Generate a new plugin with unit tests
+    # Generate a new plugin with unit tests.
     $ wp scaffold plugin sample-plugin
     Success: Created plugin files.
     Success: Created test files.
 
-    # Generate theme based on _s
+    # Generate theme based on _s.
     $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe"
     Success: Created theme 'Sample Theme'.
 
-    # Generate code for post type registration in given theme
+    # Generate code for post type registration in given theme.
     $ wp scaffold post-type movie --label=Movie --theme=simple-life
-    Success: Created /var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php
+    Success: Created '/var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php'.
 
 
 
@@ -93,9 +93,9 @@ wp scaffold block <slug> [--title=<title>] [--dashicon=<dashicon>] [--category=<
 
 **Warning: `wp scaffold block` is deprecated.**
 
-The official script to generate a block is the [@wordpress/create-block](https://developer.wordpress.org/block-editor/designers-developers/developers/packages/packages-create-block/) package.
+The official script to generate a block is the [@wordpress/create-block](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/) package.
 
-See the [Create a Block tutorial](https://developer.wordpress.org/block-editor/getting-started/create-block/) for a complete walk-through.
+See the [Create a Block tutorial](https://developer.wordpress.org/block-editor/getting-started/tutorial/) for a complete walk-through.
 
 **OPTIONS**
 
@@ -275,7 +275,7 @@ The following files are generated by default:
 * `tests/test-sample.php` is a sample file containing the actual tests.
 * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 
-Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).
+Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/).
 
 **ENVIRONMENT**
 
@@ -414,7 +414,7 @@ The following files are generated by default:
 * `tests/test-sample.php` is a sample file containing the actual tests.
 * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 
-Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).
+Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/).
 
 **ENVIRONMENT**
 
diff --git a/src/Scaffold_Command.php b/src/Scaffold_Command.php
@@ -8,18 +8,18 @@
  *
  * ## EXAMPLES
  *
- *     # Generate a new plugin with unit tests
+ *     # Generate a new plugin with unit tests.
  *     $ wp scaffold plugin sample-plugin
  *     Success: Created plugin files.
  *     Success: Created test files.
  *
- *     # Generate theme based on _s
+ *     # Generate theme based on _s.
  *     $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe"
  *     Success: Created theme 'Sample Theme'.
  *
- *     # Generate code for post type registration in given theme
+ *     # Generate code for post type registration in given theme.
  *     $ wp scaffold post-type movie --label=Movie --theme=simple-life
- *     Success: Created /var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php
+ *     Success: Created '/var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php'.
  *
  * @package wp-cli
  */
@@ -206,9 +206,9 @@ private function scaffold( $slug, $assoc_args, $defaults, $subdir, $templates )
 	 *
 	 * **Warning: `wp scaffold block` is deprecated.**
 	 *
-	 * The official script to generate a block is the [@wordpress/create-block](https://developer.wordpress.org/block-editor/designers-developers/developers/packages/packages-create-block/) package.
+	 * The official script to generate a block is the [@wordpress/create-block](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/) package.
 	 *
-	 * See the [Create a Block tutorial](https://developer.wordpress.org/block-editor/getting-started/create-block/) for a complete walk-through.
+	 * See the [Create a Block tutorial](https://developer.wordpress.org/block-editor/getting-started/tutorial/) for a complete walk-through.
 	 *
 	 * ## OPTIONS
 	 *
@@ -711,7 +711,7 @@ public function plugin( $args, $assoc_args ) {
 	 * * `tests/test-sample.php` is a sample file containing the actual tests.
 	 * * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 	 *
-	 * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).
+	 * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/).
 	 *
 	 * ## ENVIRONMENT
 	 *
@@ -764,7 +764,7 @@ public function plugin_tests( $args, $assoc_args ) {
 	 * * `tests/test-sample.php` is a sample file containing the actual tests.
 	 * * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
 	 *
-	 * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).
+	 * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/).
 	 *
 	 * ## ENVIRONMENT
 	 *

Original file line number	Diff line number	Diff line change
`@@ -8,18 +8,18 @@`
`8`	`8`	`*`
`9`	`9`	`* ## EXAMPLES`
`10`	`10`	`*`
`11`		`- * # Generate a new plugin with unit tests`
	`11`	`+ * # Generate a new plugin with unit tests.`
`12`	`12`	`* $ wp scaffold plugin sample-plugin`
`13`	`13`	`* Success: Created plugin files.`
`14`	`14`	`* Success: Created test files.`
`15`	`15`	`*`
`16`		`- * # Generate theme based on _s`
	`16`	`+ * # Generate theme based on _s.`
`17`	`17`	`* $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe"`
`18`	`18`	`* Success: Created theme 'Sample Theme'.`
`19`	`19`	`*`
`20`		`- * # Generate code for post type registration in given theme`
	`20`	`+ * # Generate code for post type registration in given theme.`
`21`	`21`	`* $ wp scaffold post-type movie --label=Movie --theme=simple-life`
`22`		`- * Success: Created /var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php`
	`22`	`+ * Success: Created '/var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php'.`
`23`	`23`	`*`
`24`	`24`	`* @package wp-cli`
`25`	`25`	`*/`
`@@ -206,9 +206,9 @@ private function scaffold( $slug, $assoc_args, $defaults, $subdir, $templates )`
`206`	`206`	`*`
`207`	`207`	* Warning: `wp scaffold block` is deprecated.
`208`	`208`	`*`
`209`		`- * The official script to generate a block is the [@wordpress/create-block](https://developer.wordpress.org/block-editor/designers-developers/developers/packages/packages-create-block/) package.`
	`209`	`+ * The official script to generate a block is the [@wordpress/create-block](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/) package.`
`210`	`210`	`*`
`211`		`- * See the [Create a Block tutorial](https://developer.wordpress.org/block-editor/getting-started/create-block/) for a complete walk-through.`
	`211`	`+ * See the [Create a Block tutorial](https://developer.wordpress.org/block-editor/getting-started/tutorial/) for a complete walk-through.`
`212`	`212`	`*`
`213`	`213`	`* ## OPTIONS`
`214`	`214`	`*`
`@@ -711,7 +711,7 @@ public function plugin( $args, $assoc_args ) {`
`711`	`711`	* * `tests/test-sample.php` is a sample file containing the actual tests.
`712`	`712`	* * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
`713`	`713`	`*`
`714`		`- * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).`
	`714`	`+ * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/).`
`715`	`715`	`*`
`716`	`716`	`* ## ENVIRONMENT`
`717`	`717`	`*`
`@@ -764,7 +764,7 @@ public function plugin_tests( $args, $assoc_args ) {`
`764`	`764`	* * `tests/test-sample.php` is a sample file containing the actual tests.
`765`	`765`	* * `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
`766`	`766`	`*`
`767`		`- * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/).`
	`767`	`+ * Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/).`
`768`	`768`	`*`
`769`	`769`	`* ## ENVIRONMENT`
`770`	`770`	`*`