@storybook/cli 7.0.0-alpha.2 → 7.0.0-alpha.20

package/dist/esm/automigrate/fixes/mainjsFramework.js

@@ -1,60 +1,42 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mainjsFramework = void 0;
-
-require("core-js/modules/es.promise.js");
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-var _semver = _interopRequireDefault(require("@storybook/semver"));
-
-var _csfTools = require("@storybook/csf-tools");
-
-var _coreCommon = require("@storybook/core-common");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+import chalk from 'chalk';
+import { dedent } from 'ts-dedent';
+import semver from '@storybook/semver';
+import { readConfig, writeConfig } from '@storybook/csf-tools';
+import { getStorybookInfo } from '@storybook/core-common';
 const logger = console;
-const mainjsFramework = {
+export const mainjsFramework = {
   id: 'mainjsFramework',
 
   async check({
     packageManager
   }) {
-    var _semver$coerce;
-
     const packageJson = packageManager.retrievePackageJson();
     const {
       mainConfig,
       framework,
       version: storybookVersion
-    } = (0, _coreCommon.getStorybookInfo)(packageJson);
+    } = getStorybookInfo(packageJson);
 
     if (!mainConfig) {
       logger.warn('Unable to find storybook main.js config, skipping');
       return null;
     }
 
-    const storybookCoerced = storybookVersion && ((_semver$coerce = _semver.default.coerce(storybookVersion)) === null || _semver$coerce === void 0 ? void 0 : _semver$coerce.version);
+    const storybookCoerced = storybookVersion && semver.coerce(storybookVersion)?.version;
 
     if (!storybookCoerced) {
-      logger.warn((0, _tsDedent.default)`
-        ❌ Unable to determine storybook version, skipping ${_chalk.default.cyan('mainjsFramework')} fix.
+      logger.warn(dedent`
+        ❌ Unable to determine storybook version, skipping ${chalk.cyan('mainjsFramework')} fix.
         🤔 Are you running automigrate from your project directory?
       `);
       return null;
     }
 
-    const main = await (0, _csfTools.readConfig)(mainConfig);
+    const main = await readConfig(mainConfig);
     const currentFramework = main.getFieldValue(['framework']);
     const features = main.getFieldValue(['features']);
     if (currentFramework) return null;
-    return features !== null && features !== void 0 && features.breakingChangesV7 || features !== null && features !== void 0 && features.storyStoreV7 || _semver.default.gte(storybookCoerced, '7.0.0') ? {
+    return features?.breakingChangesV7 || features?.storyStoreV7 || semver.gte(storybookCoerced, '7.0.0') ? {
       main,
       framework: `@storybook/${framework}`
     } : null;
@@ -63,16 +45,15 @@ const mainjsFramework = {
   prompt({
     framework
   }) {
-    const frameworkFormatted = _chalk.default.cyan(`framework: '${framework}'`);
-
-    return (0, _tsDedent.default)`
+    const frameworkFormatted = chalk.cyan(`framework: '${framework}'`);
+    return dedent`
       We've detected that your main.js configuration file does not specify the
       'framework' field, which is a requirement in SB7.0 and above. We can add one
       for you automatically:
 
       ${frameworkFormatted}
 
-      More info: ${_chalk.default.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mainjs-framework-field')}
+      More info: ${chalk.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mainjs-framework-field')}
     `;
   },
 
@@ -87,9 +68,8 @@ const mainjsFramework = {
 
     if (!dryRun) {
       main.setFieldValue(['framework'], framework);
-      await (0, _csfTools.writeConfig)(main);
+      await writeConfig(main);
     }
   }
 
-};
-exports.mainjsFramework = mainjsFramework;
+};

package/dist/esm/automigrate/fixes/new-frameworks.js

@@ -0,0 +1,225 @@
+import chalk from 'chalk';
+import dedent from 'ts-dedent';
+import semver from '@storybook/semver';
+import { readConfig, writeConfig } from '@storybook/csf-tools';
+import { getStorybookInfo } from '@storybook/core-common';
+import { getStorybookVersionSpecifier } from '../../helpers';
+const logger = console;
+const packagesMap = {
+  '@storybook/react': {
+    webpack5: '@storybook/react-webpack5',
+    vite: '@storybook/react-vite'
+  },
+  '@storybook/preact': {
+    webpack5: '@storybook/preact-webpack5'
+  },
+  '@storybook/server': {
+    webpack5: '@storybook/server-webpack5'
+  },
+  '@storybook/angular': {
+    webpack5: '@storybook/angular'
+  },
+  '@storybook/vue': {
+    webpack5: '@storybook/vue-webpack5',
+    vite: '@storybook/vue-vite'
+  },
+  '@storybook/vue3': {
+    webpack5: '@storybook/vue3-webpack5',
+    vite: '@storybook/vue3-vite'
+  },
+  '@storybook/svelte': {
+    webpack5: '@storybook/svelte-webpack5',
+    vite: '@storybook/svelte-vite'
+  },
+  '@storybook/web-components': {
+    webpack5: '@storybook/web-components-webpack5'
+  },
+  '@storybook/html': {
+    webpack5: '@storybook/html-webpack5'
+  }
+};
+export const getBuilder = builder => {
+  if (typeof builder === 'string') {
+    return builder.includes('vite') ? 'vite' : 'webpack5';
+  }
+
+  return builder?.name.includes('vite') ? 'vite' : 'webpack5';
+};
+export const getFrameworkOptions = (framework, main) => {
+  const frameworkOptions = main.getFieldValue([`${framework}Options`]);
+  return frameworkOptions || {};
+};
+/**
+ * Does the user have separate framework and builders (e.g. @storybook/react + core.builder -> webpack5?
+ *
+ * If so:
+ * - Remove the dependencies (@storybook/react + @storybook/builder-webpack5 + @storybook/manager-webpack5)
+ * - Install the correct new package e.g. (@storybook/react-webpack5)
+ * - Update the main config to use the new framework
+ * -- moving core.builder into framework.options.builder
+ * -- moving frameworkOptions (e.g. reactOptions) into framework.options
+ */
+
+export const newFrameworks = {
+  id: 'newFrameworks',
+
+  async check({
+    packageManager
+  }) {
+    const packageJson = packageManager.retrievePackageJson();
+    const allDeps = Object.assign({}, packageJson.dependencies, packageJson.devDependencies);
+    const config = getStorybookInfo(packageJson);
+    const {
+      mainConfig,
+      version: storybookVersion,
+      framework
+    } = config;
+
+    if (!mainConfig) {
+      logger.warn('Unable to find storybook main.js config, skipping');
+      return null;
+    }
+
+    const storybookCoerced = storybookVersion && semver.coerce(storybookVersion)?.version;
+
+    if (!storybookCoerced) {
+      logger.warn(dedent`
+        ❌ Unable to determine storybook version, skipping ${chalk.cyan('newFrameworks')} fix.
+        🤔 Are you running automigrate from your project directory?
+      `);
+      return null;
+    }
+
+    if (!semver.gte(storybookCoerced, '7.0.0')) {
+      return null;
+    } // If in the future the eslint plugin has a framework option, using main to extract the framework field will be very useful
+
+
+    const main = await readConfig(mainConfig);
+    const frameworkPackage = main.getFieldValue(['framework']);
+    const builder = main.getFieldValue(['core', 'builder']);
+
+    if (!frameworkPackage) {
+      return null;
+    }
+
+    const supportedPackages = Object.keys(packagesMap);
+
+    if (!supportedPackages.includes(frameworkPackage)) {
+      return null;
+    }
+
+    const builderInfo = {
+      name: getBuilder(builder),
+      options: main.getFieldValue(['core', 'builder', 'options']) || {}
+    }; // TODO: once we have vite frameworks e.g. @storybook/react-vite, then we support it here
+    // and remove ['storybook-builder-vite', '@storybook/builder-vite'] from deps
+
+    if (builderInfo.name === 'vite') {
+      return null;
+    }
+
+    const frameworkOptions = getFrameworkOptions(framework, main);
+    const dependenciesToRemove = ['@storybook/builder-webpack5', '@storybook/manager-webpack5', '@storybook/builder-webpack4', '@storybook/manager-webpack4'].filter(dep => allDeps[dep]);
+    const newFrameworkPackage = packagesMap[frameworkPackage][builderInfo.name];
+    const dependenciesToAdd = []; // some frameworks didn't change e.g. Angular, Ember
+
+    if (newFrameworkPackage !== frameworkPackage) {
+      dependenciesToRemove.push(frameworkPackage);
+      dependenciesToAdd.push(newFrameworkPackage);
+    }
+
+    return {
+      main,
+      dependenciesToAdd,
+      dependenciesToRemove,
+      frameworkPackage: newFrameworkPackage,
+      frameworkOptions,
+      builderInfo,
+      packageJson
+    };
+  },
+
+  prompt() {
+    return dedent`
+      We've detected you are using an older format of Storybook frameworks and builders.
+
+      In Storybook 7, frameworks also specify the builder to be used.
+
+      We can remove the dependencies that are no longer needed and install the new framework that already includes the builder.
+
+      To learn more about the framework field, see: ${chalk.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#framework-field-mandatory')}
+
+      ${chalk.underline(chalk.bold(chalk.cyan('Webpack4 users')))}
+
+      Unless you're using Storybook's Vite builder, this automigration will install a Webpack5-based framework.
+      
+      If you were using Storybook's Webpack4 builder (default in 6.x, discontinued in 7.0), this could be a breaking
+      change--especially if your project has a custom webpack configuration.
+      
+      To learn more about migrating from Webpack4, see: ${chalk.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack4-support-discontinued')}
+    `;
+  },
+
+  async run({
+    result: {
+      dependenciesToAdd,
+      dependenciesToRemove,
+      main,
+      frameworkPackage,
+      frameworkOptions,
+      builderInfo,
+      packageJson
+    },
+    packageManager,
+    dryRun
+  }) {
+    logger.info(`✅ Removing legacy dependencies: ${dependenciesToRemove.join(', ')}`);
+
+    if (!dryRun) {
+      packageManager.removeDependencies({
+        skipInstall: dependenciesToAdd.length > 0,
+        packageJson
+      }, dependenciesToRemove);
+    }
+
+    if (dependenciesToAdd.length > 0) {
+      logger.info(`✅ Installing new dependencies: ${dependenciesToAdd.join(', ')}`);
+
+      if (!dryRun) {
+        const versionToInstall = getStorybookVersionSpecifier(packageJson);
+        const depsToAdd = dependenciesToAdd.map(dep => `${dep}@${versionToInstall}`);
+        packageManager.addDependencies({
+          installAsDevDependencies: true
+        }, depsToAdd);
+      }
+    }
+
+    if (!dryRun) {
+      logger.info(`✅ Updating framework field in main.js`);
+      const currentCore = main.getFieldValue(['core']);
+      main.setFieldValue(['framework', 'name'], frameworkPackage);
+      main.setFieldValue(['framework', 'options'], frameworkOptions);
+
+      if (currentCore?.builder) {
+        delete currentCore.builder;
+      }
+
+      if (Object.keys(builderInfo.options).length > 0) {
+        main.setFieldValue(['framework', 'options', 'builder'], builderInfo.options);
+      }
+
+      if (currentCore) {
+        if (Object.keys(currentCore).length === 0) {
+          // TODO: this should delete the field instead
+          main.setFieldValue(['core'], {});
+        } else {
+          main.setFieldValue(['core'], currentCore);
+        }
+      }
+
+      await writeConfig(main);
+    }
+  }
+
+};

package/dist/esm/automigrate/fixes/npm7.js

@@ -0,0 +1,45 @@
+import chalk from 'chalk';
+import { dedent } from 'ts-dedent';
+
+/**
+ * Is the user using npm7+? If so create a .npmrc with legacy-peer-deps=true
+ */
+export const npm7 = {
+  id: 'npm7',
+
+  async check({
+    packageManager
+  }) {
+    if (packageManager.type !== 'npm') return null;
+    const npmVersion = packageManager.getNpmVersion();
+
+    if (packageManager.needsLegacyPeerDeps(npmVersion)) {
+      return {
+        npmVersion
+      };
+    }
+
+    return null;
+  },
+
+  prompt({
+    npmVersion
+  }) {
+    const npmFormatted = chalk.cyan(`npm ${npmVersion}`);
+    return dedent`
+      We've detected you are running ${npmFormatted} which has peer dependency semantics which Storybook is incompatible with.
+
+      In order to work with Storybook's package structure, you'll need to run \`npm\` with the
+      \`--legacy-peer-deps=true\` flag. We can generate an \`.npmrc\` which will do that automatically.
+      
+      More info: ${chalk.yellow('https://github.com/storybookjs/storybook/issues/18298')}
+    `;
+  },
+
+  async run({
+    packageManager
+  }) {
+    packageManager.setLegacyPeerDeps();
+  }
+
+};

package/dist/esm/automigrate/fixes/sb-scripts.js

@@ -0,0 +1,119 @@
+import chalk from 'chalk';
+import { dedent } from 'ts-dedent';
+import semver from '@storybook/semver';
+import { getStorybookInfo } from '@storybook/core-common';
+import { getStorybookVersionSpecifier } from '../../helpers';
+const logger = console;
+export const getStorybookScripts = scripts => {
+  const storybookScripts = {
+    custom: {},
+    official: {}
+  };
+  Object.keys(scripts).forEach(key => {
+    if (key === 'storybook' || key === 'build-storybook') {
+      storybookScripts.official[key] = scripts[key];
+    } else if (scripts[key].match(/start-storybook/) || scripts[key].match(/build-storybook/)) {
+      storybookScripts.custom[key] = scripts[key];
+    }
+  });
+  return storybookScripts;
+};
+/**
+ * Is the user using start-storybook
+ *
+ * If so:
+ * - Add storybook dependency
+ * - Change start-storybook and build-storybook scripts
+ */
+
+export const sbScripts = {
+  id: 'sb-scripts',
+
+  async check({
+    packageManager
+  }) {
+    const packageJson = packageManager.retrievePackageJson();
+    const {
+      scripts = {},
+      devDependencies,
+      dependencies
+    } = packageJson;
+    const {
+      version: storybookVersion
+    } = getStorybookInfo(packageJson);
+    const allDeps = Object.assign({}, dependencies, devDependencies);
+    const storybookCoerced = storybookVersion && semver.coerce(storybookVersion)?.version;
+
+    if (!storybookCoerced) {
+      logger.warn(dedent`
+        ❌ Unable to determine storybook version, skipping ${chalk.cyan('sb-scripts')} fix.
+        🤔 Are you running automigrate from your project directory?
+      `);
+      return null;
+    }
+
+    if (allDeps.sb || allDeps.storybook) {
+      return null;
+    }
+
+    const storybookScripts = getStorybookScripts(scripts);
+
+    if (Object.keys(storybookScripts.official).length === 0 && Object.keys(storybookScripts.custom).length === 0) {
+      return null;
+    }
+
+    Object.keys(storybookScripts.official).forEach(key => {
+      storybookScripts.official[key] = storybookScripts.official[key].replace('start-storybook', 'storybook dev').replace('build-storybook', 'storybook build');
+    });
+    return semver.gte(storybookCoerced, '7.0.0') ? {
+      packageJson,
+      storybookScripts,
+      storybookVersion
+    } : null;
+  },
+
+  prompt({
+    storybookVersion
+  }) {
+    const sbFormatted = chalk.cyan(`Storybook ${storybookVersion}`);
+    const explanationMessage = [`Starting in Storybook 7, the ${chalk.yellow('start-storybook')} and ${chalk.yellow('build-storybook')} binaries have changed to ${chalk.magenta('storybook dev')} and ${chalk.magenta('storybook build')} respectively.`, `In order to work with ${sbFormatted}, Storybook's ${chalk.magenta('storybook')} binary has to be installed and your storybook scripts have to be adjusted to use the binary. We can install the storybook binary and attempt to adjust your scripts for you.`].join('\n');
+    return [`We've detected you are using ${sbFormatted} with scripts from previous versions of Storybook.`, explanationMessage, `More info: ${chalk.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed')}`].filter(Boolean).join('\n\n');
+  },
+
+  async run({
+    result: {
+      storybookScripts,
+      packageJson
+    },
+    packageManager,
+    dryRun
+  }) {
+    logger.log();
+    logger.info(`Adding 'storybook' as dev dependency`);
+    logger.log();
+
+    if (!dryRun) {
+      const versionToInstall = getStorybookVersionSpecifier(packageJson);
+      packageManager.addDependencies({
+        installAsDevDependencies: true
+      }, [`storybook@${versionToInstall}`]);
+    }
+
+    logger.info(`Updating scripts in package.json`);
+    logger.log();
+
+    if (!dryRun && Object.keys(storybookScripts.official).length > 0) {
+      const message = [`Migrating your scripts to:`, chalk.yellow(JSON.stringify(storybookScripts.official, null, 2))].join('\n');
+      logger.log(message);
+      logger.log();
+      packageManager.addScripts(storybookScripts.official);
+    }
+
+    if (!dryRun && Object.keys(storybookScripts.custom).length > 0) {
+      const message = [`We detected custom scripts that we can't automigrate:`, chalk.yellow(JSON.stringify(storybookScripts.custom, null, 2)), '\n', `Please manually migrate the ones applicable and use the documentation below for reference: ${chalk.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed')}`].join('\n');
+      logger.log(message);
+      logger.log();
+    }
+  }
+
+};

package/dist/esm/automigrate/fixes/vue3.js

@@ -1,21 +1,7 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.vue3 = void 0;
-
-require("core-js/modules/es.promise.js");
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-var _semver = _interopRequireDefault(require("@storybook/semver"));
-
-var _webpack = require("./webpack5");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+import chalk from 'chalk';
+import { dedent } from 'ts-dedent';
+import semver from '@storybook/semver';
+import { webpack5 } from './webpack5';
 
 /**
  * Is the user upgrading to Vue3?
@@ -23,27 +9,25 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * If so:
  * - Run webpack5 fix
  */
-const vue3 = {
+export const vue3 = {
   id: 'vue3',
 
   async check({
     packageManager
   }) {
-    var _semver$coerce;
-
     const packageJson = packageManager.retrievePackageJson();
     const {
       dependencies,
       devDependencies
     } = packageJson;
     const vueVersion = dependencies.vue || devDependencies.vue;
-    const vueCoerced = (_semver$coerce = _semver.default.coerce(vueVersion)) === null || _semver$coerce === void 0 ? void 0 : _semver$coerce.version;
+    const vueCoerced = semver.coerce(vueVersion)?.version;
 
-    if (!vueCoerced || _semver.default.lt(vueCoerced, '3.0.0')) {
+    if (!vueCoerced || semver.lt(vueCoerced, '3.0.0')) {
       return null;
     }
 
-    const builderInfo = await _webpack.webpack5.checkWebpack5Builder(packageJson);
+    const builderInfo = await webpack5.checkWebpack5Builder(packageJson);
     return builderInfo ? Object.assign({
       vueVersion
     }, builderInfo) : null;
@@ -53,27 +37,24 @@ const vue3 = {
     vueVersion,
     storybookVersion
   }) {
-    const vueFormatted = _chalk.default.cyan(`Vue ${vueVersion}`);
-
-    const sbFormatted = _chalk.default.cyan(`Storybook ${storybookVersion}`);
-
-    return (0, _tsDedent.default)`
+    const vueFormatted = chalk.cyan(`Vue ${vueVersion}`);
+    const sbFormatted = chalk.cyan(`Storybook ${storybookVersion}`);
+    return dedent`
       We've detected you are running ${vueFormatted} with Storybook.
       ${sbFormatted} runs webpack4 by default, which is incompatible.
 
-      In order to work with your version of Vue, we need to install Storybook's ${_chalk.default.cyan('webpack5 builder')}.
+      In order to work with your version of Vue, we need to install Storybook's ${chalk.cyan('webpack5 builder')}.
 
-      More info: ${_chalk.default.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vue3-upgrade')}
+      More info: ${chalk.yellow('https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vue3-upgrade')}
     `;
   },
 
   async run(options) {
-    return _webpack.webpack5.run(Object.assign({}, options, {
+    return webpack5.run(Object.assign({}, options, {
       result: Object.assign({
         webpackVersion: null
       }, options.result)
     }));
   }
 
-};
-exports.vue3 = vue3;
+};