LTRAC-467: chore(create-catalyst) - Deprecate the integration command

.changeset/ltrac-467-deprecate-integration.md

@@ -0,0 +1,5 @@
+---
+"@bigcommerce/create-catalyst": minor
+---
+
+Deprecate the `create-catalyst integration` command. It now prints a deprecation warning when invoked and is hidden from `--help`. The command builds integration patches by diffing git tags, which won't work once Catalyst projects are distributed as tarballs (no git history) — it will be replaced by the forthcoming `catalyst upgrade` command. The command still functions for now; full removal will follow in a future major version.

packages/create-catalyst/src/commands/integration.ts

@@ -1,5 +1,6 @@
 import { Command } from '@commander-js/extra-typings';
 import { exec as execCb } from 'child_process';
+import { colorize } from 'consola/utils';
 import { parse } from 'dotenv';
 import { outputFileSync, writeJsonSync } from 'fs-extra/esm';
 import kebabCase from 'lodash.kebabcase';
@@ -22,6 +23,14 @@ export const integration = new Command('integration')
   .argument('<integration-name>', 'Formatted name of the integration')
   .option('--commit-hash <hash>', 'Override integration source branch with a specific commit hash')
   .action(async (integrationNameRaw, options) => {
+    console.warn(
+      colorize(
+        'yellow',
+        '⚠ `create-catalyst integration` is deprecated and will be replaced by the ' +
+          '`catalyst upgrade` command.',
+      ),
+    );
+
     // @todo check for integration name conflicts
     const integrationName = z.string().transform(kebabCase).parse(integrationNameRaw);
 

packages/create-catalyst/src/index.ts

@@ -19,7 +19,9 @@ program
   .description('A command line tool to create a new Catalyst project.')
   .addCommand(create, { isDefault: true })
   .addCommand(init)
-  .addCommand(integration)
+  // Deprecated: hidden from help so new users don't discover it; still runnable
+  // (with a deprecation warning) until it's removed. See LTRAC-467.
+  .addCommand(integration, { hidden: true })
   .addCommand(telemetry)
   .hook('preAction', telemetryPreHook)
   .hook('postAction', telemetryPostHook);