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

package/dist/esm/repro-generators/configs.js

@@ -1,33 +1,24 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.web_components_typescript = exports.web_components_lit2 = exports.web_components = exports.vue3 = exports.vue = exports.svelte = exports.sfcVue = exports.react_typescript = exports.react_legacy_root_api = exports.react_in_yarn_workspace = exports.react = exports.preact = exports.html = exports.cra_typescript = exports.cra = exports.angular_modern_inline_rendering = exports.angular130 = exports.angular13 = exports.angular12 = exports.angular = void 0;
-
 /* eslint-disable camelcase */
 const fromDeps = (...args) => ['mkdir {{appName}}', 'cd {{appName}}', // Create `yarn.lock` to force Yarn to consider adding deps in this directory
 // and not look for a yarn workspace in parent directory
 'touch yarn.lock', 'yarn init --yes', args.length && `yarn add ${args.join(' ')}`].filter(Boolean).join(' && '); // #region  React
 
 
-const cra = {
+export const cra = {
   renderer: 'react',
   name: 'cra',
   version: 'latest',
   generator: [// Force npm otherwise we have a mess between Yarn 1, Yarn 2 and NPM
   'npm_config_user_agent=npm npx -p create-react-app@{{version}} create-react-app {{appName}}', 'cd {{appName}}', 'echo "FAST_REFRESH=true" > .env', 'echo "SKIP_PREFLIGHT_CHECK=true" > .env'].join(' && ')
 };
-exports.cra = cra;
-const cra_typescript = {
+export const cra_typescript = {
   renderer: 'react',
   name: 'cra_typescript',
   version: 'latest',
   generator: [// Force npm otherwise we have a mess between Yarn 1, Yarn 2 and NPM
   'npm_config_user_agent=npm npx -p create-react-app@{{version}} create-react-app {{appName}} --template typescript'].join(' && ')
 };
-exports.cra_typescript = cra_typescript;
-const react = {
+export const react = {
   renderer: 'react',
   name: 'react',
   version: 'latest',
@@ -38,8 +29,7 @@ const react = {
     contents: '{ "presets": ["@babel/preset-react"] }'
   }]
 };
-exports.react = react;
-const react_legacy_root_api = {
+export const react_legacy_root_api = {
   renderer: 'react',
   name: 'react_legacy_root_api',
   version: 'latest',
@@ -55,8 +45,7 @@ const react_legacy_root_api = {
     }
   }
 };
-exports.react_legacy_root_api = react_legacy_root_api;
-const react_typescript = {
+export const react_typescript = {
   renderer: 'react',
   name: 'react_typescript',
   version: 'latest',
@@ -74,8 +63,7 @@ const react_typescript = {
 //   generator: 'npx -p create-vite@{{version}} create-vite {{appName}} --template react-ts',
 // };
 
-exports.react_typescript = react_typescript;
-const react_in_yarn_workspace = {
+export const react_in_yarn_workspace = {
   renderer: 'react',
   name: 'react_in_yarn_workspace',
   version: 'latest',
@@ -83,29 +71,25 @@ const react_in_yarn_workspace = {
 }; // #endregion
 // #region Angular
 
-exports.react_in_yarn_workspace = react_in_yarn_workspace;
 const baseAngular = {
   renderer: 'angular',
   name: 'angular',
   version: 'latest',
   generator: `npx -p @angular/cli@{{version}} ng new {{appName}} --routing=true --minimal=true --style=scss --skip-install=true --strict`
 };
-const angular12 = Object.assign({}, baseAngular, {
+export const angular12 = Object.assign({}, baseAngular, {
   name: 'angular12',
   version: 'v12-lts'
 });
-exports.angular12 = angular12;
-const angular130 = Object.assign({}, baseAngular, {
+export const angular130 = Object.assign({}, baseAngular, {
   name: 'angular130',
   version: '13.0.x'
 });
-exports.angular130 = angular130;
-const angular13 = Object.assign({}, baseAngular, {
+export const angular13 = Object.assign({}, baseAngular, {
   name: 'angular13',
   version: '13.1.x'
 });
-exports.angular13 = angular13;
-const angular_modern_inline_rendering = Object.assign({}, baseAngular, {
+export const angular_modern_inline_rendering = Object.assign({}, baseAngular, {
   name: 'angular_modern_inline_rendering',
   additionalDeps: ['jest@27', '@storybook/test-runner'],
   mainOverrides: {
@@ -114,19 +98,16 @@ const angular_modern_inline_rendering = Object.assign({}, baseAngular, {
     }
   }
 });
-exports.angular_modern_inline_rendering = angular_modern_inline_rendering;
-const angular = baseAngular; // #endregion
+export const angular = baseAngular; // #endregion
 // #region  web components
 
-exports.angular = angular;
-const web_components = {
+export const web_components = {
   renderer: 'web-components',
   name: 'web_components',
   version: '2',
   generator: fromDeps('lit-element')
 };
-exports.web_components = web_components;
-const web_components_typescript = Object.assign({}, web_components, {
+export const web_components_typescript = Object.assign({}, web_components, {
   name: 'web_components_typescript',
   typescript: true,
   additionalDeps: ['@babel/preset-typescript'],
@@ -135,8 +116,7 @@ const web_components_typescript = Object.assign({}, web_components, {
     contents: '{ "presets": ["@babel/preset-typescript"] }'
   }]
 });
-exports.web_components_typescript = web_components_typescript;
-const web_components_lit2 = Object.assign({}, web_components, {
+export const web_components_lit2 = Object.assign({}, web_components, {
   version: 'next',
   name: 'web_components_lit2',
   generator: fromDeps('lit'),
@@ -149,8 +129,7 @@ const web_components_lit2 = Object.assign({}, web_components, {
 }); // #endregion
 // #region  vue
 
-exports.web_components_lit2 = web_components_lit2;
-const vue = {
+export const vue = {
   renderer: 'vue',
   name: 'vue',
   // Be careful here, the latest versions of vue cli are bootstrapping a vue 3  project
@@ -158,8 +137,7 @@ const vue = {
   generator: [// Force npm otherwise we have a mess between Yarn 1 and Yarn 2
   `npx -p @vue/cli@{{version}} vue create {{appName}} --default --packageManager=npm --no-git --force`].join(' && ')
 };
-exports.vue = vue;
-const vue3 = {
+export const vue3 = {
   renderer: 'vue3',
   name: 'vue3',
   version: 'next',
@@ -168,34 +146,29 @@ const vue3 = {
   `npx -p @vue/cli@^4 vue create {{appName}} --preset=__default_vue_3__ --packageManager=npm --no-git --force`].join(' && ')
 }; // #endregion
 
-exports.vue3 = vue3;
-const html = {
+export const html = {
   renderer: 'html',
   name: 'html',
   version: 'latest',
   generator: fromDeps(),
   autoDetect: false
 };
-exports.html = html;
-const preact = {
+export const preact = {
   renderer: 'preact',
   name: 'preact',
   version: 'latest',
   generator: 'npx preact-cli@{{version}} create preactjs-templates/default {{appName}} --install=false --git=false'
 };
-exports.preact = preact;
-const sfcVue = {
+export const sfcVue = {
   renderer: 'vue',
   name: 'sfcVue',
   version: 'latest',
   //
   generator: fromDeps('vue@2.6', 'vue-loader@15.9', 'vue-template-compiler@2.6', 'webpack')
 };
-exports.sfcVue = sfcVue;
-const svelte = {
+export const svelte = {
   renderer: 'svelte',
   name: 'svelte',
   version: 'latest',
   generator: 'npx degit sveltejs/template {{appName}}'
-};
-exports.svelte = svelte;
+};

package/dist/esm/repro-generators/scripts.js

@@ -1,41 +1,26 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.exec = exports.createAndInit = void 0;
-
-require("core-js/modules/es.promise.js");
-
-var _path = _interopRequireDefault(require("path"));
-
-var _fsExtra = require("fs-extra");
-
-var _shelljs = _interopRequireDefault(require("shelljs"));
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _execa = require("execa");
-
-var _configs = require("./configs");
-
-var _versions = _interopRequireDefault(require("../versions"));
-
 const _excluded = ["name", "version"];
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 
+/* eslint-disable camelcase */
+import path from 'path';
+import { readJSON, writeJSON, outputFile } from 'fs-extra';
+import shell from 'shelljs';
+import chalk from 'chalk';
+import { command } from 'execa';
+import { cra, cra_typescript } from './configs';
+import storybookVersions from '../versions';
 const logger = console;
-const useLocalSbCli = true;
-
-const exec = async (command, options = {}, {
+export const exec = async (command, options = {}, {
   startMessage,
-  errorMessage
+  errorMessage,
+  dryRun
 } = {}) => {
-  if (startMessage) {
-    logger.info(startMessage);
+  if (startMessage) logger.info(startMessage);
+
+  if (dryRun) {
+    logger.info(`\n> ${command}\n`);
+    return undefined;
   }
 
   logger.debug(command);
@@ -43,19 +28,16 @@ const exec = async (command, options = {}, {
     const defaultOptions = {
       silent: false
     };
-
-    const child = _shelljs.default.exec(command, Object.assign({}, defaultOptions, options, {
+    const child = shell.exec(command, Object.assign({}, defaultOptions, options, {
       async: true,
       silent: false
     }));
-
     child.stderr.pipe(process.stderr);
-    child.stdout.pipe(process.stdout);
     child.on('exit', code => {
       if (code === 0) {
         resolve(undefined);
       } else {
-        logger.error(_chalk.default.red(`An error occurred while executing: \`${command}\``));
+        logger.error(chalk.red(`An error occurred while executing: \`${command}\``));
         logger.log(errorMessage);
         reject(new Error(`command exited with code: ${code}: `));
       }
@@ -63,18 +45,14 @@ const exec = async (command, options = {}, {
   });
 };
 
-exports.exec = exec;
-
 const addPackageResolutions = async ({
   cwd
 }) => {
   logger.info(`🔢 Adding package resolutions:`);
-
-  const packageJsonPath = _path.default.join(cwd, 'package.json');
-
-  const packageJson = await (0, _fsExtra.readJSON)(packageJsonPath);
-  packageJson.resolutions = _versions.default;
-  await (0, _fsExtra.writeJSON)(packageJsonPath, packageJson, {
+  const packageJsonPath = path.join(cwd, 'package.json');
+  const packageJson = await readJSON(packageJsonPath);
+  packageJson.resolutions = storybookVersions;
+  await writeJSON(packageJsonPath, packageJson, {
     spaces: 2
   });
 };
@@ -83,16 +61,12 @@ const addLocalPackageResolutions = async ({
   cwd
 }) => {
   logger.info(`🔢 Adding package resolutions:`);
-
-  const packageJsonPath = _path.default.join(cwd, 'package.json');
-
-  const packageJson = await (0, _fsExtra.readJSON)(packageJsonPath);
-
-  const workspaceDir = _path.default.join(__dirname, '..', '..', '..', '..', '..');
-
+  const packageJsonPath = path.join(cwd, 'package.json');
+  const packageJson = await readJSON(packageJsonPath);
+  const workspaceDir = path.join(__dirname, '..', '..', '..', '..', '..');
   const {
     stdout
-  } = await (0, _execa.command)('yarn workspaces list --json', {
+  } = await command('yarn workspaces list --json', {
     cwd: workspaceDir
   });
   console.log({
@@ -103,12 +77,12 @@ const addLocalPackageResolutions = async ({
   console.log({
     workspaces
   });
-  packageJson.resolutions = Object.keys(_versions.default).reduce((acc, key) => {
+  packageJson.resolutions = Object.keys(storybookVersions).reduce((acc, key) => {
     return Object.assign({}, acc, {
-      [key]: _path.default.join(workspaceDir, workspaces.find(item => item.name === key).location)
+      [key]: path.join(workspaceDir, workspaces.find(item => item.name === key).location)
     });
   }, {});
-  await (0, _fsExtra.writeJSON)(packageJsonPath, packageJson, {
+  await writeJSON(packageJsonPath, packageJson, {
     spaces: 2
   });
 };
@@ -122,7 +96,7 @@ const installYarn2 = async ({
   // Next line is a hack to remove as soon as CRA will have added these missing deps
   // for details see https://github.com/facebook/create-react-app/pull/11751
 
-  if ([_configs.cra.name, _configs.cra_typescript.name].includes(name)) {
+  if ([cra.name, cra_typescript.name].includes(name)) {
     command.push(`yarn config set packageExtensions --json '{ "babel-preset-react-app@10.0.x": { "dependencies": { "@babel/plugin-proposal-private-property-in-object": "^7.16.0" } } }'`);
   }
 
@@ -173,7 +147,7 @@ const addAdditionalFiles = async ({
 }) => {
   logger.info(`⤵️ Adding required files`);
   await Promise.all(additionalFiles.map(async file => {
-    await (0, _fsExtra.outputFile)(_path.default.resolve(cwd, file.path), file.contents, {
+    await outputFile(path.resolve(cwd, file.path), file.contents, {
       encoding: 'UTF-8'
     });
   }));
@@ -200,7 +174,7 @@ const initStorybook = async ({
     flags.push('--use-pnp');
   }
 
-  const sbCLICommand = useLocalSbCli ? `node ${_path.default.join(__dirname, '../../esm/generate')}` : `yarn dlx -p @storybook/cli sb`;
+  const sbCLICommand = `node ${path.join(__dirname, '../../cjs/generate')}`;
   const command = `${sbCLICommand} init ${flags.join(' ')}`;
   await exec(command, {
     cwd
@@ -215,8 +189,7 @@ const addRequiredDeps = async ({
   additionalDeps
 }) => {
   // Remove any lockfile generated without Yarn 2
-  _shelljs.default.rm('-f', _path.default.join(cwd, 'package-lock.json'), _path.default.join(cwd, 'yarn.lock'));
-
+  shell.rm('-f', path.join(cwd, 'package-lock.json'), path.join(cwd, 'yarn.lock'));
   const command = additionalDeps && additionalDeps.length > 0 ? `yarn add -D ${additionalDeps.join(' ')}` : `yarn install`;
   await exec(command, {
     cwd
@@ -245,10 +218,8 @@ const addTypescript = async ({
       },
       include: ['src/*']
     };
-
-    const tsConfigJsonPath = _path.default.resolve(cwd, 'tsconfig.json');
-
-    await (0, _fsExtra.writeJSON)(tsConfigJsonPath, tsConfig, {
+    const tsConfigJsonPath = path.resolve(cwd, 'tsconfig.json');
+    await writeJSON(tsConfigJsonPath, tsConfig, {
       encoding: 'utf8',
       spaces: 2
     });
@@ -265,10 +236,25 @@ const doTask = async (task, options, condition = true) => {
   }
 };
 
-const createAndInit = async (cwd, _ref, {
+const registryUrlNPM = url => {
+  const args = ['config', 'set', 'registry', url];
+  return exec(`npm ${args.join(' ')}`, {
+    cwd: path.join(process.cwd(), '..')
+  });
+};
+
+const registryUrlYarn = url => {
+  const args = ['config', 'set', 'npmRegistryServer', url];
+  return exec(`yarn ${args.join(' ')}`, {
+    cwd: path.join(__dirname, '..')
+  });
+};
+
+export const createAndInit = async (cwd, _ref, {
   e2e,
   pnp,
-  local
+  local,
+  registry
 }) => {
   let {
     name,
@@ -279,8 +265,8 @@ const createAndInit = async (cwd, _ref, {
   const options = Object.assign({
     name,
     version,
-    appName: _path.default.basename(cwd),
-    creationPath: _path.default.join(cwd, '..'),
+    appName: path.basename(cwd),
+    creationPath: path.join(cwd, '..'),
     cwd,
     e2e,
     pnp
@@ -311,7 +297,11 @@ const createAndInit = async (cwd, _ref, {
 
   await doTask(addTypescript, options, !!options.typescript);
   await doTask(addRequiredDeps, options);
-  await doTask(initStorybook, options);
-};
 
-exports.createAndInit = createAndInit;
+  if (registry) {
+    await registryUrlNPM(registry);
+    await registryUrlYarn(registry);
+  }
+
+  await doTask(initStorybook, options);
+};

package/dist/esm/repro-next.js

@@ -0,0 +1,163 @@
+import prompts from 'prompts';
+import path from 'path';
+import chalk from 'chalk';
+import boxen from 'boxen';
+import { dedent } from 'ts-dedent';
+import degit from 'degit';
+import { existsSync } from 'fs-extra';
+import TEMPLATES from './repro-templates';
+const logger = console;
+
+const toChoices = c => ({
+  title: TEMPLATES[c].name,
+  value: c
+});
+
+export const reproNext = async ({
+  output: outputDirectory,
+  filterValue,
+  branch,
+  init
+}) => {
+  const keys = Object.keys(TEMPLATES); // get value from template and reduce through TEMPLATES to filter out the correct template
+
+  const choices = keys.reduce((acc, group) => {
+    const current = TEMPLATES[group];
+    const filterRegex = new RegExp(filterValue, 'i');
+
+    if (!filterValue) {
+      acc.push(group);
+      return acc;
+    }
+
+    if (current.name.match(filterRegex) || group.match(filterRegex) || current.expected.builder.match(filterRegex) || current.expected.framework.match(filterRegex) || current.expected.renderer.match(filterRegex)) {
+      acc.push(group);
+      return acc;
+    }
+
+    return acc;
+  }, []);
+
+  if (choices.length === 0) {
+    logger.info(boxen(dedent`
+          🔎 You filtered out all templates. 🔍
+          
+          After filtering all the templates with "${chalk.yellow(filterValue)}", we found no results. Please try again with a different filter.
+
+          Available templates:
+          ${keys.map(key => chalk.blue`- ${key}`).join('\n')}
+          `.trim(), {
+      borderStyle: 'round',
+      padding: 1,
+      borderColor: '#F1618C'
+    }));
+    process.exit(1);
+  }
+
+  let selectedTemplate = null;
+
+  if (choices.length === 1) {
+    [selectedTemplate] = choices;
+  } else {
+    logger.info(boxen(dedent`
+          🤗 Welcome to ${chalk.yellow('sb repro NEXT')}! 🤗 
+  
+          Create a ${chalk.green('new project')} to minimally reproduce Storybook issues.
+          
+          1. select an environment that most closely matches your project setup.
+          2. select a location for the reproduction, outside of your project.
+          
+          After the reproduction is ready, we'll guide you through the next steps.
+          `.trim(), {
+      borderStyle: 'round',
+      padding: 1,
+      borderColor: '#F1618C'
+    }));
+    selectedTemplate = await promptSelectedTemplate(choices);
+  }
+
+  const hasSelectedTemplate = !!(selectedTemplate ?? null);
+
+  if (!hasSelectedTemplate) {
+    logger.error('Somehow we got no templates. Please rerun this command!');
+    return;
+  }
+
+  const selectedConfig = TEMPLATES[selectedTemplate];
+
+  if (!selectedConfig) {
+    throw new Error('🚨 Repro: please specify a valid template type');
+  }
+
+  let selectedDirectory = outputDirectory;
+  const outputDirectoryName = outputDirectory || selectedTemplate;
+
+  if (selectedDirectory && existsSync(`${selectedDirectory}`)) {
+    logger.info(`⚠️  ${selectedDirectory} already exists! Overwriting...`);
+  }
+
+  if (!selectedDirectory) {
+    const {
+      directory
+    } = await prompts({
+      type: 'text',
+      message: 'Enter the output directory',
+      name: 'directory',
+      initial: outputDirectoryName,
+      validate: async directoryName => existsSync(directoryName) ? `${directoryName} already exists. Please choose another name.` : true
+    });
+    selectedDirectory = directory;
+  }
+
+  try {
+    const templateDestination = path.isAbsolute(selectedDirectory) ? selectedDirectory : path.join(process.cwd(), selectedDirectory);
+    logger.info(`🏃 Adding ${selectedConfig.name} into ${templateDestination}`);
+    logger.log('📦 Downloading repro template...');
+
+    try {
+      const templateType = init ? 'after-storybook' : 'before-storybook'; // Download the repro based on subfolder "after-storybook" and selected branch
+
+      await degit(`storybookjs/repro-templates-temp/${selectedTemplate}/${templateType}#${branch}`, {
+        force: true
+      }).clone(templateDestination);
+    } catch (err) {
+      logger.error(`🚨 Failed to download repro template: ${err.message}`);
+      throw err;
+    }
+
+    const initMessage = init ? chalk.yellow(`yarn storybook`) : `Recreate your setup, then ${chalk.yellow(`run npx storybook init`)}`;
+    logger.info(boxen(dedent`
+        🎉 Your Storybook reproduction project is ready to use! 🎉
+
+        ${chalk.yellow(`cd ${selectedDirectory}`)}
+        ${initMessage}
+
+        Once you've recreated the problem you're experiencing, please:
+        
+        1. Document any additional steps in ${chalk.cyan('README.md')}
+        2. Publish the repository to github
+        3. Link to the repro repository in your issue
+
+        Having a clean repro helps us solve your issue faster! 🙏
+      `.trim(), {
+      borderStyle: 'round',
+      padding: 1,
+      borderColor: '#F1618C'
+    }));
+  } catch (error) {
+    logger.error('🚨 Failed to create repro');
+    throw error;
+  }
+};
+
+async function promptSelectedTemplate(choices) {
+  const {
+    template
+  } = await prompts({
+    type: 'select',
+    message: '🌈 Select the template',
+    name: 'template',
+    choices: choices.map(toChoices)
+  });
+  return template || null;
+}

package/dist/esm/repro-templates.js

@@ -0,0 +1,34 @@
+export default {
+  'cra/default-js': {
+    name: 'Create React App (Javascript)',
+    script: 'npx create-react-app .',
+    cadence: ['ci', 'daily', 'weekly'],
+    expected: {
+      framework: '@storybook/cra',
+      renderer: '@storybook/react',
+      builder: '@storybook/builder-webpack5'
+    }
+  },
+  'cra/default-ts': {
+    name: 'Create React App (Typescript)',
+    script: 'npx create-react-app . --template typescript',
+    cadence: ['ci', 'daily', 'weekly'],
+    expected: {
+      framework: '@storybook/cra',
+      renderer: '@storybook/react',
+      builder: '@storybook/builder-webpack5'
+    }
+  } // FIXME: missing documentation.json
+  // 'angular/latest': {
+  //   name: 'Angular (latest)',
+  //   script:
+  //     'npx -p @angular/cli ng new angular-latest --directory . --routing=true --minimal=true --style=scss --skip-install=true --strict',
+  //   cadence: ['ci', 'daily', 'weekly'],
+  //   expected: {
+  //     framework: '@storybook/angular',
+  //     renderer: '@storybook/angular',
+  //     builder: '@storybook/builder-webpack5',
+  //   },
+  // },
+
+};