eslint-plugin-awscdk 4.2.1 → 4.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-awscdk",
-  "version": "4.2.1",
+  "version": "4.3.2",
   "description": "eslint plugin for AWS CDK projects",
   "keywords": [
     "aws",
@@ -44,39 +44,28 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsdown",
-    "test": "vitest --run",
-    "test:integration": "sh scripts/integration-test.sh",
-    "lint": "eslint --fix",
-    "fmt": "oxfmt",
-    "fmt:check": "oxfmt --check",
-    "check": "tsgo --noEmit",
-    "pack": "pnpm run build && npm pack",
-    "docs": "pnpm run --filter=@eslint-plugin-awscdk/docs",
-    "example:flat-config": "pnpm run --filter=@eslint-plugin-awscdk/example-flat-config",
-    "example:classic-config": "pnpm run --filter=@eslint-plugin-awscdk/example-classic-config",
-    "example:oxlint": "pnpm run --filter=@eslint-plugin-awscdk/example-oxlint"
+    "pack": "vp pack",
+    "check": "vp check",
+    "test": "vp test --run",
+    "docs": "vp run -F @eslint-plugin-awscdk/docs"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@secretlint/secretlint-rule-preset-recommend": "^11.2.5",
     "@types/node": "^24.10.13",
-    "@typescript-eslint/parser": "^8.46.2",
-    "@typescript-eslint/rule-tester": "^8.46.2",
-    "@typescript-eslint/utils": "^8.46.2",
-    "@typescript/native-preview": "^7.0.0-dev.20250601",
+    "@typescript-eslint/parser": "^8.58.0",
+    "@typescript-eslint/rule-tester": "^8.58.0",
+    "@typescript-eslint/utils": "^8.58.0",
+    "@voidzero-dev/vite-plus-core": "^0.1.11",
     "eslint": "^10.0.0",
-    "eslint-plugin-import": "^2.32.0",
-    "oxfmt": "^0.32.0",
     "secretlint": "^11.2.5",
-    "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.56.0",
-    "vitest": "^4.0.6"
+    "typescript-eslint": "^8.58.0",
+    "vite-plus": "^0.1.11"
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0",
-    "typescript": ">=4.8.4 <6.0.0"
+    "typescript": ">=4.8.4 <6.1.0"
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"

package/src/configs/classic-config.ts

@@ -1,18 +1,18 @@
 import { ClassicConfig } from "@typescript-eslint/utils/ts-eslint";
 
-const createClassicConfig = (
-  rules: ClassicConfig.RulesRecord,
-): {
+type ClassicRulesConfig = {
   plugins: ["awscdk"];
   rules: ClassicConfig.RulesRecord;
-} => {
+};
+
+const createClassicConfig = (rules: ClassicConfig.RulesRecord): ClassicRulesConfig => {
   return {
     plugins: ["awscdk"],
     rules,
   };
 };
 
-export const recommended = createClassicConfig({
+export const recommended: ClassicRulesConfig = createClassicConfig({
   "awscdk/construct-constructor-property": "error",
   "awscdk/migrate-disable-comments": "error",
   "awscdk/no-construct-in-interface": "error",
@@ -28,7 +28,7 @@ export const recommended = createClassicConfig({
   "awscdk/require-passing-this": ["error", { allowNonThisAndDisallowScope: true }],
 });
 
-export const strict = createClassicConfig({
+export const strict: ClassicRulesConfig = createClassicConfig({
   "awscdk/construct-constructor-property": "error",
   "awscdk/migrate-disable-comments": "error",
   "awscdk/no-construct-in-interface": "error",
@@ -42,6 +42,7 @@ export const strict = createClassicConfig({
   "awscdk/no-variable-construct-id": "error",
   "awscdk/pascal-case-construct-id": "error",
   "awscdk/prefer-grants-property": "error",
+  "awscdk/prevent-construct-id-collision": "error",
   "awscdk/props-name-convention": "error",
   "awscdk/require-jsdoc": "error",
   "awscdk/require-passing-this": "error",

package/src/configs/flat-config.ts

@@ -30,7 +30,7 @@ const createFlatConfig = (rules: _FlatConfig.Rules): FlatConfig => {
   };
 };
 
-export const recommended = createFlatConfig({
+export const recommended: FlatConfig = createFlatConfig({
   "awscdk/construct-constructor-property": "error",
   "awscdk/migrate-disable-comments": "error",
   "awscdk/no-construct-in-interface": "error",
@@ -46,7 +46,7 @@ export const recommended = createFlatConfig({
   "awscdk/require-passing-this": ["error", { allowNonThisAndDisallowScope: true }],
 });
 
-export const strict = createFlatConfig({
+export const strict: FlatConfig = createFlatConfig({
   "awscdk/construct-constructor-property": "error",
   "awscdk/migrate-disable-comments": "error",
   "awscdk/no-construct-in-interface": "error",
@@ -60,6 +60,7 @@ export const strict = createFlatConfig({
   "awscdk/no-variable-construct-id": "error",
   "awscdk/pascal-case-construct-id": "error",
   "awscdk/prefer-grants-property": "error",
+  "awscdk/prevent-construct-id-collision": "error",
   "awscdk/props-name-convention": "error",
   "awscdk/require-jsdoc": "error",
   "awscdk/require-passing-this": "error",

package/src/configs/index.ts

@@ -1,7 +1,12 @@
 import { recommended as classicRecommended, strict as classicStrict } from "./classic-config";
 import { recommended, strict } from "./flat-config";
 
-export const configs = {
+export const configs: Readonly<{
+  recommended: typeof recommended;
+  strict: typeof strict;
+  classicRecommended: typeof classicRecommended;
+  classicStrict: typeof classicStrict;
+}> = {
   recommended,
   strict,
   classicRecommended,

package/src/core/cdk-construct/type-checker/is-resource-with-readonly-interface.ts

@@ -7,7 +7,6 @@ import {
 } from "typescript";
 
 import { isClassType } from "../../ts-type/checker/is-class";
-
 import { isResourceType } from "./is-resource";
 
 /**

package/src/rules/index.ts

@@ -1,3 +1,6 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { Rule } from "eslint";
+
 import { constructConstructorProperty } from "./construct-constructor-property";
 import { migrateDisableComments } from "./migrate-disable-comments";
 import { noConstructInInterface } from "./no-construct-in-interface";
@@ -11,12 +14,15 @@ import { noUnusedProps } from "./no-unused-props";
 import { noVariableConstructId } from "./no-variable-construct-id";
 import { pascalCaseConstructId } from "./pascal-case-construct-id";
 import { preferGrantsProperty } from "./prefer-grants-property";
+import { preventConstructIdCollision } from "./prevent-construct-id-collision";
 import { propsNameConvention } from "./props-name-convention";
 import { requireJSDoc } from "./require-jsdoc";
 import { requirePassingThis } from "./require-passing-this";
 import { requirePropsDefaultDoc } from "./require-props-default-doc";
 
-export const rules = {
+type RuleModule = TSESLint.RuleModule<string, readonly unknown[]> | Rule.RuleModule;
+
+export const rules: Record<string, RuleModule> = {
   "construct-constructor-property": constructConstructorProperty,
   "migrate-disable-comments": migrateDisableComments,
   "no-construct-in-interface": noConstructInInterface,
@@ -30,6 +36,7 @@ export const rules = {
   "no-variable-construct-id": noVariableConstructId,
   "pascal-case-construct-id": pascalCaseConstructId,
   "prefer-grants-property": preferGrantsProperty,
+  "prevent-construct-id-collision": preventConstructIdCollision,
   "props-name-convention": propsNameConvention,
   "require-jsdoc": requireJSDoc,
   "require-passing-this": requirePassingThis,

package/src/rules/no-import-private.ts

@@ -1,6 +1,5 @@
-import * as path from "path";
-
 import { Rule } from "eslint";
+import * as path from "path";
 
 /**
  * Disallow importing modules from private directories at different levels of the hierarchy.

package/src/rules/no-unused-props/index.ts

@@ -10,7 +10,6 @@ import { Type } from "typescript";
 import { findConstructor } from "../../core/ast-node/finder/constructor";
 import { isConstructType } from "../../core/cdk-construct/type-checker/is-construct";
 import { createRule } from "../../shared/create-rule";
-
 import { PropsUsageAnalyzer } from "./props-usage-analyzer";
 import { IPropsUsageTracker, PropsUsageTracker } from "./props-usage-tracker";
 

package/src/rules/no-unused-props/props-usage-analyzer.ts

@@ -14,7 +14,11 @@ export interface IPropsUsageAnalyzer {
 }
 
 export class PropsUsageAnalyzer implements IPropsUsageAnalyzer {
-  constructor(private readonly tracker: IPropsUsageTracker) {}
+  private readonly tracker: IPropsUsageTracker;
+
+  constructor(tracker: IPropsUsageTracker) {
+    this.tracker = tracker;
+  }
 
   analyze(constructor: TSESTree.MethodDefinition, propsParam: TSESTree.Identifier): void {
     const constructorBody = constructor.value.body;

package/src/rules/no-unused-props/visitor/direct-props-usage-visitor.ts

@@ -1,7 +1,6 @@
 import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
 
 import { IPropsUsageTracker } from "../props-usage-tracker";
-
 import { INodeVisitor } from "./interface/node-visitor";
 
 /**

package/src/rules/no-unused-props/visitor/instance-variable-usage-visitor.ts

@@ -1,7 +1,6 @@
 import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
 
 import { IPropsUsageTracker } from "../props-usage-tracker";
-
 import { INodeVisitor } from "./interface/node-visitor";
 
 /**

package/src/rules/no-unused-props/visitor/method-call-collector-visitor.ts

@@ -26,8 +26,11 @@ type MethodCallInfo = {
  */
 export class MethodCallCollectorVisitor implements INodeVisitor {
   private readonly _result: MethodCallInfo[] = [];
+  private readonly propsParamName: string;
 
-  constructor(private readonly propsParamName: string) {}
+  constructor(propsParamName: string) {
+    this.propsParamName = propsParamName;
+  }
 
   visitCallExpression(node: TSESTree.CallExpression): void {
     // NOTE: Check for this.methodName(...) pattern

package/src/rules/no-unused-props/visitor/props-alias-visitor.ts

@@ -1,7 +1,6 @@
 import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
 
 import { IPropsUsageTracker } from "../props-usage-tracker";
-
 import { INodeVisitor } from "./interface/node-visitor";
 
 /**

package/src/rules/no-unused-props/visitor/traverse-nodes.ts

@@ -1,7 +1,6 @@
 import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
 
 import { findChildNodes } from "../../../core/ast-node/finder/child-nodes";
-
 import { INodeVisitor } from "./interface/node-visitor";
 
 export const traverseNodes = (node: TSESTree.Node, visitor: INodeVisitor): void => {

package/src/rules/prevent-construct-id-collision.ts

@@ -0,0 +1,144 @@
+import { AST_NODE_TYPES, ESLintUtils, TSESTree } from "@typescript-eslint/utils";
+
+import { isConstructType } from "../core/cdk-construct/type-checker/is-construct";
+import { findConstructorPropertyNames } from "../core/ts-type/finder/constructor-property-name";
+import { createRule } from "../shared/create-rule";
+
+/**
+ * Prevent Construct ID collisions inside loops.
+ * Reports when a literal ID is used for a Construct instantiated inside a loop.
+ */
+export const preventConstructIdCollision = createRule({
+  name: "prevent-construct-id-collision",
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Disallow using literal Construct IDs inside loops, which may cause ID collisions.",
+    },
+    messages: {
+      preventConstructIdCollision:
+        "Construct ID '{{ constructId }}' is a literal value inside a loop. This may cause ID collisions. Use a variable that changes per iteration instead.",
+    },
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const parserServices = ESLintUtils.getParserServices(context);
+    return {
+      NewExpression(node) {
+        const type = parserServices.getTypeAtLocation(node);
+
+        if (!isConstructType(type) || node.arguments.length < 2) return;
+
+        const constructorPropertyNames = findConstructorPropertyNames(type);
+        if (constructorPropertyNames[1] !== "id") return;
+
+        validateConstructIdInLoop(node, context);
+      },
+    };
+  },
+});
+
+/**
+ * Validate whether a Construct ID is a literal inside a loop
+ */
+const validateConstructIdInLoop = (
+  node: TSESTree.NewExpression,
+  context: Parameters<typeof preventConstructIdCollision.create>[0],
+) => {
+  if (!isInsideLoop(node)) return;
+
+  const secondArg = node.arguments[1];
+
+  // NOTE: String literals may cause ID collisions
+  if (secondArg.type === AST_NODE_TYPES.Literal && typeof secondArg.value === "string") {
+    context.report({
+      node: secondArg,
+      messageId: "preventConstructIdCollision",
+      data: { constructId: secondArg.value },
+    });
+    return;
+  }
+
+  // NOTE: Template literals without expressions are also static values
+  if (secondArg.type === AST_NODE_TYPES.TemplateLiteral && !secondArg.expressions.length) {
+    const constructId = secondArg.quasis.map((q) => q.value.raw).join("");
+    context.report({
+      node: secondArg,
+      messageId: "preventConstructIdCollision",
+      data: { constructId },
+    });
+    return;
+  }
+};
+
+/**
+ * Check whether a node is inside a loop.
+ * Detects for, for...in, for...of, while, do...while statements,
+ * and callbacks of iteration methods (forEach, map, etc.)
+ */
+const isInsideLoop = (node: TSESTree.Node): boolean => {
+  let current = node.parent;
+  while (current) {
+    // NOTE: Detect loop statements
+    if (
+      current.type === AST_NODE_TYPES.ForStatement ||
+      current.type === AST_NODE_TYPES.ForInStatement ||
+      current.type === AST_NODE_TYPES.ForOfStatement ||
+      current.type === AST_NODE_TYPES.WhileStatement ||
+      current.type === AST_NODE_TYPES.DoWhileStatement
+    ) {
+      return true;
+    }
+
+    // NOTE: Detect iteration method callbacks (ArrowFunction/FunctionExpression)
+    if (
+      (current.type === AST_NODE_TYPES.ArrowFunctionExpression ||
+        current.type === AST_NODE_TYPES.FunctionExpression) &&
+      isIterationMethodCallback(current)
+    ) {
+      return true;
+    }
+
+    // NOTE: Stop at non-constructor method definitions
+    if (current.type === AST_NODE_TYPES.MethodDefinition && current.kind !== "constructor") {
+      return false;
+    }
+
+    current = current.parent;
+  }
+  return false;
+};
+
+const ITERATION_METHODS = new Set([
+  "forEach",
+  "map",
+  "flatMap",
+  "filter",
+  "reduce",
+  "reduceRight",
+  "every",
+  "some",
+  "find",
+  "findIndex",
+  "findLast",
+  "findLastIndex",
+]);
+
+/**
+ * Check whether an arrow function or function expression is a callback of an iteration method
+ */
+const isIterationMethodCallback = (
+  node: TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression,
+): boolean => {
+  const parent = node.parent;
+  if (parent?.type !== AST_NODE_TYPES.CallExpression) return false;
+
+  const callee = parent.callee;
+  if (callee.type !== AST_NODE_TYPES.MemberExpression) return false;
+
+  if (callee.property.type !== AST_NODE_TYPES.Identifier) return false;
+
+  return ITERATION_METHODS.has(callee.property.name);
+};