📔 Documentation

https://awscdk-lint.dev/getting-started/oxlint/

📦 Installation

# npm
npm install -D oxlint-plugin-awscdk

# yarn
yarn add -D oxlint-plugin-awscdk

# pnpm
pnpm install -D oxlint-plugin-awscdk

🚀 Usage

oxlint.config.ts

// oxlint.config.ts
import { defineConfig } from "oxlint";
import cdkPlugin from "oxlint-plugin-awscdk";

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

.oxlintrc.json

{
  // ✅ Add plugins
  "jsPlugins": ["oxlint-plugin-awscdk"],
  "rules": {
    // ✅ Add rules
    "awscdk/construct-constructor-property": "error",
    "awscdk/no-construct-in-interface": "error",
    "awscdk/no-construct-in-public-property-of-construct": "error",
    "awscdk/no-construct-stack-suffix": "error",
    "awscdk/no-mutable-property-of-props-interface": "warn",
    "awscdk/no-mutable-public-property-of-construct": "warn",
    "awscdk/no-parent-name-construct-id-match": [
      "error",
      { "disallowContainingParentName": false },
    ],
    "awscdk/no-unused-props": "error",
    "awscdk/no-variable-construct-id": "error",
    "awscdk/pascal-case-construct-id": "error",
    "awscdk/prefer-grants-property": "warn",
    "awscdk/require-passing-this": ["error", { "allowNonThisAndDisallowScope": true }],
  },
}

📝 Rules

https://awscdk-lint.dev/rules/

❗ 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