eslint-cdk-plugin

インストール

以下のコマンドを実行してインストールします。

npm

npm install -D eslint-cdk-plugin

yarn

yarn add -D eslint-cdk-plugin

pnpm

pnpm install -D eslint-cdk-plugin

eslint の設定

eslint.config.mjs を以下のように記述します。

🚨 このプラグインは FlatConfig のみをサポートしています。
❓ FlatConfig とは?

このプラグインは型情報を使用するため、typescript-eslint と一緒に使用することを推奨します。

// eslint.config.mjs
import eslint from "@eslint/js";
import tsEslint from "typescript-eslint";
import eslintCdkPlugin from "eslint-cdk-plugin";

export default [
  eslint.configs.recommended,
  ...tsEslint.configs.recommended,
  ...tsEslint.configs.stylistic,
  {
    plugins: {
      cdk: eslintCdkPlugin,
    },
    rules: {
      ...eslintCdkPlugin.configs.recommended.rules,
    },
  },
];

ルールのカスタマイズ

ルールをカスタマイズしたい場合は、eslint.config.mjs を以下のように記述します。

// eslint.config.mjs
import eslint from "@eslint/js";
import tsEslint from "typescript-eslint";
import eslintCdkPlugin from "eslint-cdk-plugin";

export default [
  eslint.configs.recommended,
  ...tsEslint.configs.recommended,
  ...tsEslint.configs.stylistic,
  {
    plugins: {
      cdk: eslintCdkPlugin,
    },
    rules: {
      ...eslintCdkPlugin.configs.recommended.rules,
      "cdk/no-public-class-fields": "warn",
    },
  },
];