eslint config

@code-pushup/eslint-config

通过代码俯卧撑推荐ESLINT预设。

配置

堆	config	描述
	JavaScript	默认配置，适用于任何JavaScript/Typescript项目。
	打字稿	严格的打字稿项目的配置。
	节点	node.js项目的配置。
	角	角度项目的配置。
	ngrx	使用NGRX库为Angular项目进行配置。
	GraphQl	在Node.js中实现的GraphQL服务器的配置。
	笑话	使用开玩笑进行测试的项目配置。
	vitest	使用Vitest进行测试的项目配置。
	柏	使用柏树进行测试的项目配置。
	故事书	使用Storybook用于UI组件的项目配置。

某些配置扩展了其他配置，如下所示。因此，例如，扩展angular Config也隐式扩展了typescript和javascript配置。

 图BT;
    JavaScript（“ JavaScript”）
    打字稿（“打字稿”）
    节点（“节点”）
    角（“角”）
    ngrx（“ ngrx”）
    GraphQl（“ GraphQl”）
    Typescript-extends-> JavaScript
    节点 -  extends-> javaScript
    Angular  -  Extends-> typescript
    ngrx  -  extends->角度
    graphql  -  extends-> node

设置

要使用默认配置，请按照以下步骤：

1. 您必须首先安装所有所需的同行依赖项（如果还没有）：

   npm install -D eslint @eslint/js eslint-plugin-{functional,import,promise,sonarjs,unicorn} globals typescript-eslint

2. 使用以下方式安装@code-pushup/eslint-config

   npm install -D @code-pushup/eslint-config

3. 在您的ESLINT配置文件中包括默认配置（通常是eslint.config.js ）：

    import javascript from '@code-pushup/eslint-config/javascript.js' ;
   import tseslint from 'typescript-eslint' ;
   
   export default tseslint . config ( ... javascript ) ;

根据您的技术堆栈，您可能还希望扩展其他配置（上面列出）。这将需要安装其他同行依赖项。有关更多详细信息，请参阅您感兴趣使用的配置的设置文档。

？同行依赖

下面列出了@code-pushup/eslint-config使用的所有同行依赖项及其受支持的版本。仅需要默认配置的依赖项，而其他依赖性则是可选的。

	NPM软件包	版本	必需的
	eslint	^9.0.0	✅
	@eslint/js	^9.0.0	✅
	Eslint-Plugin功能	^7.0.0	✅
	Eslint-Plugin-Import	^2.31.0	✅
	Eslint-Import-resolver-typscript	^3.0.0
	Eslint-Plugin-Promise	>=6.4.0	✅
	Eslint-Plugin-Sonarjs	^1.0.4	✅
	Eslint-Plugin-Unicorn	>=50.0.0	✅
	全球群体	>=14.0.0	✅
	Typescript-Eslint	^8.0.0	✅
	@graphql-eslint/eslint-plugin	^3.0.0
	@ngrx/eslint-plugin	^18.0.0
	角 - eslint	^18.0.0
	Eslint-Plugin-Cypress	>=3.3.0
	Eslint-Plugin-Jest	^28.8.0
	Eslint-Plugin-Jest形成	^3.0.0
	Eslint-Plugin-N	>=17.0.0
	eslint-plugin-rxjs-X	>=0.6.0
	Eslint-Plugin Storybook	>=0.10.0
	Eslint-Plugin-Vitest	>=0.5.0

？测试替代

对于非生产代码，某些规则被禁用（或从错误降级为警告）。

这适用于匹配以下任何一个地球的文件路径：

• **/*.spec.?(c|m)[jt]s?(x)
• **/*.test.?(c|m)[jt]s?(x)
• **/__tests__/**/*.?(c|m)[jt]s?(x)
• **/__mocks__/**/*.?(c|m)[jt]s?(x)
• **/*.cy.?(c|m)[jt]s?(x)
• **/*.stories.?(c|m)[jt]s?(x)
• **/*.e2e.?(c|m)[jt]s?(x)
• **/*.mock.?(c|m)[jt]s?(x)
• **/*.mocks.?(c|m)[jt]s?(x)
• **/test/**/*.?(c|m)[jt]s?(x)
• **/tests/**/*.?(c|m)[jt]s?(x)
• **/mocks/**/*.?(c|m)[jt]s?(x)
• **/testing-utils/**/*.?(c|m)[jt]s?(x)
• **/test-utils/**/*.?(c|m)[jt]s?(x)
• **/fixtures/**/*.?(c|m)[jt]s?(x)
• **/*.config.?(c|m)[jt]s
• **/.prettierrc.?(c|m)[jt]s
• **/codegen.?(c|m)[jt]s
• **/test-setup.?(c|m)[jt]s

？贡献

Node.js安装是先决条件（LTS版本）。使用NPM安装依赖项：

npm install

执行测试：

npm test

生成文档：

npm run docs