@storybook/cli 7.0.0-alpha.31 → 7.0.0-alpha.34

package/dist/esm/helpers.js

@@ -1,207 +0,0 @@
-/* eslint-disable no-param-reassign */
-import path, { join } from 'path';
-import fs from 'fs';
-import fse from 'fs-extra';
-import chalk from 'chalk';
-import { satisfies } from '@storybook/semver';
-import stripJsonComments from 'strip-json-comments';
-import { getBaseDir } from './dirs';
-import storybookMonorepoPackages from './versions';
-const logger = console;
-export function getBowerJson() {
-  const bowerJsonPath = path.resolve('bower.json');
-
-  if (!fs.existsSync(bowerJsonPath)) {
-    return false;
-  }
-
-  const jsonContent = fs.readFileSync(bowerJsonPath, 'utf8');
-  return JSON.parse(jsonContent);
-}
-export function readFileAsJson(jsonPath, allowComments) {
-  const filePath = path.resolve(jsonPath);
-
-  if (!fs.existsSync(filePath)) {
-    return false;
-  }
-
-  const fileContent = fs.readFileSync(filePath, 'utf8');
-  const jsonContent = allowComments ? stripJsonComments(fileContent) : fileContent;
-
-  try {
-    return JSON.parse(jsonContent);
-  } catch (e) {
-    logger.error(chalk.red(`Invalid json in file: ${filePath}`));
-    throw e;
-  }
-}
-export const writeFileAsJson = (jsonPath, content) => {
-  const filePath = path.resolve(jsonPath);
-
-  if (!fs.existsSync(filePath)) {
-    return false;
-  }
-
-  fs.writeFileSync(filePath, `${JSON.stringify(content, null, 2)}\n`);
-  return true;
-};
-export const commandLog = message => {
-  process.stdout.write(chalk.cyan(' • ') + message); // Need `void` to be able to use this function in a then of a Promise<void>
-
-  return (errorMessage, errorInfo) => {
-    if (errorMessage) {
-      process.stdout.write(`. ${chalk.red('✖')}\n`);
-      logger.error(`\n     ${chalk.red(errorMessage)}`);
-
-      if (!errorInfo) {
-        return;
-      }
-
-      const newErrorInfo = errorInfo.split('\n').map(line => `     ${chalk.dim(line)}`).join('\n');
-      logger.error(`${newErrorInfo}\n`);
-      return;
-    }
-
-    process.stdout.write(`. ${chalk.green('✓')}\n`);
-  };
-};
-export function paddedLog(message) {
-  const newMessage = message.split('\n').map(line => `    ${line}`).join('\n');
-  logger.log(newMessage);
-}
-export function getChars(char, amount) {
-  let line = '';
-
-  for (let lc = 0; lc < amount; lc += 1) {
-    line += char;
-  }
-
-  return line;
-}
-export function codeLog(codeLines, leftPadAmount) {
-  let maxLength = 0;
-  const newLines = codeLines.map(line => {
-    maxLength = line.length > maxLength ? line.length : maxLength;
-    return line;
-  });
-  const finalResult = newLines.map(line => {
-    const rightPadAmount = maxLength - line.length;
-    let newLine = line + getChars(' ', rightPadAmount);
-    newLine = getChars(' ', leftPadAmount || 2) + chalk.inverse(` ${newLine} `);
-    return newLine;
-  }).join('\n');
-  logger.log(finalResult);
-}
-/**
- * Detect if any babel dependencies need to be added to the project
- * @param {Object} packageJson The current package.json so we can inspect its contents
- * @returns {Array} Contains the packages and versions that need to be installed
- * @example
- * const babelDependencies = await getBabelDependencies(packageManager, npmOptions, packageJson);
- * // you can then spread the result when using installDependencies
- * installDependencies(npmOptions, [
- *   `@storybook/react@${storybookVersion}`,
- *   ...babelDependencies,
- * ]);
- */
-
-export async function getBabelDependencies(packageManager, packageJson) {
-  const dependenciesToAdd = [];
-  let babelLoaderVersion = '^8.0.0-0';
-  const babelCoreVersion = packageJson.dependencies['babel-core'] || packageJson.devDependencies['babel-core'];
-
-  if (!babelCoreVersion) {
-    if (!packageJson.dependencies['@babel/core'] && !packageJson.devDependencies['@babel/core']) {
-      const babelCoreInstallVersion = await packageManager.getVersion('@babel/core');
-      dependenciesToAdd.push(`@babel/core@${babelCoreInstallVersion}`);
-    }
-  } else {
-    const latestCompatibleBabelVersion = await packageManager.latestVersion('babel-core', babelCoreVersion); // Babel 6
-
-    if (satisfies(latestCompatibleBabelVersion, '^6.0.0')) {
-      babelLoaderVersion = '^7.0.0';
-    }
-  }
-
-  if (!packageJson.dependencies['babel-loader'] && !packageJson.devDependencies['babel-loader']) {
-    const babelLoaderInstallVersion = await packageManager.getVersion('babel-loader', babelLoaderVersion);
-    dependenciesToAdd.push(`babel-loader@${babelLoaderInstallVersion}`);
-  }
-
-  return dependenciesToAdd;
-}
-export function addToDevDependenciesIfNotPresent(packageJson, name, packageVersion) {
-  if (!packageJson.dependencies[name] && !packageJson.devDependencies[name]) {
-    packageJson.devDependencies[name] = packageVersion;
-  }
-}
-export function copyTemplate(templateRoot) {
-  const templateDir = path.resolve(templateRoot, `template-csf/`);
-
-  if (!fs.existsSync(templateDir)) {
-    throw new Error(`Couldn't find template dir`);
-  }
-
-  fse.copySync(templateDir, '.', {
-    overwrite: true
-  });
-}
-export async function copyComponents(renderer, language) {
-  const languageFolderMapping = {
-    javascript: 'js',
-    typescript: 'ts'
-  };
-
-  const componentsPath = async () => {
-    const baseDir = getBaseDir();
-    const assetsRoot = join(baseDir, 'rendererAssets');
-    const assetsRenderer = join(assetsRoot, renderer);
-    const assetsLanguage = join(assetsRenderer, languageFolderMapping[language]);
-
-    if (await fse.pathExists(assetsLanguage)) {
-      return assetsLanguage;
-    }
-
-    const assetsJS = join(assetsRenderer, languageFolderMapping.javascript);
-
-    if (await fse.pathExists(assetsJS)) {
-      return assetsJS;
-    }
-
-    if (await fse.pathExists(assetsRenderer)) {
-      return assetsRenderer;
-    }
-
-    throw new Error(`Unsupported renderer: ${renderer}`);
-  };
-
-  const targetPath = async () => {
-    if (await fse.pathExists('./src')) {
-      return './src/stories';
-    }
-
-    return './stories';
-  };
-
-  const destinationPath = await targetPath();
-  await fse.copy(await componentsPath(), destinationPath, {
-    overwrite: true
-  });
-  await fse.copy(join(getBaseDir(), 'rendererAssets/common'), destinationPath, {
-    overwrite: true
-  });
-} // Given a package.json, finds any official storybook package within it
-// and if it exists, returns the version of that package from the specified package.json
-
-export function getStorybookVersionSpecifier(packageJson) {
-  const allDeps = Object.assign({}, packageJson.dependencies, packageJson.devDependencies);
-  const storybookPackage = Object.keys(allDeps).find(name => {
-    return storybookMonorepoPackages[name];
-  });
-
-  if (!storybookPackage) {
-    throw new Error(`Couldn't find any official storybook packages in package.json`);
-  }
-
-  return allDeps[storybookPackage];
-}

package/dist/esm/initiate.js

@@ -1,254 +0,0 @@
-import { UpdateNotifier } from 'update-notifier';
-import chalk from 'chalk';
-import prompts from 'prompts';
-import { telemetry } from '@storybook/telemetry';
-import { installableProjectTypes, ProjectType } from './project_types';
-import { detect, isStorybookInstalled, detectLanguage, detectBuilder } from './detect';
-import { commandLog, codeLog, paddedLog } from './helpers';
-import angularGenerator from './generators/ANGULAR';
-import aureliaGenerator from './generators/AURELIA';
-import emberGenerator from './generators/EMBER';
-import reactGenerator from './generators/REACT';
-import reactNativeGenerator from './generators/REACT_NATIVE';
-import reactScriptsGenerator from './generators/REACT_SCRIPTS';
-import sfcVueGenerator from './generators/SFC_VUE';
-import vueGenerator from './generators/VUE';
-import vue3Generator from './generators/VUE3';
-import webpackReactGenerator from './generators/WEBPACK_REACT';
-import mithrilGenerator from './generators/MITHRIL';
-import marionetteGenerator from './generators/MARIONETTE';
-import markoGenerator from './generators/MARKO';
-import htmlGenerator from './generators/HTML';
-import webComponentsGenerator from './generators/WEB-COMPONENTS';
-import riotGenerator from './generators/RIOT';
-import preactGenerator from './generators/PREACT';
-import svelteGenerator from './generators/SVELTE';
-import raxGenerator from './generators/RAX';
-import serverGenerator from './generators/SERVER';
-import { JsPackageManagerFactory } from './js-package-manager';
-import { automigrate } from './automigrate';
-const logger = console;
-
-const installStorybook = (projectType, packageManager, options) => {
-  const npmOptions = {
-    installAsDevDependencies: true,
-    skipInstall: options.skipInstall
-  };
-  let packageJson;
-
-  try {
-    packageJson = packageManager.readPackageJson();
-  } catch (err) {//
-  }
-
-  const language = detectLanguage(packageJson);
-  const generatorOptions = {
-    language,
-    builder: options.builder || detectBuilder(packageManager),
-    linkable: !!options.linkable,
-    commonJs: options.commonJs,
-    pnp: options.usePnp
-  };
-
-  const runGenerator = async () => {
-    switch (projectType) {
-      case ProjectType.ALREADY_HAS_STORYBOOK:
-        logger.log();
-        paddedLog('There seems to be a Storybook already available in this project.');
-        paddedLog('Apply following command to force:\n');
-        codeLog(['sb init [options] -f']); // Add a new line for the clear visibility.
-
-        logger.log();
-        return Promise.resolve();
-
-      case ProjectType.REACT_SCRIPTS:
-        return reactScriptsGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Create React App" based project'));
-
-      case ProjectType.REACT:
-        return reactGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "React" app\n'));
-
-      case ProjectType.REACT_NATIVE:
-        {
-          return (options.yes ? Promise.resolve({
-            server: true
-          }) : prompts([{
-            type: 'confirm',
-            name: 'server',
-            message: 'Do you want to install dependencies necessary to run Storybook server? You can manually do it later by install @storybook/react-native-server',
-            initial: false
-          }])).then(({
-            server
-          }) => reactNativeGenerator(packageManager, npmOptions, server)).then(commandLog('Adding Storybook support to your "React Native" app\n'));
-        }
-
-      case ProjectType.WEBPACK_REACT:
-        return webpackReactGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Webpack React" app\n'));
-
-      case ProjectType.REACT_PROJECT:
-        return reactGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "React" library\n'));
-
-      case ProjectType.SFC_VUE:
-        return sfcVueGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Single File Components Vue" app\n'));
-
-      case ProjectType.VUE:
-        return vueGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Vue" app\n'));
-
-      case ProjectType.VUE3:
-        return vue3Generator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Vue 3" app\n'));
-
-      case ProjectType.ANGULAR:
-        return angularGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Angular" app\n'));
-
-      case ProjectType.EMBER:
-        return emberGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Ember" app\n'));
-
-      case ProjectType.MITHRIL:
-        return mithrilGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Mithril" app\n'));
-
-      case ProjectType.MARIONETTE:
-        return marionetteGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Marionette.js" app\n'));
-
-      case ProjectType.MARKO:
-        return markoGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Marko" app\n'));
-
-      case ProjectType.HTML:
-        return htmlGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "HTML" app\n'));
-
-      case ProjectType.WEB_COMPONENTS:
-        return webComponentsGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "web components" app\n'));
-
-      case ProjectType.RIOT:
-        return riotGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "riot.js" app\n'));
-
-      case ProjectType.PREACT:
-        return preactGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Preact" app\n'));
-
-      case ProjectType.SVELTE:
-        return svelteGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Svelte" app\n'));
-
-      case ProjectType.RAX:
-        return raxGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Rax" app\n'));
-
-      case ProjectType.AURELIA:
-        return aureliaGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Aurelia" app\n'));
-
-      case ProjectType.SERVER:
-        return serverGenerator(packageManager, npmOptions, generatorOptions).then(commandLog('Adding Storybook support to your "Server" app\n'));
-
-      case ProjectType.UNSUPPORTED:
-        paddedLog(`We detected a project type that we don't support yet.`);
-        paddedLog(`If you'd like your framework to be supported, please let use know about it at https://github.com/storybookjs/storybook/issues`); // Add a new line for the clear visibility.
-
-        logger.log();
-        return Promise.resolve();
-
-      default:
-        paddedLog(`We couldn't detect your project type. (code: ${projectType})`);
-        paddedLog('You can specify a project type explicitly via `sb init --type <type>`, see our docs on how to configure Storybook for your framework: https://storybook.js.org/docs/react/get-started/install'); // Add a new line for the clear visibility.
-
-        logger.log();
-        return projectTypeInquirer(options, packageManager);
-    }
-  };
-
-  return runGenerator().catch(ex => {
-    logger.error(`\n     ${chalk.red(ex.stack)}`);
-    process.exit(1);
-  });
-};
-
-const projectTypeInquirer = async (options, packageManager) => {
-  const manualAnswer = options.yes ? true : await prompts([{
-    type: 'confirm',
-    name: 'manual',
-    message: 'Do you want to manually choose a Storybook project type to install?'
-  }]);
-
-  if (manualAnswer !== true && manualAnswer.manual) {
-    const frameworkAnswer = await prompts([{
-      type: 'select',
-      name: 'manualFramework',
-      message: 'Please choose a project type from the following list:',
-      choices: installableProjectTypes.map(type => ({
-        title: type,
-        value: type.toUpperCase()
-      }))
-    }]);
-    return installStorybook(frameworkAnswer.manualFramework, packageManager, options);
-  }
-
-  return Promise.resolve();
-};
-
-export async function initiate(options, pkg) {
-  const packageManager = JsPackageManagerFactory.getPackageManager(options.useNpm);
-  const welcomeMessage = 'storybook init - the simplest way to add a Storybook to your project.';
-  logger.log(chalk.inverse(`\n ${welcomeMessage} \n`));
-
-  if (!options.disableTelemetry) {
-    telemetry('init');
-  } // Update notify code.
-
-
-  new UpdateNotifier({
-    pkg,
-    updateCheckInterval: 1000 * 60 * 60 // every hour (we could increase this later on.)
-
-  }).notify();
-  let projectType;
-  const projectTypeProvided = options.type;
-  const infoText = projectTypeProvided ? `Installing Storybook for user specified project type: ${projectTypeProvided}` : 'Detecting project type';
-  const done = commandLog(infoText);
-  const packageJson = packageManager.retrievePackageJson();
-  const isEsm = packageJson && packageJson.type === 'module';
-
-  try {
-    if (projectTypeProvided) {
-      if (installableProjectTypes.includes(projectTypeProvided)) {
-        const storybookInstalled = isStorybookInstalled(packageJson, options.force);
-        projectType = storybookInstalled ? ProjectType.ALREADY_HAS_STORYBOOK : projectTypeProvided.toUpperCase();
-      } else {
-        done(`The provided project type was not recognized by Storybook: ${projectTypeProvided}`);
-        logger.log(`\nThe project types currently supported by Storybook are:\n`);
-        installableProjectTypes.sort().forEach(framework => paddedLog(`- ${framework}`));
-        logger.log();
-        process.exit(1);
-      }
-    } else {
-      projectType = detect(packageJson, options);
-    }
-  } catch (ex) {
-    done(ex.message);
-    process.exit(1);
-  }
-
-  done();
-  await installStorybook(projectType, packageManager, Object.assign({}, options, isEsm ? {
-    commonJs: true
-  } : undefined));
-
-  if (!options.skipInstall) {
-    packageManager.installDependencies();
-  }
-
-  await automigrate({
-    yes: options.yes || process.env.CI === 'true'
-  });
-  logger.log('\nTo run your Storybook, type:\n');
-  codeLog([packageManager.getRunStorybookCommand()]);
-  logger.log('\nFor more information visit:', chalk.cyan('https://storybook.js.org'));
-
-  if (projectType === ProjectType.REACT_NATIVE) {
-    const REACT_NATIVE_REPO = 'https://github.com/storybookjs/react-native';
-    logger.log();
-    logger.log(chalk.red('NOTE: installation is not 100% automated.'));
-    logger.log(`To quickly run Storybook, replace contents of your app entry with:\n`);
-    codeLog(["export {default} from './storybook';"]);
-    logger.log('\n For more in information, see the github readme:\n');
-    logger.log(chalk.cyan(REACT_NATIVE_REPO));
-    logger.log();
-  } // Add a new line for the clear visibility.
-
-
-  logger.log();
-}