Feature/cli

composer.json

@@ -35,7 +35,7 @@
     "brain/monkey": "^2.6",
     "captainhook/captainhook": "^5.10",
     "dealerdirect/phpcodesniffer-composer-installer": "^0.7",
-    "infinum/eightshift-coding-standards": "^1.5",
+    "infinum/eightshift-coding-standards": "^1.6",
     "pestphp/pest": "^1.2",
     "php-stubs/wordpress-stubs": "^5.9",
     "phpunit/phpunit": "^9.5",

phpcs.xml.dist

@@ -78,4 +78,14 @@
 			<property name="ignoreComments" value="true" />
 		</properties>
 	</rule>
+
+	<!-- Add additional extending CLI classes. -->
+	<rule ref="Eightshift.Commenting.FunctionComment">
+		<properties>
+			<property name="allowedExtendedClasses" type="array">
+				<element value="AbstractCli"/>
+				<element value="AbstractBlocksCli"/>
+			</property>
+		</properties>
+	</rule>
 </ruleset>

phpunit.xml

@@ -10,8 +10,8 @@
 		</testsuite>
 	</testsuites>
 	<php>
-        <env name="ES_TEST" value="true" force="true" />
-    </php>
+		<env name="ES_TEST" value="true" force="true" />
+	</php>
 	<coverage processUncoveredFiles="true">
 		<include>
 			<directory suffix=".php">./src</directory>

src/AdminMenus/AbstractAdminMenu.php

@@ -29,22 +29,37 @@ abstract class AbstractAdminMenu implements ServiceInterface, RenderableBlockInt
 	 */
 	public function register(): void
 	{
-		\add_action(
-			'admin_menu',
-			function () {
-				\add_menu_page(
-					$this->getTitle(),
-					$this->getMenuTitle(),
-					$this->getCapability(),
-					$this->getMenuSlug(),
-					[$this, 'processAdminMenu'],
-					$this->getIcon(),
-					$this->getPosition()
-				);
-			}
+		\add_action('admin_menu', [$this, 'callback'], $this->getPriorityOrder());
+	}
+
+	/**
+	 * Return action callback method.
+	 *
+	 * @return void
+	 */
+	public function callback(): void
+	{
+		\add_menu_page(
+			$this->getTitle(),
+			$this->getMenuTitle(),
+			$this->getCapability(),
+			$this->getMenuSlug(),
+			[$this, 'processAdminMenu'],
+			$this->getIcon(),
+			$this->getPosition()
 		);
 	}
 
+	/**
+	 * Return hook priority order.
+	 *
+	 * @return integer
+	 */
+	public function getPriorityOrder(): int
+	{
+		return 10;
+	}
+
 	/**
 	 * Process the admin menu attributes and prepare rendering.
 	 *

src/AdminMenus/AdminMenuCli.php

@@ -12,19 +12,13 @@
 
 use EightshiftLibs\Cli\AbstractCli;
 use EightshiftLibs\Cli\ParentGroups\CliCreate;
+use EightshiftLibs\Helpers\Components;
 
 /**
  * Class AdminMenuCli
  */
 class AdminMenuCli extends AbstractCli
 {
-	/**
-	 * Output dir relative path.
-	 *
-	 * @var string
-	 */
-	public const OUTPUT_DIR = 'src' . \DIRECTORY_SEPARATOR . 'AdminMenus';
-
 	/**
 	 * Get WPCLI command parent name
 	 *
@@ -42,26 +36,7 @@ public function getCommandParentName(): string
 	 */
 	public function getCommandName(): string
 	{
-		return 'admin_menu';
-	}
-
-	/**
-	 * Define default develop props.
-	 *
-	 * @param string[] $args WPCLI eval-file arguments.
-	 *
-	 * @return array<string, int|string|boolean>
-	 */
-	public function getDevelopArgs(array $args): array
-	{
-		return [
-			'title' => 'Test Title',
-			'menu_title' => 'Test Menu Title',
-			'capability' => 'test_edit_posts',
-			'menu_slug' => 'test_title',
-			'menu_icon' => 'dashicons-admin-media',
-			'menu_position' => 50,
-		];
+		return 'admin-menu';
 	}
 
 	/**
@@ -138,7 +113,7 @@ public function getDoc(): array
 				## EXAMPLES
 
 				# Create service class:
-				$ wp boilerplate {$this->getCommandParentName()} {$this->getCommandName()} --title='Content' --menu_title='content' --capability='edit_posts' --menu_slug='es-content'
+				$ wp {$this->commandParentName} {$this->getCommandParentName()} {$this->getCommandName()} --title='Content' --menu_title='content' --capability='edit_posts' --menu_slug='es-content'
 
 				## RESOURCES
 
@@ -151,6 +126,8 @@ public function getDoc(): array
 	/* @phpstan-ignore-next-line */
 	public function __invoke(array $args, array $assocArgs)
 	{
+		$this->getIntroText($assocArgs);
+
 		// Get Arguments.
 		$title = $this->getArg($assocArgs, 'title');
 		$menuTitle = $this->getArg($assocArgs, 'menu_title');
@@ -183,6 +160,6 @@ public function __invoke(array $args, array $assocArgs)
 		}
 
 		// Output final class to new file/folder and finish.
-		$class->outputWrite(static::OUTPUT_DIR, $className, $assocArgs);
+		$class->outputWrite(Components::getProjectPaths('srcDestination', 'AdminMenus'), "{$className}.php", $assocArgs);
 	}
 }

src/AdminMenus/AdminReusableBlocksMenuCli.php

@@ -12,19 +12,13 @@
 
 use EightshiftLibs\Cli\AbstractCli;
 use EightshiftLibs\Cli\ParentGroups\CliCreate;
+use EightshiftLibs\Helpers\Components;
 
 /**
  * Class AdminReusableBlocksMenuCli
  */
 class AdminReusableBlocksMenuCli extends AbstractCli
 {
-	/**
-	 * Output dir relative path.
-	 *
-	 * @var string
-	 */
-	public const OUTPUT_DIR = 'src' . \DIRECTORY_SEPARATOR . 'AdminMenus';
-
 	/**
 	 * Get WPCLI command parent name
 	 *
@@ -42,25 +36,7 @@ public function getCommandParentName(): string
 	 */
 	public function getCommandName(): string
 	{
-		return 'admin_reusable_blocks_menu';
-	}
-
-	/**
-	 * Define default develop props.
-	 *
-	 * @param string[] $args WPCLI eval-file arguments.
-	 *
-	 * @return array<string, int|string|boolean>
-	 */
-	public function getDevelopArgs(array $args): array
-	{
-		return [
-			'title' => 'Test Reusable Blocks',
-			'menu_title' => 'Test Reusable Blocks',
-			'capability' => 'test_edit_posts',
-			'menu_icon' => 'dashicons-editor-generic',
-			'menu_position' => 100,
-		];
+		return 'admin-reusable-blocks-menu';
 	}
 
 	/**
@@ -94,14 +70,14 @@ public function getDoc(): array
 					'name' => 'title',
 					'description' => 'The text to be displayed in the title tags of the page when the menu is selected.',
 					'optional' => true,
-					'default' => 'Reusable Blocks',
+					'default' => $this->getDefaultArg('title'),
 				],
 				[
 					'type' => 'assoc',
 					'name' => 'menu_title',
 					'description' => 'The text to be used for the menu.',
 					'optional' => true,
-					'default' => 'Reusable Blocks',
+					'default' => $this->getDefaultArg('menu_title'),
 				],
 				[
 					'type' => 'assoc',
@@ -133,7 +109,7 @@ public function getDoc(): array
 				## EXAMPLES
 
 				# Create service class:
-				$ wp boilerplate {$this->getCommandParentName()} {$this->getCommandName()}
+				$ wp {$this->commandParentName} {$this->getCommandParentName()} {$this->getCommandName()}
 
 				## RESOURCES
 
@@ -146,6 +122,8 @@ public function getDoc(): array
 	/* @phpstan-ignore-next-line */
 	public function __invoke(array $args, array $assocArgs)
 	{
+		$this->getIntroText($assocArgs);
+
 		// Get Arguments.
 		$title = $this->getArg($assocArgs, 'title');
 		$menuTitle = $this->getArg($assocArgs, 'menu_title');
@@ -176,6 +154,6 @@ public function __invoke(array $args, array $assocArgs)
 		}
 
 		// Output final class to new file/folder and finish.
-		$class->outputWrite(static::OUTPUT_DIR, $className, $assocArgs);
+		$class->outputWrite(Components::getProjectPaths('srcDestination', 'AdminMenus'), "{$className}.php", $assocArgs);
 	}
 }

src/AdminMenus/AdminSubMenuCli.php

@@ -12,19 +12,13 @@
 
 use EightshiftLibs\Cli\AbstractCli;
 use EightshiftLibs\Cli\ParentGroups\CliCreate;
+use EightshiftLibs\Helpers\Components;
 
 /**
  * Class AdminSubMenuCli
  */
 class AdminSubMenuCli extends AbstractCli
 {
-	/**
-	 * Output dir relative path.
-	 *
-	 * @var string
-	 */
-	public const OUTPUT_DIR = 'src' . \DIRECTORY_SEPARATOR . 'AdminMenus';
-
 	/**
 	 * Get WPCLI command parent name
 	 *
@@ -42,25 +36,7 @@ public function getCommandParentName(): string
 	 */
 	public function getCommandName(): string
 	{
-		return 'admin_sub_menu';
-	}
-
-	/**
-	 * Define default develop props.
-	 *
-	 * @param string[] $args WPCLI eval-file arguments.
-	 *
-	 * @return array<string, int|string|boolean>
-	 */
-	public function getDevelopArgs(array $args): array
-	{
-		return [
-			'parent_slug' => 'test-example-menu-slug',
-			'title' => 'Test Admin Title',
-			'menu_title' => 'Test Admin Sub Menu Title',
-			'capability' => 'test_edit_posts',
-			'menu_slug' => 'test_admin_title',
-		];
+		return 'admin-sub-menu';
 	}
 
 	/**
@@ -128,7 +104,7 @@ public function getDoc(): array
 				## EXAMPLES
 
 				# Create service class:
-				$ wp boilerplate {$this->getCommandParentName()} {$this->getCommandName()} --parent_slug='shop' --title='Content' --menu_title='content' --capability='edit_posts' --menu_slug='es-content'
+				$ wp {$this->commandParentName} {$this->getCommandParentName()} {$this->getCommandName()} --parent_slug='shop' --title='Content' --menu_title='content' --capability='edit_posts' --menu_slug='es-content'
 
 				## RESOURCES
 
@@ -141,6 +117,8 @@ public function getDoc(): array
 	/* @phpstan-ignore-next-line */
 	public function __invoke(array $args, array $assocArgs)
 	{
+		$this->getIntroText($assocArgs);
+
 		// Get Arguments.
 		$parentSlug = $this->getArg($assocArgs, 'parent_slug');
 		$title = $this->getArg($assocArgs, 'title');
@@ -153,7 +131,7 @@ public function __invoke(array $args, array $assocArgs)
 		$className = $className . $this->getClassShortName();
 
 		// Read the template contents, and replace the placeholders with provided variables.
-		$class = $this->getExampleTemplate(__DIR__, $this->getClassShortName())
+		$this->getExampleTemplate(__DIR__, $this->getClassShortName())
 			->renameClassNameWithPrefix($this->getClassShortName(), $className)
 			->renameNamespace($assocArgs)
 			->renameUse($assocArgs)
@@ -162,9 +140,7 @@ public function __invoke(array $args, array $assocArgs)
 			->searchReplaceString($this->getArgTemplate('title'), $title)
 			->searchReplaceString($this->getArgTemplate('menu_title'), $menuTitle)
 			->searchReplaceString($this->getArgTemplate('capability'), $capability)
-			->searchReplaceString($this->getArgTemplate('menu_slug'), $menuSlug);
-
-		// Output final class to new file/folder and finish.
-		$class->outputWrite(static::OUTPUT_DIR, $className, $assocArgs);
+			->searchReplaceString($this->getArgTemplate('menu_slug'), $menuSlug)
+			->outputWrite(Components::getProjectPaths('srcDestination', 'AdminMenus'), "{$className}.php", $assocArgs);
 	}
 }