@storybook/cli/dist/modern/automigrate/fixes/eslint-plugin.js

Storybook's CLI - easiest method of adding storybook to your projects

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.eslintPlugin = void 0;

require("core-js/modules/es.promise.js");

var _chalk = _interopRequireDefault(require("chalk"));

var _tsDedent = _interopRequireDefault(require("ts-dedent"));

var _csfTools = require("@storybook/csf-tools");

var _getEslintInfo = require("../helpers/getEslintInfo");

var _getStorybookInfo = require("../helpers/getStorybookInfo");

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

const logger = console;

/**
 * Does the user not have eslint-plugin-storybook installed?
 *
 * If so:
 * - Install it, and if possible configure it
 */
const eslintPlugin = {
  id: 'eslintPlugin',

  async check({
    packageManager
  }) {
    const packageJson = packageManager.retrievePackageJson();
    const {
      dependencies,
      devDependencies
    } = packageJson;
    const eslintPluginStorybook = dependencies['eslint-plugin-storybook'] || devDependencies['eslint-plugin-storybook'];
    const eslintDependency = dependencies.eslint || devDependencies.eslint;

    if (eslintPluginStorybook || !eslintDependency) {
      return null;
    }

    const config = (0, _getStorybookInfo.getStorybookInfo)(packageJson);
    const {
      mainConfig
    } = config;

    if (!mainConfig) {
      logger.warn('Unable to find storybook main.js config, skipping');
      return null;
    }

    let eslintFile;
    let unsupportedExtension;

    try {
      eslintFile = (0, _getEslintInfo.findEslintFile)();
    } catch (err) {
      unsupportedExtension = err.message;
    }

    if (!eslintFile && !unsupportedExtension) {
      logger.warn('Unable to find .eslintrc config file, skipping');
      return null;
    } // If in the future the eslint plugin has a framework option, using main to extract the framework field will be very useful


    const main = await (0, _csfTools.readConfig)(mainConfig);
    return {
      eslintFile,
      main,
      unsupportedExtension
    };
  },

  prompt() {
    return (0, _tsDedent.default)`
      We've detected you are not using our eslint-plugin.

      In order to have the best experience with Storybook and follow best practices, we advise you to install eslint-plugin-storybook.

      More info: ${_chalk.default.yellow('https://github.com/storybookjs/eslint-plugin-storybook#readme')}
    `;
  },

  async run({
    result: {
      eslintFile,
      unsupportedExtension
    },
    packageManager,
    dryRun
  }) {
    const deps = [`eslint-plugin-storybook`];
    logger.info(`✅ Adding dependencies: ${deps}`);
    if (!dryRun) packageManager.addDependencies({
      installAsDevDependencies: true
    }, deps);

    if (!dryRun && unsupportedExtension) {
      throw new Error((0, _tsDedent.default)`
          ⚠️ The plugin was successfuly installed but failed to configure.
          
          Found an .eslintrc config file with an unsupported automigration format: ${unsupportedExtension}.
          Supported formats for automigration are: ${_getEslintInfo.SUPPORTED_ESLINT_EXTENSIONS.join(', ')}.

          Please refer to https://github.com/storybookjs/eslint-plugin-storybook#usage to finish setting up the plugin manually.
      `);
    }

    const eslint = await (0, _csfTools.readConfig)(eslintFile);
    logger.info(`✅ Configuring eslint rules in ${eslint.fileName}`);

    if (!dryRun) {
      logger.info(`✅ Adding Storybook to extends list`);
      const extendsConfig = eslint.getFieldValue(['extends']) || [];
      const existingConfigValue = Array.isArray(extendsConfig) ? extendsConfig : [extendsConfig];
      eslint.setFieldValue(['extends'], [...existingConfigValue, 'plugin:storybook/recommended']);
      await (0, _csfTools.writeConfig)(eslint);
    }
  }

};
exports.eslintPlugin = eslintPlugin;