Package Exports
- eslint-plugin-awscdk
Readme
eslint-plugin-awscdk
ESLint plugin for AWS CDK
đ Documentation
Please refer to the website.
đĻ Package Name Migration Notice
Important: This package was previously published as
eslint-cdk-plugin. Starting from v4.0.0, it has been renamed toeslint-plugin-awscdkto 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@latest2. execute migration command
npx migrate-cdk-pluginThe old package name will continue to receive updates until for a while , after which it will be deprecated.
đĻ 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",
},
};â 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.