Remove storyblok:components:overview in favor of storyblok:debug

CHANGELOG.md

@@ -3,6 +3,7 @@
 
 * (improvement) Detect space id / content token mismatch and automatically abort all further requests.
 * (feature) Add `storyblok:debug` command.
+* (deprecation) Deprecate `storyblok:components:overview` command, use `storyblok:debug` instead.
 
 
 3.12.1

UPGRADE.md

@@ -1,6 +1,11 @@
-2.x to 4.0
+3.x to 4.0
 ==========
 
+* Removed `storyblok:components:overview` command, use `storyblok:debug` instead.
+
+
+2.x to 4.0
+==========
 
 * `AbstractField::enablePreview()` is removed, use `AbstractField::useAsAdminDisplayName()` instead.
 

src/Command/DebugCommand.php

@@ -15,7 +15,12 @@
 
 use function Symfony\Component\String\u;
 
-#[AsCommand("storyblok:debug")]
+#[AsCommand(
+	"storyblok:debug",
+	description: "Displays debug info for the current Storyblok connection and config.",
+	// TODO v4: remove alias
+	aliases: ["storyblok:components:overview"],
+)]
 final class DebugCommand extends Command
 {
 	/**
@@ -39,6 +44,18 @@ protected function execute (InputInterface $input, OutputInterface $output) : in
 		$io = new TorrStyle($input, $output);
 		$io->title("Storyblok: Debug");
 
+		// TODO v4: remove check
+		if ("storyblok:debug" !== $input->getFirstArgument())
+		{
+			$message = sprintf(
+				"The command `%s` is deprecated. Use `%s` instead.",
+				$input->getFirstArgument(),
+				"storyblok:debug",
+			);
+			trigger_deprecation("21torr/storyblok", "3.13.0", $message);
+			$io->caution($message);
+		}
+
 		try
 		{
 			$this->showInfo($io);