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

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

@@ -1,27 +1,10 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.JsPackageManager = void 0;
-exports.getPackageDetails = getPackageDetails;
-
-require("core-js/modules/es.promise.js");
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _semver = require("@storybook/semver");
-
-var _crossSpawn = require("cross-spawn");
-
-var _helpers = require("../helpers");
-
-var _PackageJsonHelper = require("./PackageJsonHelper");
-
-var _versions = _interopRequireDefault(require("../versions"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+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
@@ -30,7 +13,7 @@ const logger = console;
  * @return A tuple of 2 elements: [packageName, packageVersion]
  */
 
-function getPackageDetails(pkg) {
+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
 
@@ -42,21 +25,23 @@ function getPackageDetails(pkg) {
   const packageVersion = pkg.slice(idx + 1);
   return [packageName, packageVersion];
 }
-
-class JsPackageManager {
-  constructor() {
+export class JsPackageManager {
+  constructor(options) {
     this.type = void 0;
+    this.cwd = void 0;
+    this.cwd = options?.cwd;
   }
-
   /**
    * Install dependencies listed in `package.json`
    */
+
+
   installDependencies() {
-    let done = (0, _helpers.commandLog)('Preparing to install dependencies');
+    let done = commandLog('Preparing to install dependencies');
     done();
     logger.log();
     logger.log();
-    done = (0, _helpers.commandLog)('Installing dependencies');
+    done = commandLog('Installing dependencies');
 
     try {
       this.runInstall();
@@ -67,6 +52,26 @@ class JsPackageManager {
 
     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.
@@ -77,10 +82,10 @@ class JsPackageManager {
     let packageJson;
 
     try {
-      packageJson = (0, _PackageJsonHelper.readPackageJson)();
+      packageJson = this.readPackageJson();
     } catch (err) {
       this.initPackageJson();
-      packageJson = (0, _PackageJsonHelper.readPackageJson)();
+      packageJson = this.readPackageJson();
     }
 
     return Object.assign({}, packageJson, {
@@ -125,7 +130,7 @@ class JsPackageManager {
         packageJson.dependencies = Object.assign({}, packageJson.dependencies, dependenciesMap);
       }
 
-      (0, _PackageJsonHelper.writePackageJson)(packageJson);
+      this.writePackageJson(packageJson);
     } else {
       try {
         this.runAddDeps(dependencies, options.installAsDevDependencies);
@@ -136,6 +141,48 @@ class JsPackageManager {
       }
     }
   }
+  /**
+   * 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>`
    *
@@ -178,7 +225,7 @@ class JsPackageManager {
 
     if (/(@storybook|^sb$|^storybook$)/.test(packageName)) {
       // @ts-ignore
-      current = _versions.default[packageName];
+      current = storybookPackagesVersions[packageName];
     }
 
     let latest;
@@ -187,15 +234,15 @@ class JsPackageManager {
       latest = await this.latestVersion(packageName, constraint);
     } catch (e) {
       if (current) {
-        logger.warn(`\n     ${_chalk.default.yellow(e.message)}`);
+        logger.warn(`\n     ${chalk.yellow(e.message)}`);
         return current;
       }
 
-      logger.error(`\n     ${_chalk.default.red(e.message)}`);
+      logger.error(`\n     ${chalk.red(e.message)}`);
       process.exit(1);
     }
 
-    const versionToUse = current && (!constraint || (0, _semver.satisfies)(current, constraint)) && (0, _semver.gt)(current, latest) ? current : latest;
+    const versionToUse = current && (!constraint || satisfies(current, constraint)) && gt(current, latest) ? current : latest;
     return `^${versionToUse}`;
   }
   /**
@@ -214,16 +261,14 @@ class JsPackageManager {
 
     const versions = await this.runGetVersions(packageName, true); // Get the latest version satisfying the constraint
 
-    return versions.reverse().find(version => (0, _semver.satisfies)(version, constraint));
+    return versions.reverse().find(version => satisfies(version, constraint));
   }
 
   addStorybookCommandInScripts(options) {
-    var _options$port;
-
-    const sbPort = (_options$port = options === null || options === void 0 ? void 0 : options.port) !== null && _options$port !== void 0 ? _options$port : 6006;
-    const storybookCmd = options !== null && options !== void 0 && options.staticFolder ? `npx sb dev -p ${sbPort} -s ${options.staticFolder}` : `npx sb dev -p ${sbPort}`;
-    const buildStorybookCmd = options !== null && options !== void 0 && options.staticFolder ? `npx sb build -s ${options.staticFolder}` : `npx sb build`;
-    const preCommand = options !== null && options !== void 0 && options.preCommand ? this.getRunCommand(options.preCommand) : undefined;
+    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(' && ')
@@ -231,12 +276,10 @@ class JsPackageManager {
   }
 
   addESLintConfig() {
-    var _packageJson$eslintCo;
-
     const packageJson = this.retrievePackageJson();
-    (0, _PackageJsonHelper.writePackageJson)(Object.assign({}, packageJson, {
+    this.writePackageJson(Object.assign({}, packageJson, {
       eslintConfig: Object.assign({}, packageJson.eslintConfig, {
-        overrides: [...(((_packageJson$eslintCo = packageJson.eslintConfig) === null || _packageJson$eslintCo === void 0 ? void 0 : _packageJson$eslintCo.overrides) || []), {
+        overrides: [...(packageJson.eslintConfig?.overrides || []), {
           files: ['**/*.stories.*'],
           rules: {
             'import/no-anonymous-default-export': 'off'
@@ -248,28 +291,29 @@ class JsPackageManager {
 
   addScripts(scripts) {
     const packageJson = this.retrievePackageJson();
-    (0, _PackageJsonHelper.writePackageJson)(Object.assign({}, packageJson, {
+    this.writePackageJson(Object.assign({}, packageJson, {
       scripts: Object.assign({}, packageJson.scripts, scripts)
     }));
   }
 
-  executeCommand(command, args, stdio) {
-    var _commandResult$stdout;
+  addPackageResolutions(versions) {
+    const packageJson = this.retrievePackageJson();
+    const resolutions = this.getResolutions(packageJson, versions);
+    this.writePackageJson(Object.assign({}, packageJson, resolutions));
+  }
 
-    const commandResult = (0, _crossSpawn.sync)(command, args, {
-      stdio: stdio !== null && stdio !== void 0 ? stdio : 'pipe',
+  executeCommand(command, args, stdio) {
+    const commandResult = spawnSync(command, args, {
+      cwd: this.cwd,
+      stdio: stdio ?? 'pipe',
       encoding: 'utf-8'
     });
 
     if (commandResult.status !== 0) {
-      var _commandResult$stderr;
-
-      throw new Error((_commandResult$stderr = commandResult.stderr) !== null && _commandResult$stderr !== void 0 ? _commandResult$stderr : '');
+      throw new Error(commandResult.stderr ?? '');
     }
 
-    return (_commandResult$stdout = commandResult.stdout) !== null && _commandResult$stdout !== void 0 ? _commandResult$stdout : '';
+    return commandResult.stdout ?? '';
   }
 
-}
-
-exports.JsPackageManager = JsPackageManager;
+}

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

@@ -1,36 +1,34 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.JsPackageManagerFactory = void 0;
-
-var _crossSpawn = require("cross-spawn");
-
-var _findUp = require("find-up");
-
-var _NPMProxy = require("./NPMProxy");
-
-var _Yarn2Proxy = require("./Yarn2Proxy");
-
-var _Yarn1Proxy = require("./Yarn1Proxy");
-
-class JsPackageManagerFactory {
-  static getPackageManager(forceNpmUsage = false) {
+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.NPMProxy();
+      return new NPMProxy({
+        cwd
+      });
     }
 
-    const yarnVersion = getYarnVersion();
-    const hasYarnLockFile = (0, _findUp.sync)('yarn.lock');
-    const hasNPMCommand = hasNPM();
+    const yarnVersion = getYarnVersion(cwd);
+    const hasYarnLockFile = findUpSync('yarn.lock', {
+      cwd
+    });
+    const hasNPMCommand = hasNPM(cwd);
 
     if (yarnVersion && (hasYarnLockFile || !hasNPMCommand)) {
-      return yarnVersion === 1 ? new _Yarn1Proxy.Yarn1Proxy() : new _Yarn2Proxy.Yarn2Proxy();
+      return yarnVersion === 1 ? new Yarn1Proxy({
+        cwd
+      }) : new Yarn2Proxy({
+        cwd
+      });
     }
 
     if (hasNPMCommand) {
-      return new _NPMProxy.NPMProxy();
+      return new NPMProxy({
+        cwd
+      });
     }
 
     throw new Error('Unable to find a usable package manager within NPM, Yarn and Yarn 2');
@@ -38,15 +36,17 @@ class JsPackageManagerFactory {
 
 }
 
-exports.JsPackageManagerFactory = JsPackageManagerFactory;
-
-function hasNPM() {
-  const npmVersionCommand = (0, _crossSpawn.sync)('npm', ['--version']);
+function hasNPM(cwd) {
+  const npmVersionCommand = spawnSync('npm', ['--version'], {
+    cwd
+  });
   return npmVersionCommand.status === 0;
 }
 
-function getYarnVersion() {
-  const yarnVersionCommand = (0, _crossSpawn.sync)('yarn', ['--version']);
+function getYarnVersion(cwd) {
+  const yarnVersionCommand = spawnSync('yarn', ['--version'], {
+    cwd
+  });
 
   if (yarnVersionCommand.status !== 0) {
     return undefined;

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

@@ -1,21 +1,11 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.NPMProxy = void 0;
-
-var _semver = _interopRequireDefault(require("@storybook/semver"));
-
-var _JsPackageManager = require("./JsPackageManager");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class NPMProxy extends _JsPackageManager.JsPackageManager {
+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() {
@@ -30,15 +20,58 @@ class NPMProxy extends _JsPackageManager.JsPackageManager {
     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) {
-      const version = this.executeCommand('npm', ['--version']);
-      this.installArgs = _semver.default.gte(version, '7.0.0') ? ['install', '--legacy-peer-deps'] : ['install'];
+      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;
+  }
+
+  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;
+  }
+
+  getResolutions(packageJson, versions) {
+    return {
+      overrides: Object.assign({}, packageJson.overrides, versions)
+    };
+  }
+
   runInstall() {
     this.executeCommand('npm', this.getInstallArgs(), 'inherit');
   }
@@ -53,6 +86,11 @@ class NPMProxy extends _JsPackageManager.JsPackageManager {
     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]);
@@ -71,6 +109,4 @@ class NPMProxy extends _JsPackageManager.JsPackageManager {
     }
   }
 
-}
-
-exports.NPMProxy = NPMProxy;
+}

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

@@ -1,5 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+export {};

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

@@ -1,13 +1,5 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Yarn1Proxy = void 0;
-
-var _JsPackageManager = require("./JsPackageManager");
-
-class Yarn1Proxy extends _JsPackageManager.JsPackageManager {
+import { JsPackageManager } from './JsPackageManager';
+export class Yarn1Proxy extends JsPackageManager {
   constructor(...args) {
     super(...args);
     this.type = 'yarn1';
@@ -25,6 +17,25 @@ class Yarn1Proxy extends _JsPackageManager.JsPackageManager {
     return `yarn ${command}`;
   }
 
+  setRegistryURL(url) {
+    if (url) {
+      this.executeCommand('yarn', ['config', 'set', 'npmRegistryServer', url]);
+    } else {
+      this.executeCommand('yarn', ['config', 'delete', 'npmRegistryServer']);
+    }
+  }
+
+  getRegistryURL() {
+    const url = this.executeCommand('yarn', ['config', 'get', 'npmRegistryServer']).trim();
+    return url === 'undefined' ? undefined : url;
+  }
+
+  getResolutions(packageJson, versions) {
+    return {
+      resolutions: Object.assign({}, packageJson.resolutions, versions)
+    };
+  }
+
   runInstall() {
     this.executeCommand('yarn', [], 'inherit');
   }
@@ -39,6 +50,11 @@ class Yarn1Proxy extends _JsPackageManager.JsPackageManager {
     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]);
@@ -56,6 +72,4 @@ class Yarn1Proxy extends _JsPackageManager.JsPackageManager {
     }
   }
 
-}
-
-exports.Yarn1Proxy = Yarn1Proxy;
+}

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

@@ -1,13 +1,5 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Yarn2Proxy = void 0;
-
-var _JsPackageManager = require("./JsPackageManager");
-
-class Yarn2Proxy extends _JsPackageManager.JsPackageManager {
+import { JsPackageManager } from './JsPackageManager';
+export class Yarn2Proxy extends JsPackageManager {
   constructor(...args) {
     super(...args);
     this.type = 'yarn2';
@@ -25,6 +17,25 @@ class Yarn2Proxy extends _JsPackageManager.JsPackageManager {
     return `yarn ${command}`;
   }
 
+  setRegistryURL(url) {
+    if (url) {
+      this.executeCommand('yarn', ['config', 'set', 'npmRegistryServer', url]);
+    } else {
+      this.executeCommand('yarn', ['config', 'delete', 'npmRegistryServer']);
+    }
+  }
+
+  getRegistryURL() {
+    const url = this.executeCommand('yarn', ['config', 'get', 'npmRegistryServer']).trim();
+    return url === 'undefined' ? undefined : url;
+  }
+
+  getResolutions(packageJson, versions) {
+    return {
+      resolutions: Object.assign({}, packageJson.resolutions, versions)
+    };
+  }
+
   runInstall() {
     this.executeCommand('yarn', [], 'inherit');
   }
@@ -39,6 +50,11 @@ class Yarn2Proxy extends _JsPackageManager.JsPackageManager {
     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'];
@@ -52,6 +68,4 @@ class Yarn2Proxy extends _JsPackageManager.JsPackageManager {
     }
   }
 
-}
-
-exports.Yarn2Proxy = Yarn2Proxy;
+}

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

@@ -1,57 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _JsPackageManagerFactory = require("./JsPackageManagerFactory");
-
-Object.keys(_JsPackageManagerFactory).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _JsPackageManagerFactory[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _JsPackageManagerFactory[key];
-    }
-  });
-});
-
-var _JsPackageManager = require("./JsPackageManager");
-
-Object.keys(_JsPackageManager).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _JsPackageManager[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _JsPackageManager[key];
-    }
-  });
-});
-
-var _PackageJson = require("./PackageJson");
-
-Object.keys(_PackageJson).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _PackageJson[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _PackageJson[key];
-    }
-  });
-});
-
-var _PackageJsonHelper = require("./PackageJsonHelper");
-
-Object.keys(_PackageJsonHelper).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _PackageJsonHelper[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _PackageJsonHelper[key];
-    }
-  });
-});
+export * from './JsPackageManagerFactory';
+export * from './JsPackageManager';
+export * from './PackageJson';