@guardian/eslint-config
用于Guardian JavaScript和TypeScript项目的ESLint配置.
安装
npm install --save-dev @guardian/eslint-config
# or
yarn add --dev @guardian/eslint-config
# or
pnpm install --save-dev @guardian/eslint-config
使用量
示例
// eslint.config.js
import guardian from '@guardian/eslint-config';
export default [
...guardian.configs.recommended,
...guardian.configs.jest,
...guardian.configs.react,
...guardian.configs.storybook,
];
配置
该软件包的默认导出是一个带有 configs 为不同项目提供配置的属性.
其中一些是单目的,而另一些则将单目的配置编成有用的预设.
configs.recommended
提供推荐的包含JavaScript和TypeScript两种配置的集合.
编曲 :
configs.javascriptconfigs.typescriptconfigs.importsconfigs.comments
configs.javascript
列入 configs.recommended。 。 。 .
提供用于检查JavaScript的配置集合,这些配置也应用于TypeScript文件.
它自动检测您的工程类型( 使用 package.json#type),并对每个文件使用适当的配置.
编曲 :
configs.esmconfigs.cjs
configs.esm
列入 configs.javascript。 。 。 .
提供ECMAScript模块的配置集合.
它假设所有的东西都会是ECMAScript,如果在普通JS模块中使用,就会出错.
configs.cjs
列入 configs.javascript。 。 。 .
提供通用JS模块的配置集合.
它假设所有的东西都会是CommonJS,如果在ECMAScript模块上使用,就会出错.
configs.typescript
列入 configs.recommended。 。 。 .
提供了用于检查 TypeScript 的配置集合 .
configs.imports
列入 configs.recommended。 。 。 .
提供一套配置材料,确保模块进出口方面的最佳做法.
configs.comments
列入 configs.recommended。 。 。 .
提供一套配置,确保围绕代码评论的最佳做法.
configs.jest
为检查Jest单元测试提供一组配置.
configs.react
提供用于检查 React 组件的配置集合 .
configs.storybook
提供一套用于检查故事本故事的配置 .
在使用故事书配置时, 一定要有 eslint-plugin-storybook 财务报告和审定财务报表 storybook 安装在您的工程中, 否则配置将被忽略 .