eslint-plugin-awscdk

ESLint plugin for AWS CDK

📔 Documentation

Please refer to the website.

📦 Installation

# npm
npm install -D eslint-plugin-awscdk

# yarn
yarn add -D eslint-plugin-awscdk

# pnpm
pnpm install -D eslint-plugin-awscdk

🚀 Usage

Note: This plugin uses typescript type information and must be used in conjunction with typescript-eslint.

Flat Config

// eslint.config.mjs
import eslint from "@eslint/js";
import { defineConfig } from "eslint/config";
import tseslint from "typescript-eslint";
import cdkPlugin from "eslint-plugin-awscdk";

export default defineConfig([
  {
    files: ["lib/**/*.ts", "bin/*.ts"],
    extends: [
      eslint.configs.recommended,
      ...tseslint.configs.recommended,
      // ✅ Add plugins
      cdkPlugin.configs.recommended, // or cdkPlugin.configs.strict
    ],
    rules: {
      // ✅ Add rules (use custom rules)
      "awscdk/require-jsdoc": "warn",
    },
  },
]);

Classic Config

// .eslintrc.cjs
module.exports = {
  root: true,
  parser: "@typescript-eslint/parser",
  parserOptions: {
    sourceType: "module",
    project: "./tsconfig.json",
  },
  // ✅ Add plugins
  plugins: ["@typescript-eslint", "awscdk"],
  extends: [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended",
    // ✅ Add recommended config
    "plugin:awscdk/classicRecommended", // or "plugin:awscdk/classicStrict"
  ],
  rules: {
    // ✅ Add rules (use custom rules)
    "awscdk/require-jsdoc": "warn",
  },
};

📦 Package Name Migration Notice

Important: This package was previously published as eslint-cdk-plugin. Starting from v4.0.0, it has been renamed to eslint-plugin-awscdk to follow ESLint's official naming convention.

Migration Steps

1. Update eslint-cdk-plugin to latest version

# npm
npm install -D eslint-cdk-plugin@latest

# yarn
yarn add -D eslint-cdk-plugin@latest

# pnpm
pnpm install -D eslint-cdk-plugin@latest

2. execute migration command

npx migrate-cdk-plugin

The old package name will continue to receive updates until for a while , after which it will be deprecated.

❗ Issue

If you have any questions or suggestions, please open an issue.

💪 Contribution

Contributions are welcome! Please see Contribution Guide for more details.

⚓ Versioning Policy

Please see Versioning Policy.

©️ License

MIT