@wordpress/eslint-plugin

インストール

モジュールをインストールします

npm install @wordpress/eslint-plugin --save-dev

注意: このパッケージは、長期サポートステータスのあるNode.jsバージョンを必要とします（アクティブLTSまたはメンテナンスLTSリリースを確認）。古いバージョンとは互換性がありません。

使用法

デフォルト設定にオプトインするには、自分のプロジェクトの.eslintrcファイルを拡張します:

{
   "extends": [ "plugin:@wordpress/eslint-plugin/recommended" ]
}

詳細については、共有可能な設定に関するESLintのドキュメントを参照してください。

このプリセットは、[Prettier](https://prettier.io)コードフォーマッタを実行し、違いを個別のESLint問題として報告する[`````eslint-plugin-prettier`````](https://github.com/prettier/eslint-plugin-prettier)パッケージとのオプション統合を提供します。次のコマンドで[`````prettier`````](https://www.npmjs.com/package/prettier)パッケージを別途インストールすることで有効にできます:  
``````bash
npm install prettier --save-dev
`

最後に、このルールセットには、TypeScript言語をサポートするためにESLintを有効にする@typescript-eslint/eslint-pluginパッケージとのオプション統合も含まれています。次のコマンドでtypescriptパッケージを別途インストールすることで有効にできます:

npm install typescript --save-dev

また、[recommended-with-formatting]は、PrettierとTypeScriptの統合が決して有効にならないことを保証したいプロジェクトのためのルールセットです。このプリセットは、代わりにネイティブのESLintコードフォーマットルールが有効になっています。

ルールセット

代わりに、プラグインが提供するより詳細なルールセットにオプトインすることもできます。これには以下が含まれます:

• custom – WordPress開発のためのカスタムルール。
• es5 – レガシーES5環境のためのルール。
• esnext – ES2015+環境のためのルール。
• i18n – 国際化のためのルール。
• jsdoc – JSDocコメントのためのルール。
• jsx-a11y – JSXにおけるアクセシビリティのためのルール。
• react – Reactコンポーネントのためのルール。
• test-e2e – Puppeteerで書かれたエンドツーエンドテストのためのルール。
• test-unit – Jestで書かれたユニットテストのためのルール。
• test-playwright – Playwrightで書かれたエンドツーエンドテストのためのルール。

たとえば、プロジェクトがReactを使用していない場合、次のextends定義を使用してプロジェクトにESNextルールのみを含めることを検討できます:

{
   "extends": [ "plugin:@wordpress/eslint-plugin/esnext" ]
}

これらのルールは加算的に使用できるため、esnextとcustomの両方のルールセットを拡張できますが、reactとjsx-a11yの設定を省略することができます。

詳細なルールセットは、環境グローバルを定義しません。そのため、プロジェクトに必要な場合は、自分で定義する必要があります。

ルール

レガシー

WordPressの.jshintrc JSHint設定を使用していて、ESLintの同等物に移行する最初のステップを踏みたい場合は、自分のプロジェクトの.eslintrcファイルを次のように定義することも可能です:

{
   "extends": [ "plugin:@wordpress/eslint-plugin/jshint" ]
}

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。