eslint config

@code-pushup/eslint-config

コード腕立て伏せによる推奨Eslintプリセット。

構成

スタック	config	説明
	JavaScript	JavaScript/TypeScriptプロジェクトに適したデフォルト設定。
	タイプスクリプト	厳格なタイプスクリプトプロジェクトの構成。
	ノード	node.jsプロジェクトの構成。
	角度	角度プロジェクトの構成。
	ngrx	NGRXライブラリを使用した角度プロジェクトの構成。
	graphql	node.jsに実装されたghraphqlサーバーの構成
	冗談	テストにJESTを使用したプロジェクトの構成。
	vitest	テストにVitestを使用したプロジェクトの構成。
	サイプレス	テストにサイプレスを使用したプロジェクトの構成。
	ストーリーブック	UIコンポーネント用のストーリーブックを使用したプロジェクトの構成。

一部の構成は、以下に示すように、他の構成を拡張します。したがって、たとえば、 angular構成を拡張すると、 typescriptとjavascriptの構成も暗黙的に拡張します。

 グラフbt;
    JavaScript（ "JavaScript"）
    TypeScript（ "TypeScript"）
    ノード（ "ノード"）
    Angular（ "Angular"）
    ngrx（ "ngrx"）
    graphql（ "graphql"）
    TypeScript -Extends-> JavaScript
    node -extends-> javascript
    Angular -Extends-> TypeScript
    ngrx -extends-> angular
    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 ) ;

Tech Stackに応じて、他の構成も拡張したい場合があります（上記）。これには、追加のピア依存関係をインストールする必要があります。詳細については、使用したい構成のセットアップドキュメントを参照してください。

？ピア依存関係

@code-pushup/eslint-configで使用されるすべてのピア依存関係は、サポートされているバージョンとともに以下にリストされています。デフォルトの構成の依存関係のみが必要であり、その他はオプションです。

	NPMパッケージ	バージョン	必須
	eslint	^9.0.0	✅
	@eslint/js	^9.0.0	✅
	Eslint-Plugin-Functional	^7.0.0	✅
	Eslint-Plugin-Import	^2.31.0	✅
	Eslint-Import-Resolver-Typescript	^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
	Angular-Eslint	^18.0.0
	Eslint-Plugin-Cypress	>=3.3.0
	Eslint-Plugin-Jest	^28.8.0
	Eslint-Plugin-Jest-Formatting	^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