GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-01 05:05:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

CLI: support .json in eslint plugin migration

Browse Source
This commit is contained in:
Yann Braga 2022-10-17 14:19:04 +02:00
parent 77638cd959
commit e313b6ae0a
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
code/lib/cli/src/automigrate/fixes/eslint-plugin.ts
View File

@ -3,6 +3,7 @@ import { dedent } from 'ts-dedent';
import { ConfigFile, readConfig, writeConfig } from '@storybook/csf-tools'; import { ConfigFile, readConfig, writeConfig } from '@storybook/csf-tools';
import { getStorybookInfo } from '@storybook/core-common'; import { getStorybookInfo } from '@storybook/core-common';
import { readJson, writeJson } from 'fs-extra';
import { findEslintFile, SUPPORTED_ESLINT_EXTENSIONS } from '../helpers/getEslintInfo'; import { findEslintFile, SUPPORTED_ESLINT_EXTENSIONS } from '../helpers/getEslintInfo';
import type { Fix } from '../types'; import type { Fix } from '../types';
@ -89,16 +90,23 @@ export const eslintPlugin: Fix<EslintPluginRunOptions> = {
`); `);
} }
const eslint = await readConfig(eslintFile); logger.info(`✅ Adding Storybook plugin to ${eslintFile}`);
logger.info(`✅ Configuring eslint rules in ${eslint.fileName}`);
if (!dryRun) { if (!dryRun) {
logger.info(`✅ Adding Storybook to extends list`); if (eslintFile.endsWith('json')) {
const extendsConfig = eslint.getFieldValue(['extends']) || []; const eslintConfig = (await readJson(eslintFile)) as { extends?: string[] };
const existingConfigValue = Array.isArray(extendsConfig) ? extendsConfig : [extendsConfig]; const existingConfigValue = Array.isArray(eslintConfig.extends)
eslint.setFieldValue(['extends'], [...existingConfigValue, 'plugin:storybook/recommended']); ? eslintConfig.extends
: [eslintConfig.extends];
eslintConfig.extends = [...(existingConfigValue || []), 'plugin:storybook/recommended'];
await writeJson(eslintFile, eslintConfig, { spaces: 2 });
} else {
const eslint = await readConfig(eslintFile);
const extendsConfig = eslint.getFieldValue(['extends']) || [];
const existingConfigValue = Array.isArray(extendsConfig) ? extendsConfig : [extendsConfig];
eslint.setFieldValue(['extends'], [...existingConfigValue, 'plugin:storybook/recommended']);
await writeConfig(eslint); await writeConfig(eslint);
}
} }
}, },
}; };

4
code/lib/cli/src/automigrate/helpers/getEslintInfo.ts
View File

@ -1,7 +1,7 @@
import fse from 'fs-extra'; import fse from 'fs-extra';
export const SUPPORTED_ESLINT_EXTENSIONS = ['js', 'cjs']; export const SUPPORTED_ESLINT_EXTENSIONS = ['js', 'cjs', 'json'];
const UNSUPPORTED_ESLINT_EXTENSIONS = ['yaml', 'yml', 'json']; const UNSUPPORTED_ESLINT_EXTENSIONS = ['yaml', 'yml'];
export const findEslintFile = () => { export const findEslintFile = () => {
const filePrefix = '.eslintrc'; const filePrefix = '.eslintrc';