Automigration: Refactor automigration command handling and add tests

- Introduced `getAutomigrateCommand` function to standardize the command generation for automigrating addons.
- Updated `postinstall.ts` files for `addonA11y` and `vitest` to utilize the new command function.
- Added unit tests for `getAutomigrateCommand` to ensure correct command generation.
- Updated various fix definitions to include a generic key type for better type safety.

Author: valentinpalkovic

code/addons/a11y/src/postinstall.ts

@@ -1,3 +1,5 @@
+import { getAutomigrateCommand } from 'storybook/internal/cli';
+
 // eslint-disable-next-line depend/ban-dependencies
 import { execa } from 'execa';
 
@@ -13,5 +15,9 @@ const $ = execa({
 export default async function postinstall(options: PostinstallOptions) {
   await $({
     stdio: 'inherit',
-  })`storybook automigrate addonA11yAddonTest ${options.yes ? '--yes' : ''}`;
+  })`${getAutomigrateCommand('addonA11yAddonTest', {
+    yes: options.yes,
+    configDir: options.configDir,
+    packageManager: options.packageManager,
+  })}`;
 }

code/addons/vitest/src/postinstall.ts

@@ -3,6 +3,7 @@ import * as fs from 'node:fs/promises';
 import { writeFile } from 'node:fs/promises';
 
 import { babelParse, generate, traverse } from 'storybook/internal/babel';
+import { getAutomigrateCommand } from 'storybook/internal/cli';
 import {
   JsPackageManagerFactory,
   extractProperFrameworkName,
@@ -337,7 +338,11 @@ export default async function postInstall(options: PostinstallOptions) {
       logger.plain(`${step} Setting up ${addonA11yName} for @storybook/addon-vitest:`);
       await $({
         stdio: 'inherit',
-      })`storybook automigrate addonA11yAddonTest ${options.yes ? '--yes' : ''}`;
+      })`${getAutomigrateCommand('addonA11yAddonTest', {
+        yes: options.yes,
+        configDir: options.configDir,
+        packageManager: options.packageManager,
+      })}`;
     } catch (e) {
       printError(
         '🚨 Oh no!',

code/core/src/cli/automigrate.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'vitest';
+
+import { getAutomigrateCommand } from './automigrate';
+
+describe('getAutomigrateCommand', () => {
+  it('should return the correct command', () => {
+    const command = getAutomigrateCommand('addon-a11y', {
+      yes: true,
+      configDir: 'config',
+      packageManager: 'npm',
+    });
+    expect(command).toEqual([
+      'storybook',
+      'automigrate',
+      'addon-a11y',
+      '--yes',
+      '--config-dir',
+      'config',
+      '--package-manager',
+      'npm',
+    ]);
+  });
+});

code/core/src/cli/automigrate.ts

@@ -0,0 +1,40 @@
+import type {
+  AutofixOptionsFromCLI,
+  FixesIDs,
+  allFixes,
+} from '../../../lib/cli-storybook/src/automigrate/fixes';
+
+/**
+ * Get the command to automigrate an addon
+ *
+ * @example
+ *
+ * ```ts
+ * const command = getAutomigrateCommand('addon-a11y', {
+ *   yes: true,
+ *   configDir: 'config',
+ *   packageManager: 'npm',
+ * });
+ * // ['storybook', 'automigrate', 'addon-a11y', '--yes', '--config-dir', 'config', '--package-manager', 'npm']
+ * ```
+ */
+export const getAutomigrateCommand = (
+  fixId: FixesIDs<typeof allFixes>,
+  options: Pick<AutofixOptionsFromCLI, 'yes' | 'configDir' | 'packageManager'>
+) => {
+  const command = ['storybook', 'automigrate', fixId];
+
+  if (options.yes) {
+    command.push('--yes');
+  }
+
+  if (options.configDir) {
+    command.push('--config-dir', options.configDir);
+  }
+
+  if (options.packageManager) {
+    command.push('--package-manager', options.packageManager);
+  }
+
+  return command;
+};

code/core/src/cli/index.ts

@@ -5,3 +5,4 @@ export * from './dirs';
 export * from './project_types';
 export * from './NpmOptions';
 export * from './eslintPlugin';
+export * from './automigrate';

code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.ts

@@ -39,7 +39,7 @@ interface AddonA11yAddonTestOptions {
  * - `.storybook/preview.<ts|js>` to set up tags.
  * - If we can't transform the files automatically, we'll prompt the user to do it manually.
  */
-export const addonA11yAddonTest: Fix<AddonA11yAddonTestOptions> = {
+export const addonA11yAddonTest: Fix<AddonA11yAddonTestOptions, 'addonA11yAddonTest'> = {
   id: 'addonA11yAddonTest',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
 

code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-parameters.ts

@@ -21,7 +21,7 @@ interface A11yOptions {
 
 const logger = console;
 
-export const addonA11yParameters: Fix<A11yOptions> = {
+export const addonA11yParameters: Fix<A11yOptions, 'addon-a11y-parameters'> = {
   id: 'addon-a11y-parameters',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
 

code/lib/cli-storybook/src/automigrate/fixes/addon-essentials-remove-docs.ts

@@ -34,7 +34,7 @@ const consolidatedAddons = {
  * - If user had docs enabled (default): Install @storybook/addon-docs and add to main.ts
  * - If user had docs disabled: Skip addon-docs installation
  */
-export const addonEssentialsRemoveDocs: Fix<AddonDocsOptions> = {
+export const addonEssentialsRemoveDocs: Fix<AddonDocsOptions, 'addon-essentials-remove-docs'> = {
   id: 'addon-essentials-remove-docs',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
 

code/lib/cli-storybook/src/automigrate/fixes/addon-experimental-test.ts

@@ -19,7 +19,7 @@ interface AddonExperimentalTestOptions {
  *   project files
  * - Update package.json dependencies if needed
  */
-export const addonExperimentalTest: Fix<AddonExperimentalTestOptions> = {
+export const addonExperimentalTest: Fix<AddonExperimentalTestOptions, 'addon-experimental-test'> = {
   id: 'addon-experimental-test',
 
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],

code/lib/cli-storybook/src/automigrate/fixes/addon-mdx-gfm-remove.ts

@@ -14,7 +14,7 @@ interface AddonMdxGfmOptions {
  *
  * - Remove @storybook/addon-mdx-gfm from main.ts and package.json
  */
-export const addonMdxGfmRemove: Fix<AddonMdxGfmOptions> = {
+export const addonMdxGfmRemove: Fix<AddonMdxGfmOptions, 'addon-mdx-gfm-remove'> = {
   id: 'addon-mdx-gfm-remove',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
 

code/lib/cli-storybook/src/automigrate/fixes/addon-storysource-remove.ts

@@ -15,7 +15,7 @@ interface AddonStorysourceOptions {
  *
  * - Remove @storybook/addon-storysource from main.ts and package.json
  */
-export const addonStorysourceRemove: Fix<AddonStorysourceOptions> = {
+export const addonStorysourceRemove: Fix<AddonStorysourceOptions, 'addon-storysource-remove'> = {
   id: 'addon-storysource-remove',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
 

code/lib/cli-storybook/src/automigrate/fixes/consolidated-imports.ts

@@ -97,7 +97,7 @@ export const transformPackageJsonFiles = async (files: string[], dryRun: boolean
   return errors;
 };
 
-export const consolidatedImports: Fix<ConsolidatedOptions> = {
+export const consolidatedImports: Fix<ConsolidatedOptions, 'consolidated-imports'> = {
   id: 'consolidated-imports',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
   check: async () => {

code/lib/cli-storybook/src/automigrate/fixes/eslint-plugin.ts

@@ -24,7 +24,7 @@ interface EslintPluginRunOptions {
  *
  * - Install it, and if possible configure it
  */
-export const eslintPlugin: Fix<EslintPluginRunOptions> = {
+export const eslintPlugin: Fix<EslintPluginRunOptions, 'eslintPlugin'> = {
   id: 'eslintPlugin',
 
   versionRange: ['*', '*'],

code/lib/cli-storybook/src/automigrate/fixes/index.ts

@@ -18,7 +18,7 @@ import { wrapRequire } from './wrap-require';
 
 export * from '../types';
 
-export const allFixes: Fix[] = [
+export const allFixes = [
   eslintPlugin,
   wrapRequire,
   addonMdxGfmRemove,
@@ -34,10 +34,12 @@ export const allFixes: Fix[] = [
   addonEssentialsRemoveDocs,
   addonA11yParameters,
   removeDocsAutodocs,
-];
+] satisfies Fix[];
 
-export const initFixes: Fix[] = [eslintPlugin];
+export type FixesIDs<F extends Fix[]> = F[number]['id'];
+
+export const initFixes = [eslintPlugin] satisfies Fix[];
 
 // These are specific fixes that only occur when triggered on command, and are hidden otherwise.
 // e.g. npx storybook automigrate csf-factories
-export const commandFixes: CommandFix[] = [csfFactories];
+export const commandFixes = [csfFactories] satisfies CommandFix[];

code/lib/cli-storybook/src/automigrate/fixes/initial-globals.ts

@@ -19,7 +19,7 @@ interface Options {
 }
 
 /** Rename preview.js globals to initialGlobals */
-export const initialGlobals: Fix<Options> = {
+export const initialGlobals: Fix<Options, 'initial-globals'> = {
   id: 'initial-globals',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
   async check({ previewConfigPath }) {

code/lib/cli-storybook/src/automigrate/fixes/remove-addon-interactions.ts

@@ -6,7 +6,7 @@ import { dedent } from 'ts-dedent';
 import type { Fix } from '../types';
 
 /** Remove @storybook/addon-interactions since it's now part of Storybook core. */
-export const removeAddonInteractions: Fix<{}> = {
+export const removeAddonInteractions: Fix<{}, 'removeAddonInteractions'> = {
   id: 'removeAddonInteractions',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
 

code/lib/cli-storybook/src/automigrate/fixes/remove-docs-autodocs.ts

@@ -22,7 +22,7 @@ interface RemoveDocsAutodocsOptions {
  * Migration to remove the docs.autodocs field from main.ts config This field was deprecated in
  * Storybook 7-8 and removed in Storybook 9
  */
-export const removeDocsAutodocs: Fix<RemoveDocsAutodocsOptions> = {
+export const removeDocsAutodocs: Fix<RemoveDocsAutodocsOptions, 'remove-docs-autodocs'> = {
   id: 'remove-docs-autodocs',
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],
 

code/lib/cli-storybook/src/automigrate/fixes/renderer-to-framework.ts

@@ -138,7 +138,7 @@ const checkPackageJson = async (
   return { frameworks, renderers };
 };
 
-export const rendererToFramework: Fix<MigrationResult> = {
+export const rendererToFramework: Fix<MigrationResult, 'renderer-to-framework'> = {
   id: 'renderer-to-framework',
   versionRange: ['<9.0.0', '^9.0.0-0'],
   promptType: 'auto',

code/lib/cli-storybook/src/automigrate/fixes/rnstorybook-config.ts

@@ -35,7 +35,7 @@ const getDotStorybookReferences = async () => {
   }
 };
 
-export const rnstorybookConfig: Fix<Options> = {
+export const rnstorybookConfig: Fix<Options, 'rnstorybook-config'> = {
   id: 'rnstorybook-config',
 
   versionRange: ['<9.0.0', '^9.0.0-0 || ^9.0.0'],

code/lib/cli-storybook/src/automigrate/fixes/upgrade-storybook-related-dependencies.ts

@@ -40,7 +40,10 @@ async function getLatestVersions(
  *
  * See: https://github.com/storybookjs/storybook/issues/25731#issuecomment-1977346398
  */
-export const upgradeStorybookRelatedDependencies = {
+export const upgradeStorybookRelatedDependencies: Fix<
+  Options,
+  'upgradeStorybookRelatedDependencies'
+> = {
   id: 'upgradeStorybookRelatedDependencies',
   versionRange: ['*.*.*', '*.*.*'],
   promptType: 'auto',
@@ -149,4 +152,4 @@ export const upgradeStorybookRelatedDependencies = {
     }
     console.log();
   },
-} satisfies Fix<Options>;
+};

code/lib/cli-storybook/src/automigrate/fixes/wrap-require.ts

@@ -21,7 +21,7 @@ interface WrapRequireRunOptions {
   isConfigTypescript: boolean;
 }
 
-export const wrapRequire: Fix<WrapRequireRunOptions> = {
+export const wrapRequire: Fix<WrapRequireRunOptions, 'wrap-require'> = {
   id: 'wrap-require',
 
   versionRange: ['*', '*'],

code/lib/cli-storybook/src/automigrate/types.ts

@@ -34,8 +34,8 @@ export interface RunOptions<ResultType> {
  */
 export type Prompt = 'auto' | 'manual' | 'notification' | 'command';
 
-type BaseFix<ResultType = any> = {
-  id: string;
+type BaseFix<ResultType, Key extends string> = {
+  id: Key;
   /**
    * The from/to version range of Storybook that this fix applies to. The strings are semver ranges.
    * The versionRange will only be checked if the automigration is part of an upgrade. If the
@@ -52,20 +52,20 @@ type PromptType<ResultType = any, T = Prompt> =
   | T
   | ((result: ResultType) => Promise<Prompt> | Prompt);
 
-export type Fix<ResultType = any> =
+export type Fix<ResultType, Key extends string> =
   | ({
       promptType?: PromptType<ResultType, 'auto'>;
       run: (options: RunOptions<ResultType>) => Promise<void>;
-    } & BaseFix<ResultType>)
+    } & BaseFix<ResultType, Key>)
   | ({
       promptType: PromptType<ResultType, 'manual' | 'notification'>;
       run?: never;
-    } & BaseFix<ResultType>);
+    } & BaseFix<ResultType, Key>);
 
-export type CommandFix<ResultType = any> = {
+export type CommandFix<ResultType = any, Key extends string = string> = {
   promptType: PromptType<ResultType, 'command'>;
   run: (options: RunOptions<ResultType>) => Promise<void>;
-} & Omit<BaseFix<ResultType>, 'versionRange' | 'check' | 'prompt'>;
+} & Omit<BaseFix<ResultType, Key>, 'versionRange' | 'check' | 'prompt'>;
 
 export type FixId = string;