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

package/dist/esm/js-package-manager/JsPackageManager.js

@@ -1,334 +0,0 @@
-import chalk from 'chalk';
-import { gt, satisfies } from '@storybook/semver';
-import { sync as spawnSync } from 'cross-spawn';
-import path from 'path';
-import fs from 'fs';
-import { commandLog } from '../helpers';
-import storybookPackagesVersions from '../versions';
-const logger = console;
-/**
- * Extract package name and version from input
- *
- * @param pkg A string like `@storybook/cli`, `react` or `react@^16`
- * @return A tuple of 2 elements: [packageName, packageVersion]
- */
-
-export function getPackageDetails(pkg) {
-  const idx = pkg.lastIndexOf('@'); // If the only `@` is the first character, it is a scoped package
-  // If it isn't in the string, it will be -1
-
-  if (idx <= 0) {
-    return [pkg, undefined];
-  }
-
-  const packageName = pkg.slice(0, idx);
-  const packageVersion = pkg.slice(idx + 1);
-  return [packageName, packageVersion];
-}
-export class JsPackageManager {
-  // NOTE: for some reason yarn prefers the npm registry in
-  // local development, so always use npm
-  setRegistryURL(url) {
-    if (url) {
-      this.executeCommand('npm', ['config', 'set', 'registry', url]);
-    } else {
-      this.executeCommand('npm', ['config', 'delete', 'registry']);
-    }
-  }
-
-  getRegistryURL() {
-    const url = this.executeCommand('npm', ['config', 'get', 'registry']).trim();
-    return url === 'undefined' ? undefined : url;
-  }
-
-  constructor(options) {
-    this.type = void 0;
-    this.cwd = void 0;
-    this.cwd = options?.cwd;
-  }
-  /**
-   * Install dependencies listed in `package.json`
-   */
-
-
-  installDependencies() {
-    let done = commandLog('Preparing to install dependencies');
-    done();
-    logger.log();
-    logger.log();
-    done = commandLog('Installing dependencies');
-
-    try {
-      this.runInstall();
-    } catch (e) {
-      done('An error occurred while installing dependencies.');
-      process.exit(1);
-    }
-
-    done();
-  }
-
-  packageJsonPath() {
-    return this.cwd ? path.resolve(this.cwd, 'package.json') : path.resolve('package.json');
-  }
-
-  readPackageJson() {
-    const packageJsonPath = this.packageJsonPath();
-
-    if (!fs.existsSync(packageJsonPath)) {
-      throw new Error(`Could not read package.json file at ${packageJsonPath}`);
-    }
-
-    const jsonContent = fs.readFileSync(packageJsonPath, 'utf8');
-    return JSON.parse(jsonContent);
-  }
-
-  writePackageJson(packageJson) {
-    const content = `${JSON.stringify(packageJson, null, 2)}\n`;
-    fs.writeFileSync(this.packageJsonPath(), content, 'utf8');
-  }
-  /**
-   * Read the `package.json` file available in the directory the command was call from
-   * If there is no `package.json` it will create one.
-   */
-
-
-  retrievePackageJson() {
-    let packageJson;
-
-    try {
-      packageJson = this.readPackageJson();
-    } catch (err) {
-      this.initPackageJson();
-      packageJson = this.readPackageJson();
-    }
-
-    return Object.assign({}, packageJson, {
-      dependencies: Object.assign({}, packageJson.dependencies),
-      devDependencies: Object.assign({}, packageJson.devDependencies)
-    });
-  }
-  /**
-   * Add dependencies to a project using `yarn add` or `npm install`.
-   *
-   * @param {Object} options contains `skipInstall`, `packageJson` and `installAsDevDependencies` which we use to determine how we install packages.
-   * @param {Array} dependencies contains a list of packages to add.
-   * @example
-   * addDependencies(options, [
-   *   `@storybook/react@${storybookVersion}`,
-   *   `@storybook/addon-actions@${actionsVersion}`,
-   *   `@storybook/addon-links@${linksVersion}`,
-   *   `@storybook/addons@${addonsVersion}`,
-   * ]);
-   */
-
-
-  addDependencies(options, dependencies) {
-    const {
-      skipInstall
-    } = options;
-
-    if (skipInstall) {
-      const {
-        packageJson
-      } = options;
-      const dependenciesMap = dependencies.reduce((acc, dep) => {
-        const [packageName, packageVersion] = getPackageDetails(dep);
-        return Object.assign({}, acc, {
-          [packageName]: packageVersion
-        });
-      }, {});
-
-      if (options.installAsDevDependencies) {
-        packageJson.devDependencies = Object.assign({}, packageJson.devDependencies, dependenciesMap);
-      } else {
-        packageJson.dependencies = Object.assign({}, packageJson.dependencies, dependenciesMap);
-      }
-
-      this.writePackageJson(packageJson);
-    } else {
-      try {
-        this.runAddDeps(dependencies, options.installAsDevDependencies);
-      } catch (e) {
-        logger.error('An error occurred while installing dependencies.');
-        logger.log(e.message);
-        process.exit(1);
-      }
-    }
-  }
-  /**
-   * Remove dependencies from a project using `yarn remove` or `npm uninstall`.
-   *
-   * @param {Object} options contains `skipInstall`, `packageJson` and `installAsDevDependencies` which we use to determine how we install packages.
-   * @param {Array} dependencies contains a list of packages to remove.
-   * @example
-   * removeDependencies(options, [
-   *   `@storybook/react`,
-   *   `@storybook/addon-actions`,
-   * ]);
-   */
-
-
-  removeDependencies(options, dependencies) {
-    const {
-      skipInstall
-    } = options;
-
-    if (skipInstall) {
-      const {
-        packageJson
-      } = options;
-      dependencies.forEach(dep => {
-        if (packageJson.devDependencies) {
-          delete packageJson.devDependencies[dep];
-        }
-
-        if (packageJson.dependencies) {
-          delete packageJson.dependencies[dep];
-        }
-      });
-      this.writePackageJson(packageJson);
-    } else {
-      try {
-        this.runRemoveDeps(dependencies);
-      } catch (e) {
-        logger.error('An error occurred while removing dependencies.');
-        logger.log(e.message);
-        process.exit(1);
-      }
-    }
-  }
-  /**
-   * Return an array of strings matching following format: `<package_name>@<package_latest_version>`
-   *
-   * @param packages
-   */
-
-
-  getVersionedPackages(packages) {
-    return Promise.all(packages.map(async pkg => {
-      const [packageName, packageVersion] = getPackageDetails(pkg);
-      return `${packageName}@${await this.getVersion(packageName, packageVersion)}`;
-    }));
-  }
-  /**
-   * Return an array of string standing for the latest version of the input packages.
-   * To be able to identify which version goes with which package the order of the input array is keep.
-   *
-   * @param packageNames
-   */
-
-
-  getVersions(...packageNames) {
-    return Promise.all(packageNames.map(packageName => {
-      return this.getVersion(packageName);
-    }));
-  }
-  /**
-   * Return the latest version of the input package available on npmjs registry.
-   * If constraint are provided it return the latest version matching the constraints.
-   *
-   * For `@storybook/*` packages the latest version is retrieved from `cli/src/versions.json` file directly
-   *
-   * @param packageName The name of the package
-   * @param constraint A valid semver constraint, example: '1.x || >=2.5.0 || 5.0.0 - 7.2.3'
-   */
-
-
-  async getVersion(packageName, constraint) {
-    let current;
-
-    if (/(@storybook|^sb$|^storybook$)/.test(packageName)) {
-      // @ts-ignore
-      current = storybookPackagesVersions[packageName];
-    }
-
-    let latest;
-
-    try {
-      latest = await this.latestVersion(packageName, constraint);
-    } catch (e) {
-      if (current) {
-        logger.warn(`\n     ${chalk.yellow(e.message)}`);
-        return current;
-      }
-
-      logger.error(`\n     ${chalk.red(e.message)}`);
-      process.exit(1);
-    }
-
-    const versionToUse = current && (!constraint || satisfies(current, constraint)) && gt(current, latest) ? current : latest;
-    return `^${versionToUse}`;
-  }
-  /**
-   * Get the latest version of the package available on npmjs.com.
-   * If constraint is set then it returns a version satisfying it, otherwise the latest version available is returned.
-   *
-   * @param packageName Name of the package
-   * @param constraint Version range to use to constraint the returned version
-   */
-
-
-  async latestVersion(packageName, constraint) {
-    if (!constraint) {
-      return this.runGetVersions(packageName, false);
-    }
-
-    const versions = await this.runGetVersions(packageName, true); // Get the latest version satisfying the constraint
-
-    return versions.reverse().find(version => satisfies(version, constraint));
-  }
-
-  addStorybookCommandInScripts(options) {
-    const sbPort = options?.port ?? 6006;
-    const storybookCmd = options?.staticFolder ? `npx storybook dev -p ${sbPort} -s ${options.staticFolder}` : `npx storybook dev -p ${sbPort}`;
-    const buildStorybookCmd = options?.staticFolder ? `npx storybook build -s ${options.staticFolder}` : `npx storybook build`;
-    const preCommand = options?.preCommand ? this.getRunCommand(options.preCommand) : undefined;
-    this.addScripts({
-      storybook: [preCommand, storybookCmd].filter(Boolean).join(' && '),
-      'build-storybook': [preCommand, buildStorybookCmd].filter(Boolean).join(' && ')
-    });
-  }
-
-  addESLintConfig() {
-    const packageJson = this.retrievePackageJson();
-    this.writePackageJson(Object.assign({}, packageJson, {
-      eslintConfig: Object.assign({}, packageJson.eslintConfig, {
-        overrides: [...(packageJson.eslintConfig?.overrides || []), {
-          files: ['**/*.stories.*'],
-          rules: {
-            'import/no-anonymous-default-export': 'off'
-          }
-        }]
-      })
-    }));
-  }
-
-  addScripts(scripts) {
-    const packageJson = this.retrievePackageJson();
-    this.writePackageJson(Object.assign({}, packageJson, {
-      scripts: Object.assign({}, packageJson.scripts, scripts)
-    }));
-  }
-
-  addPackageResolutions(versions) {
-    const packageJson = this.retrievePackageJson();
-    const resolutions = this.getResolutions(packageJson, versions);
-    this.writePackageJson(Object.assign({}, packageJson, resolutions));
-  }
-
-  executeCommand(command, args, stdio) {
-    const commandResult = spawnSync(command, args, {
-      cwd: this.cwd,
-      stdio: stdio ?? 'pipe',
-      encoding: 'utf-8'
-    });
-
-    if (commandResult.status !== 0) {
-      throw new Error(commandResult.stderr ?? '');
-    }
-
-    return commandResult.stdout ?? '';
-  }
-
-}

package/dist/esm/js-package-manager/JsPackageManagerFactory.js

@@ -1,57 +0,0 @@
-import { sync as spawnSync } from 'cross-spawn';
-import { sync as findUpSync } from 'find-up';
-import { NPMProxy } from './NPMProxy';
-import { Yarn2Proxy } from './Yarn2Proxy';
-import { Yarn1Proxy } from './Yarn1Proxy';
-export class JsPackageManagerFactory {
-  static getPackageManager(forceNpmUsage = false, cwd) {
-    if (forceNpmUsage) {
-      return new NPMProxy({
-        cwd
-      });
-    }
-
-    const yarnVersion = getYarnVersion(cwd);
-    const hasYarnLockFile = findUpSync('yarn.lock', {
-      cwd
-    });
-    const hasNPMCommand = hasNPM(cwd);
-
-    if (yarnVersion && (hasYarnLockFile || !hasNPMCommand)) {
-      return yarnVersion === 1 ? new Yarn1Proxy({
-        cwd
-      }) : new Yarn2Proxy({
-        cwd
-      });
-    }
-
-    if (hasNPMCommand) {
-      return new NPMProxy({
-        cwd
-      });
-    }
-
-    throw new Error('Unable to find a usable package manager within NPM, Yarn and Yarn 2');
-  }
-
-}
-
-function hasNPM(cwd) {
-  const npmVersionCommand = spawnSync('npm', ['--version'], {
-    cwd
-  });
-  return npmVersionCommand.status === 0;
-}
-
-function getYarnVersion(cwd) {
-  const yarnVersionCommand = spawnSync('yarn', ['--version'], {
-    cwd
-  });
-
-  if (yarnVersionCommand.status !== 0) {
-    return undefined;
-  }
-
-  const yarnVersion = yarnVersionCommand.output.toString().replace(/,/g, '').replace(/"/g, '');
-  return /^1\.+/.test(yarnVersion) ? 1 : 2;
-}

package/dist/esm/js-package-manager/NPMProxy.js

@@ -1,99 +0,0 @@
-import semver from '@storybook/semver';
-import { JsPackageManager } from './JsPackageManager';
-export class NPMProxy extends JsPackageManager {
-  constructor(...args) {
-    super(...args);
-    this.type = 'npm';
-    this.installArgs = void 0;
-    this.uninstallArgs = void 0;
-  }
-
-  initPackageJson() {
-    return this.executeCommand('npm', ['init', '-y']);
-  }
-
-  getRunStorybookCommand() {
-    return 'npm run storybook';
-  }
-
-  getRunCommand(command) {
-    return `npm run ${command}`;
-  }
-
-  getNpmVersion() {
-    return this.executeCommand('npm', ['--version']);
-  }
-
-  hasLegacyPeerDeps() {
-    const result = this.executeCommand('npm', ['config', 'get', 'legacy-peer-deps', '--location=project']);
-    return result.trim() === 'true';
-  }
-
-  setLegacyPeerDeps() {
-    this.executeCommand('npm', ['config', 'set', 'legacy-peer-deps=true', '--location=project']);
-  }
-
-  needsLegacyPeerDeps(version) {
-    return semver.gte(version, '7.0.0') && !this.hasLegacyPeerDeps();
-  }
-
-  getInstallArgs() {
-    if (!this.installArgs) {
-      this.installArgs = this.needsLegacyPeerDeps(this.getNpmVersion()) ? ['install', '--legacy-peer-deps'] : ['install'];
-    }
-
-    return this.installArgs;
-  }
-
-  getUninstallArgs() {
-    if (!this.uninstallArgs) {
-      this.uninstallArgs = this.needsLegacyPeerDeps(this.getNpmVersion()) ? ['uninstall', '--legacy-peer-deps'] : ['uninstall'];
-    }
-
-    return this.uninstallArgs;
-  }
-
-  getResolutions(packageJson, versions) {
-    return {
-      overrides: Object.assign({}, packageJson.overrides, versions)
-    };
-  }
-
-  runInstall() {
-    this.executeCommand('npm', this.getInstallArgs(), 'inherit');
-  }
-
-  runAddDeps(dependencies, installAsDevDependencies) {
-    let args = [...dependencies];
-
-    if (installAsDevDependencies) {
-      args = ['-D', ...args];
-    }
-
-    this.executeCommand('npm', [...this.getInstallArgs(), ...args], 'inherit');
-  }
-
-  runRemoveDeps(dependencies) {
-    const args = [...dependencies];
-    this.executeCommand('npm', [...this.getUninstallArgs(), ...args], 'inherit');
-  }
-
-  runGetVersions(packageName, fetchAllVersions) {
-    const args = [fetchAllVersions ? 'versions' : 'version', '--json'];
-    const commandResult = this.executeCommand('npm', ['info', packageName, ...args]);
-
-    try {
-      const parsedOutput = JSON.parse(commandResult);
-
-      if (parsedOutput.error) {
-        // FIXME: improve error handling
-        throw new Error(parsedOutput.error.summary);
-      } else {
-        return parsedOutput;
-      }
-    } catch (e) {
-      throw new Error(`Unable to find versions of ${packageName} using npm`);
-    }
-  }
-
-}

package/dist/esm/js-package-manager/PackageJson.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/js-package-manager/Yarn1Proxy.js

@@ -1,62 +0,0 @@
-import { JsPackageManager } from './JsPackageManager';
-export class Yarn1Proxy extends JsPackageManager {
-  constructor(...args) {
-    super(...args);
-    this.type = 'yarn1';
-  }
-
-  initPackageJson() {
-    return this.executeCommand('yarn', ['init', '-y']);
-  }
-
-  getRunStorybookCommand() {
-    return 'yarn storybook';
-  }
-
-  getRunCommand(command) {
-    return `yarn ${command}`;
-  }
-
-  getResolutions(packageJson, versions) {
-    return {
-      resolutions: Object.assign({}, packageJson.resolutions, versions)
-    };
-  }
-
-  runInstall() {
-    this.executeCommand('yarn', [], 'inherit');
-  }
-
-  runAddDeps(dependencies, installAsDevDependencies) {
-    let args = ['--ignore-workspace-root-check', ...dependencies];
-
-    if (installAsDevDependencies) {
-      args = ['-D', ...args];
-    }
-
-    this.executeCommand('yarn', ['add', ...args], 'inherit');
-  }
-
-  runRemoveDeps(dependencies) {
-    const args = ['--ignore-workspace-root-check', ...dependencies];
-    this.executeCommand('yarn', ['remove', ...args], 'inherit');
-  }
-
-  runGetVersions(packageName, fetchAllVersions) {
-    const args = [fetchAllVersions ? 'versions' : 'version', '--json'];
-    const commandResult = this.executeCommand('yarn', ['info', packageName, ...args]);
-
-    try {
-      const parsedOutput = JSON.parse(commandResult);
-
-      if (parsedOutput.type === 'inspect') {
-        return parsedOutput.data;
-      }
-
-      throw new Error(`Unable to find versions of ${packageName} using yarn`);
-    } catch (e) {
-      throw new Error(`Unable to find versions of ${packageName} using yarn`);
-    }
-  }
-
-}

package/dist/esm/js-package-manager/Yarn2Proxy.js

@@ -1,58 +0,0 @@
-import { JsPackageManager } from './JsPackageManager';
-export class Yarn2Proxy extends JsPackageManager {
-  constructor(...args) {
-    super(...args);
-    this.type = 'yarn2';
-  }
-
-  initPackageJson() {
-    return this.executeCommand('yarn', ['init']);
-  }
-
-  getRunStorybookCommand() {
-    return 'yarn storybook';
-  }
-
-  getRunCommand(command) {
-    return `yarn ${command}`;
-  }
-
-  getResolutions(packageJson, versions) {
-    return {
-      resolutions: Object.assign({}, packageJson.resolutions, versions)
-    };
-  }
-
-  runInstall() {
-    this.executeCommand('yarn', [], 'inherit');
-  }
-
-  runAddDeps(dependencies, installAsDevDependencies) {
-    let args = [...dependencies];
-
-    if (installAsDevDependencies) {
-      args = ['-D', ...args];
-    }
-
-    this.executeCommand('yarn', ['add', ...args], 'inherit');
-  }
-
-  runRemoveDeps(dependencies) {
-    const args = [...dependencies];
-    this.executeCommand('yarn', ['remove', ...args], 'inherit');
-  }
-
-  runGetVersions(packageName, fetchAllVersions) {
-    const field = fetchAllVersions ? 'versions' : 'version';
-    const args = ['--fields', field, '--json'];
-    const commandResult = this.executeCommand('yarn', ['npm', 'info', packageName, ...args]);
-
-    try {
-      const parsedOutput = JSON.parse(commandResult);
-      return parsedOutput[field];
-    } catch (e) {
-      throw new Error(`Unable to find versions of ${packageName} using yarn 2`);
-    }
-  }
-
-}

package/dist/esm/js-package-manager/index.js

@@ -1,3 +0,0 @@
-export * from './JsPackageManagerFactory';
-export * from './JsPackageManager';
-export * from './PackageJson';

package/dist/esm/link.js

@@ -1,69 +0,0 @@
-import fse from 'fs-extra';
-import path from 'path';
-import { sync as spawnSync } from 'cross-spawn';
-import { logger } from '@storybook/node-logger';
-import { exec } from './repro-generators/scripts';
-export const link = async ({
-  target,
-  local,
-  start
-}) => {
-  const storybookDir = process.cwd();
-
-  try {
-    const packageJson = JSON.parse(fse.readFileSync('package.json', 'utf8'));
-    if (packageJson.name !== '@storybook/root') throw new Error();
-  } catch {
-    throw new Error('Expected to run link from the root of the storybook monorepo');
-  }
-
-  let reproDir = target;
-  let reproName = path.basename(target);
-
-  if (!local) {
-    const reprosDir = path.join(storybookDir, '../storybook-repros');
-    logger.info(`Ensuring directory ${reprosDir}`);
-    fse.ensureDirSync(reprosDir);
-    logger.info(`Cloning ${target}`);
-    await exec(`git clone ${target}`, {
-      cwd: reprosDir
-    }); // Extract a repro name from url given as input (take the last part of the path and remove the extension)
-
-    reproName = path.basename(target, path.extname(target));
-    reproDir = path.join(reprosDir, reproName);
-  }
-
-  const version = spawnSync('yarn', ['--version'], {
-    cwd: reproDir,
-    stdio: 'pipe'
-  }).stdout.toString();
-
-  if (!/^[23]\./.test(version)) {
-    logger.warn(`🚨 Expected yarn 2 or 3 in ${reproDir}!`);
-    logger.warn('');
-    logger.warn('Please set it up with `yarn set version berry`,');
-    logger.warn(`then link '${reproDir}' with the '--local' flag.`);
-    return;
-  }
-
-  logger.info(`Linking ${reproDir}`);
-  await exec(`yarn link --all ${storybookDir}`, {
-    cwd: reproDir
-  });
-  logger.info(`Installing ${reproName}`);
-  await exec(`yarn install`, {
-    cwd: reproDir
-  }); // ⚠️ TODO: Fix peer deps in `@storybook/preset-create-react-app`
-
-  logger.info(`Magic stuff related to @storybook/preset-create-react-app, we need to fix peerDependencies`);
-  await exec(`yarn add -D webpack-hot-middleware`, {
-    cwd: reproDir
-  });
-
-  if (start) {
-    logger.info(`Running ${reproName} storybook`);
-    await exec(`yarn run storybook`, {
-      cwd: reproDir
-    });
-  }
-};