@storybook/cli 7.0.0-alpha.3 → 7.0.0-alpha.33

package/dist/esm/generators/baseGenerator.js

@@ -1,204 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.baseGenerator = baseGenerator;
-
-require("core-js/modules/es.promise.js");
-
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-var _project_types = require("../project_types");
-
-var _helpers = require("../helpers");
-
-var _configure = require("./configure");
-
-var _jsPackageManager = require("../js-package-manager");
-
-var _babelConfig = require("../babel-config");
-
-var _versions = _interopRequireDefault(require("../versions"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const defaultOptions = {
-  extraPackages: [],
-  extraAddons: [],
-  staticDir: undefined,
-  addScripts: true,
-  addComponents: true,
-  addBabel: true,
-  addESLint: false,
-  extraMain: undefined,
-  extensions: undefined,
-  commonJs: false
-};
-
-const getBuilderDetails = builder => {
-  const map = _versions.default;
-
-  if (map[builder]) {
-    return builder;
-  }
-
-  const builderPackage = `@storybook/${builder}`;
-
-  if (map[builderPackage]) {
-    return builderPackage;
-  }
-
-  return builder;
-};
-
-const wrapForPnp = packageName => `%%path.dirname(require.resolve(path.join('${packageName}', 'package.json')))%%`;
-
-const getFrameworkDetails = (renderer, builder, pnp) => {
-  const frameworkPackage = `@storybook/${renderer}-${builder}`;
-  const frameworkPackagePath = pnp ? wrapForPnp(frameworkPackage) : frameworkPackage;
-  const rendererPackage = `@storybook/${renderer}`;
-  const rendererPackagePath = pnp ? wrapForPnp(rendererPackage) : rendererPackage;
-  const builderPackage = getBuilderDetails(builder);
-  const builderPackagePath = pnp ? wrapForPnp(builderPackage) : builderPackage;
-  const isKnownFramework = !!_versions.default[frameworkPackage];
-  const isKnownRenderer = !!_versions.default[rendererPackage];
-
-  if (renderer === 'angular') {
-    return {
-      packages: [rendererPackage],
-      framework: rendererPackagePath,
-      type: 'framework'
-    };
-  }
-
-  if (isKnownFramework) {
-    return {
-      packages: [frameworkPackage],
-      framework: frameworkPackagePath,
-      type: 'framework'
-    };
-  }
-
-  if (isKnownRenderer) {
-    return {
-      packages: [rendererPackage, builderPackage],
-      builder: builderPackagePath,
-      renderer: rendererPackagePath,
-      type: 'renderer'
-    };
-  }
-
-  throw new Error(`Could not find the framework (${frameworkPackage}) or renderer (${rendererPackage}) package`);
-};
-
-const stripVersions = addons => addons.map(addon => (0, _jsPackageManager.getPackageDetails)(addon)[0]);
-
-const hasInteractiveStories = framework => ['react', 'angular', 'preact', 'svelte', 'vue', 'vue3', 'html'].includes(framework);
-
-async function baseGenerator(packageManager, npmOptions, {
-  language,
-  builder = _project_types.CoreBuilder.Webpack5,
-  pnp
-}, renderer, options = defaultOptions) {
-  const {
-    extraAddons: extraAddonPackages,
-    extraPackages,
-    staticDir,
-    addScripts,
-    addComponents,
-    addBabel,
-    addESLint,
-    extraMain,
-    extensions
-  } = Object.assign({}, defaultOptions, options); // added to main.js
-  // make sure to update `canUsePrebuiltManager` in dev-server.js and build-manager-config/main.js when this list changes
-
-  const addons = ['@storybook/addon-links', '@storybook/addon-essentials', ...stripVersions(extraAddonPackages)]; // added to package.json
-
-  const addonPackages = ['@storybook/addon-links', '@storybook/addon-essentials', '@storybook/addon-actions', ...extraAddonPackages];
-
-  if (hasInteractiveStories(renderer)) {
-    addons.push('@storybook/addon-interactions');
-    addonPackages.push('@storybook/addon-interactions', '@storybook/testing-library');
-  }
-
-  const yarn2ExtraPackages = packageManager.type === 'yarn2' ? ['@storybook/addon-docs', '@mdx-js/react@1.x.x'] : [];
-  const files = await _fsExtra.default.readdir(process.cwd());
-  const packageJson = packageManager.retrievePackageJson();
-  const installedDependencies = new Set(Object.keys(Object.assign({}, packageJson.dependencies, packageJson.devDependencies)));
-  const {
-    packages: frameworkPackages,
-    type,
-    // @ts-ignore
-    renderer: rendererInclude,
-    framework: frameworkInclude,
-    builder: builderInclude
-  } = getFrameworkDetails(renderer, builder, pnp); // TODO: We need to start supporting this at some point
-
-  if (type === 'renderer') {
-    throw new Error((0, _tsDedent.default)`
-        Sorry, for now, you can not do this, please use a framework such as @storybook/react-webpack5
-
-        https://github.com/storybookjs/storybook/issues/18360
-      `);
-  }
-
-  const packages = ['storybook', ...frameworkPackages, ...addonPackages, ...extraPackages, ...yarn2ExtraPackages].filter(Boolean).filter(packageToInstall => !installedDependencies.has((0, _jsPackageManager.getPackageDetails)(packageToInstall)[0]));
-  const versionedPackages = await packageManager.getVersionedPackages(packages);
-  await _fsExtra.default.ensureDir('./.storybook');
-  await (0, _configure.configureMain)(Object.assign({
-    framework: {
-      name: frameworkInclude,
-      options: {}
-    },
-    addons: pnp ? addons.map(wrapForPnp) : addons,
-    extensions,
-    commonJs: options.commonJs
-  }, extraMain, type !== 'framework' ? {
-    core: {
-      builder: builderInclude
-    }
-  } : {}));
-  await (0, _configure.configurePreview)(renderer, options.commonJs);
-
-  if (addComponents) {
-    (0, _helpers.copyComponents)(renderer, language);
-  } // FIXME: temporary workaround for https://github.com/storybookjs/storybook/issues/17516
-
-
-  if (frameworkPackages.includes('@storybook/builder-vite')) {
-    const previewHead = (0, _tsDedent.default)`
-      <script>
-        window.global = window;
-      </script>
-    `;
-    await _fsExtra.default.writeFile(`.storybook/preview-head.html`, previewHead, {
-      encoding: 'utf8'
-    });
-  }
-
-  const babelDependencies = addBabel ? await (0, _helpers.getBabelDependencies)(packageManager, packageJson) : [];
-  const isNewFolder = !files.some(fname => fname.startsWith('.babel') || fname.startsWith('babel') || fname === 'package.json');
-
-  if (isNewFolder) {
-    await (0, _babelConfig.generateStorybookBabelConfigInCWD)();
-  }
-
-  packageManager.addDependencies(Object.assign({}, npmOptions, {
-    packageJson
-  }), [...versionedPackages, ...babelDependencies]);
-
-  if (addScripts) {
-    packageManager.addStorybookCommandInScripts({
-      port: 6006,
-      staticFolder: staticDir
-    });
-  }
-
-  if (addESLint) {
-    packageManager.addESLintConfig();
-  }
-}

package/dist/esm/generators/configure.js

@@ -1,85 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.configureMain = configureMain;
-exports.configurePreview = configurePreview;
-
-require("core-js/modules/es.promise.js");
-
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-const _excluded = ["addons", "extensions", "commonJs"];
-
-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; }
-
-async function configureMain(_ref) {
-  let {
-    addons,
-    extensions = ['js', 'jsx', 'ts', 'tsx'],
-    commonJs = false
-  } = _ref,
-      custom = _objectWithoutPropertiesLoose(_ref, _excluded);
-
-  const prefix = (await _fsExtra.default.pathExists('./src')) ? '../src' : '../stories';
-  const config = Object.assign({
-    stories: [`${prefix}/**/*.stories.mdx`, `${prefix}/**/*.stories.@(${extensions.join('|')})`],
-    addons
-  }, custom); // replace escaped values and delimiters
-
-  const stringified = `module.exports = ${JSON.stringify(config, null, 2).replace(/\\"/g, '"').replace(/['"]%%/g, '').replace(/%%['"]/g, '').replace(/\\n/g, '\r\n')}`; // main.js isn't actually JSON, but we used JSON.stringify to convert the runtime-object into code.
-  // un-stringify the value for referencing packages by string
-  // .replaceAll(/"(path\.dirname\(require\.resolve\(path\.join\('.*\))"/g, (_, a) => a)}`;
-
-  await _fsExtra.default.writeFile(`./.storybook/main.${commonJs ? 'cjs' : 'js'}`, (0, _tsDedent.default)`
-      const path = require('path');
-      ${stringified}
-    `, {
-    encoding: 'utf8'
-  });
-}
-
-const frameworkToPreviewParts = {
-  angular: {
-    prefix: (0, _tsDedent.default)`
-      import { setCompodocJson } from "@storybook/addon-docs/angular";
-      import docJson from "../documentation.json";
-      setCompodocJson(docJson);
-      
-      `.trimStart(),
-    extraParameters: 'docs: { inlineStories: true },'
-  }
-};
-
-async function configurePreview(framework, commonJs) {
-  const {
-    prefix = '',
-    extraParameters = ''
-  } = frameworkToPreviewParts[framework] || {};
-  const previewPath = `./.storybook/preview.${commonJs ? 'cjs' : 'js'}`; // If the framework template included a preview then we have nothing to do
-
-  if (await _fsExtra.default.pathExists(previewPath)) {
-    return;
-  }
-
-  const preview = (0, _tsDedent.default)`
-    ${prefix}
-    export const parameters = {
-      actions: { argTypesRegex: "^on[A-Z].*" },
-      controls: {
-        matchers: {
-          color: /(background|color)$/i,
-          date: /Date$/,
-        },
-      },
-      ${extraParameters}
-    }`.replace('  \n', '').trim();
-  await _fsExtra.default.writeFile(previewPath, preview, {
-    encoding: 'utf8'
-  });
-}

package/dist/esm/generators/types.js

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

package/dist/esm/helpers.js

@@ -1,237 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.addToDevDependenciesIfNotPresent = addToDevDependenciesIfNotPresent;
-exports.codeLog = codeLog;
-exports.commandLog = void 0;
-exports.copyComponents = copyComponents;
-exports.copyTemplate = copyTemplate;
-exports.getBabelDependencies = getBabelDependencies;
-exports.getBowerJson = getBowerJson;
-exports.getChars = getChars;
-exports.paddedLog = paddedLog;
-exports.readFileAsJson = readFileAsJson;
-exports.writeFileAsJson = void 0;
-
-require("core-js/modules/es.promise.js");
-
-var _path = _interopRequireDefault(require("path"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _semver = require("@storybook/semver");
-
-var _stripJsonComments = _interopRequireDefault(require("strip-json-comments"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/* eslint-disable no-param-reassign */
-const logger = console;
-
-function getBowerJson() {
-  const bowerJsonPath = _path.default.resolve('bower.json');
-
-  if (!_fs.default.existsSync(bowerJsonPath)) {
-    return false;
-  }
-
-  const jsonContent = _fs.default.readFileSync(bowerJsonPath, 'utf8');
-
-  return JSON.parse(jsonContent);
-}
-
-function readFileAsJson(jsonPath, allowComments) {
-  const filePath = _path.default.resolve(jsonPath);
-
-  if (!_fs.default.existsSync(filePath)) {
-    return false;
-  }
-
-  const fileContent = _fs.default.readFileSync(filePath, 'utf8');
-
-  const jsonContent = allowComments ? (0, _stripJsonComments.default)(fileContent) : fileContent;
-
-  try {
-    return JSON.parse(jsonContent);
-  } catch (e) {
-    logger.error(_chalk.default.red(`Invalid json in file: ${filePath}`));
-    throw e;
-  }
-}
-
-const writeFileAsJson = (jsonPath, content) => {
-  const filePath = _path.default.resolve(jsonPath);
-
-  if (!_fs.default.existsSync(filePath)) {
-    return false;
-  }
-
-  _fs.default.writeFileSync(filePath, `${JSON.stringify(content, null, 2)}\n`);
-
-  return true;
-};
-
-exports.writeFileAsJson = writeFileAsJson;
-
-const commandLog = message => {
-  process.stdout.write(_chalk.default.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.default.red('✖')}\n`);
-      logger.error(`\n     ${_chalk.default.red(errorMessage)}`);
-
-      if (!errorInfo) {
-        return;
-      }
-
-      const newErrorInfo = errorInfo.split('\n').map(line => `     ${_chalk.default.dim(line)}`).join('\n');
-      logger.error(`${newErrorInfo}\n`);
-      return;
-    }
-
-    process.stdout.write(`. ${_chalk.default.green('✓')}\n`);
-  };
-};
-
-exports.commandLog = commandLog;
-
-function paddedLog(message) {
-  const newMessage = message.split('\n').map(line => `    ${line}`).join('\n');
-  logger.log(newMessage);
-}
-
-function getChars(char, amount) {
-  let line = '';
-
-  for (let lc = 0; lc < amount; lc += 1) {
-    line += char;
-  }
-
-  return line;
-}
-
-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.default.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,
- * ]);
- */
-
-
-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 ((0, _semver.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;
-}
-
-function addToDevDependenciesIfNotPresent(packageJson, name, packageVersion) {
-  if (!packageJson.dependencies[name] && !packageJson.devDependencies[name]) {
-    packageJson.devDependencies[name] = packageVersion;
-  }
-}
-
-function copyTemplate(templateRoot) {
-  const templateDir = _path.default.resolve(templateRoot, `template-csf/`);
-
-  if (!_fs.default.existsSync(templateDir)) {
-    throw new Error(`Couldn't find template dir`);
-  }
-
-  _fsExtra.default.copySync(templateDir, '.', {
-    overwrite: true
-  });
-}
-
-async function copyComponents(framework, language) {
-  const languageFolderMapping = {
-    javascript: 'js',
-    typescript: 'ts'
-  };
-
-  const componentsPath = async () => {
-    const frameworkPath = `frameworks/${framework}`;
-
-    const languageSpecific = _path.default.resolve(__dirname, `${frameworkPath}/${languageFolderMapping[language]}`);
-
-    if (await _fsExtra.default.pathExists(languageSpecific)) {
-      return languageSpecific;
-    }
-
-    const jsFallback = _path.default.resolve(__dirname, `${frameworkPath}/${languageFolderMapping.javascript}`);
-
-    if (await _fsExtra.default.pathExists(jsFallback)) {
-      return jsFallback;
-    }
-
-    const frameworkRootPath = _path.default.resolve(__dirname, frameworkPath);
-
-    if (await _fsExtra.default.pathExists(frameworkRootPath)) {
-      return frameworkRootPath;
-    }
-
-    throw new Error(`Unsupported framework: ${framework}`);
-  };
-
-  const targetPath = async () => {
-    if (await _fsExtra.default.pathExists('./src')) {
-      return './src/stories';
-    }
-
-    return './stories';
-  };
-
-  const destinationPath = await targetPath();
-  await _fsExtra.default.copy(await componentsPath(), destinationPath, {
-    overwrite: true
-  });
-  await _fsExtra.default.copy(_path.default.resolve(__dirname, 'frameworks/common'), destinationPath, {
-    overwrite: true
-  });
-}