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