@storybook/cli 7.0.0-alpha.13 → 7.0.0-alpha.18

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,154 @@
+import prompts from 'prompts';
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import boxen from 'boxen';
+import { dedent } from 'ts-dedent';
+import degit from 'degit';
+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
+}) => {
+  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 templates.
+
+          Available templates:
+          ${keys.map(key => chalk.blue`- ${key}`).join('\n')}
+          `.trim(), {
+      borderStyle: 'round',
+      padding: 1,
+      borderColor: '#F1618C'
+    }));
+    return;
+  }
+
+  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;
+
+  if (!selectedDirectory) {
+    const {
+      directory
+    } = await prompts({
+      type: 'text',
+      message: 'Enter the output directory',
+      name: 'directory',
+      initial: selectedTemplate,
+      validate: directoryName => fs.existsSync(directoryName) ? `${directoryName} already exists. Please choose another name.` : true
+    });
+    selectedDirectory = directory;
+  }
+
+  try {
+    const cwd = path.isAbsolute(selectedDirectory) ? selectedDirectory : path.join(process.cwd(), selectedDirectory);
+    logger.info(`🏃 Adding ${selectedConfig.name} into ${cwd}`);
+    logger.log('📦 Downloading repro template...');
+
+    try {
+      // Download the repro based on subfolder "after-storybook" and selected branch
+      await degit(`storybookjs/repro-templates-temp/${selectedTemplate}/after-storybook#${branch}`, {
+        force: true
+      }).clone(selectedTemplate.replace('/', '-'));
+    } catch (err) {
+      logger.error(`🚨 Failed to download repro template: ${err.message}`);
+      return;
+    }
+
+    logger.info(boxen(dedent`
+        🎉 Your Storybook reproduction project is ready to use! 🎉
+
+        ${chalk.yellow(`cd ${selectedDirectory}`)}
+        ${chalk.yellow(`yarn storybook`)}
+
+        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,21 @@
+// auto generated file, do not edit
+export default {
+  'cra/default-js': {
+    name: 'Create React App (Javascript)',
+    script: 'npx create-react-app .',
+    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',
+    expected: {
+      framework: '@storybook/cra',
+      renderer: '@storybook/react',
+      builder: '@storybook/builder-webpack5'
+    }
+  }
+};

package/dist/esm/repro.js

@@ -1,36 +1,11 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.repro = void 0;
-
-require("core-js/modules/es.object.from-entries.js");
-
-require("core-js/modules/es.promise.js");
-
-var _prompts = _interopRequireDefault(require("prompts"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _boxen = _interopRequireDefault(require("boxen"));
-
-var _tsDedent = require("ts-dedent");
-
-var _scripts = require("./repro-generators/scripts");
-
-var configs = _interopRequireWildcard(require("./repro-generators/configs"));
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+import prompts from 'prompts';
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import boxen from 'boxen';
+import { dedent } from 'ts-dedent';
+import { createAndInit, exec } from './repro-generators/scripts';
+import * as configs from './repro-generators/configs';
 const logger = console;
 const TEMPLATES = configs; // Create a curate list of template because some of them only make sense in E2E
 // context, fon instance react_in_yarn_workspace
@@ -40,8 +15,7 @@ const RENDERERS = Object.values(CURATED_TEMPLATES).reduce((acc, cur) => {
   acc[cur.renderer] = [...(acc[cur.renderer] || []), cur];
   return acc;
 }, {});
-
-const repro = async ({
+export const repro = async ({
   outputDirectory,
   list,
   template,
@@ -49,12 +23,13 @@ const repro = async ({
   generator,
   e2e,
   local,
+  registry,
   pnp
 }) => {
-  logger.info((0, _boxen.default)((0, _tsDedent.dedent)`
-        🤗 Welcome to ${_chalk.default.yellow('sb repro')}! 🤗 
+  logger.info(boxen(dedent`
+        🤗 Welcome to ${chalk.yellow('sb repro')}! 🤗 
 
-        Create a ${_chalk.default.green('new project')} to minimally reproduce Storybook issues.
+        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.
@@ -86,7 +61,7 @@ const repro = async ({
     if (!selectedRenderer) {
       const {
         renderer: rendererOpt
-      } = await (0, _prompts.default)({
+      } = await prompts({
         type: 'select',
         message: '🌈 Select the repro renderer',
         name: 'renderer',
@@ -102,7 +77,7 @@ const repro = async ({
       throw new Error('🚨 Repro: please select a renderer!');
     }
 
-    selectedTemplate = (await (0, _prompts.default)({
+    selectedTemplate = (await prompts({
       type: 'select',
       message: '📝 Select the repro base template',
       name: 'template',
@@ -128,20 +103,21 @@ const repro = async ({
   if (!selectedDirectory) {
     const {
       directory
-    } = await (0, _prompts.default)({
+    } = await prompts({
       type: 'text',
       message: 'Enter the output directory',
       name: 'directory',
       initial: selectedConfig.name,
-      validate: directoryName => _fs.default.existsSync(directoryName) ? `${directoryName} already exists. Please choose another name.` : true
+      validate: directoryName => fs.existsSync(directoryName) ? `${directoryName} already exists. Please choose another name.` : true
     });
     selectedDirectory = directory;
   }
 
   try {
-    const cwd = _path.default.isAbsolute(selectedDirectory) ? selectedDirectory : _path.default.join(process.cwd(), selectedDirectory);
+    const cwd = path.isAbsolute(selectedDirectory) ? selectedDirectory : path.join(process.cwd(), selectedDirectory);
     logger.info(`🏃 Running ${selectedTemplate} into ${cwd}`);
-    await (0, _scripts.createAndInit)(cwd, selectedConfig, {
+    await createAndInit(cwd, selectedConfig, {
+      registry,
       e2e: !!e2e,
       pnp: !!pnp,
       local: !!local
@@ -151,15 +127,15 @@ const repro = async ({
       await initGitRepo(cwd);
     }
 
-    logger.info((0, _boxen.default)((0, _tsDedent.dedent)`
+    logger.info(boxen(dedent`
         🎉 Your Storybook reproduction project is ready to use! 🎉
 
-        ${_chalk.default.yellow(`cd ${selectedDirectory}`)}
-        ${_chalk.default.yellow(`yarn storybook`)}
+        ${chalk.yellow(`cd ${selectedDirectory}`)}
+        ${chalk.yellow(`yarn storybook`)}
 
         Once you've recreated the problem you're experiencing, please:
         
-        1. Document any additional steps in ${_chalk.default.cyan('README.md')}
+        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
 
@@ -175,22 +151,20 @@ const repro = async ({
   }
 };
 
-exports.repro = repro;
-
 const initGitRepo = async cwd => {
-  await (0, _scripts.exec)('git init', {
+  await exec('git init', {
     cwd
   });
-  await (0, _scripts.exec)('echo "node_modules" >> .gitignore', {
+  await exec('echo "node_modules" >> .gitignore', {
     cwd
   });
-  await (0, _scripts.exec)('git add --all', {
+  await exec('git add --all', {
     cwd
   });
-  await (0, _scripts.exec)('git commit -am "added storybook"', {
+  await exec('git commit -am "added storybook"', {
     cwd
   });
-  await (0, _scripts.exec)('git tag repro-base', {
+  await exec('git tag repro-base', {
     cwd
   });
 };