eslint-cdk-plugin 3.0.2 → 3.1.0

package/README.md

@@ -35,29 +35,34 @@ Note: This plugin uses typescript type information and must be used in conjuncti
 
 ```js
 // eslint.config.mjs
+import eslint from "@eslint/js";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
 import cdkPlugin from "eslint-cdk-plugin";
-import tsEslint from "typescript-eslint";
 
-export default [
-  ...tsEslint.configs.recommended,
-  // ✅ Add plugins
-  cdkPlugin.configs.recommended,
+export default defineConfig([
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
   {
     files: ["lib/**/*.ts", "bin/*.ts"],
-    // ... some configs
+    // ✅ Add plugins
+    extends: [cdkPlugin.configs.recommended],
   },
-];
+]);
 ```
 
 ### When using custom config
 
 ```js
 // eslint.config.mjs
-import tsEslint from "typescript-eslint";
+import eslint from "@eslint/js";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
 import cdkPlugin from "eslint-cdk-plugin";
 
-export default [
-  ...tsEslint.configs.recommended,
+export default defineConfig([
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
   {
     files: ["lib/**/*.ts", "bin/*.ts"],
     languageOptions: {
@@ -77,7 +82,7 @@ export default [
       "cdk/no-parent-name-construct-id-match": "error",
     },
   },
-];
+]);
 ```
 
 ## ❗ Issue

package/dist/index.cjs

@@ -26,7 +26,11 @@ function _interopNamespaceDefault(e) {
 var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 
 var name = "eslint-cdk-plugin";
-var version = "3.0.1";
+var version = "3.1.0";
+
+const createRule = utils.ESLintUtils.RuleCreator(
+  (name) => `https://eslint-cdk-plugin.dev/rules/${name}`
+);
 
 const isConstructOrStackType = (type, ignoredClasses = ["App", "Stage"]) => {
   if (ignoredClasses.includes(type.symbol?.name ?? "")) return false;
@@ -42,43 +46,44 @@ const isConstructType = (type, ignoredClasses = ["App", "Stage", "Stack"]) => {
 };
 const isTargetSuperClassType = (type, targetSuperClasses, typeCheckFunction) => {
   if (!type.symbol) return false;
-  if (targetSuperClasses.some((suffix) => type.symbol.name.endsWith(suffix))) {
+  if (targetSuperClasses.some((suffix) => type.symbol.name === suffix)) {
     return true;
   }
   const baseTypes = type.getBaseTypes() ?? [];
   return baseTypes.some((baseType) => typeCheckFunction(baseType));
 };
 
-const constructConstructorProperty = utils.ESLintUtils.RuleCreator.withoutDocs(
-  {
-    meta: {
-      type: "problem",
-      docs: {
-        description: "Enforces that constructors of classes extending Construct have the property names 'scope, id' or 'scope, id, props'"
-      },
-      messages: {
-        invalidConstructorProperty: "Constructor of a class extending Construct must have the property names 'scope, id' or 'scope, id, props'"
-      },
-      schema: []
+const constructConstructorProperty = createRule({
+  name: "construct-constructor-property",
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Enforces that constructors of classes extending Construct have the property names 'scope, id' or 'scope, id, props'"
     },
-    defaultOptions: [],
-    create(context) {
-      const parserServices = utils.ESLintUtils.getParserServices(context);
-      return {
-        ClassDeclaration(node) {
-          const type = parserServices.getTypeAtLocation(node);
-          if (!isConstructType(type)) return;
-          const constructor = node.body.body.find(
-            (member) => member.type === utils.AST_NODE_TYPES.MethodDefinition && member.kind === "constructor"
-          );
-          if (!constructor) return;
-          validateConstructorProperty(constructor, context);
-        }
-      };
-    }
+    messages: {
+      invalidConstructorProperty: "Constructor of a class extending Construct must have the property names 'scope, id' or 'scope, id, props'",
+      invalidConstructorType: "Constructor of a class extending Construct must have the type 'Construct' for the first parameter",
+      invalidConstructorIdType: "Constructor of a class extending Construct must have the type 'string' for the second parameter"
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    const parserServices = utils.ESLintUtils.getParserServices(context);
+    return {
+      ClassDeclaration(node) {
+        const type = parserServices.getTypeAtLocation(node);
+        if (!isConstructType(type)) return;
+        const constructor = node.body.body.find(
+          (member) => member.type === utils.AST_NODE_TYPES.MethodDefinition && member.kind === "constructor"
+        );
+        if (!constructor) return;
+        validateConstructorProperty(constructor, context, parserServices);
+      }
+    };
   }
-);
-const validateConstructorProperty = (constructor, context) => {
+});
+const validateConstructorProperty = (constructor, context, parserServices) => {
   const params = constructor.value.params;
   if (params.length < 2) {
     context.report({
@@ -88,24 +93,35 @@ const validateConstructorProperty = (constructor, context) => {
     return;
   }
   const firstParam = params[0];
-  if (firstParam.type === utils.AST_NODE_TYPES.Identifier && firstParam.name !== "scope") {
+  if (firstParam.type !== utils.AST_NODE_TYPES.Identifier || firstParam.name !== "scope") {
     context.report({
       node: firstParam,
       messageId: "invalidConstructorProperty"
     });
-    return;
+  } else if (!isConstructType(parserServices.getTypeAtLocation(firstParam))) {
+    context.report({
+      node: firstParam,
+      messageId: "invalidConstructorType"
+    });
   }
   const secondParam = params[1];
-  if (secondParam.type === utils.AST_NODE_TYPES.Identifier && secondParam.name !== "id") {
+  if (secondParam.type !== utils.AST_NODE_TYPES.Identifier || secondParam.name !== "id") {
     context.report({
       node: secondParam,
       messageId: "invalidConstructorProperty"
     });
     return;
+  } else if (secondParam.typeAnnotation?.typeAnnotation.type !== utils.AST_NODE_TYPES.TSStringKeyword) {
+    context.report({
+      node: secondParam,
+      messageId: "invalidConstructorIdType"
+    });
+    return;
   }
-  if (params.length < 3) return;
+  if (params.length < 3)
+    return;
   const thirdParam = params[2];
-  if (thirdParam.type === utils.AST_NODE_TYPES.Identifier && thirdParam.name !== "props") {
+  if (thirdParam.type !== utils.AST_NODE_TYPES.Identifier || thirdParam.name !== "props") {
     context.report({
       node: thirdParam,
       messageId: "invalidConstructorProperty"
@@ -122,7 +138,8 @@ const SYNTAX_KIND = {
   CONSTRUCTOR: 176
 };
 
-const noConstructInInterface = utils.ESLintUtils.RuleCreator.withoutDocs({
+const noConstructInInterface = createRule({
+  name: "no-construct-in-interface",
   meta: {
     type: "problem",
     docs: {
@@ -160,7 +177,8 @@ const noConstructInInterface = utils.ESLintUtils.RuleCreator.withoutDocs({
   }
 });
 
-const noConstructInPublicPropertyOfConstruct = utils.ESLintUtils.RuleCreator.withoutDocs({
+const noConstructInPublicPropertyOfConstruct = createRule({
+  name: "no-construct-in-public-property-of-construct",
   meta: {
     type: "problem",
     docs: {
@@ -271,7 +289,8 @@ const SUFFIX_TYPE = {
   CONSTRUCT: "Construct",
   STACK: "Stack"
 };
-const noConstructStackSuffix = utils.ESLintUtils.RuleCreator.withoutDocs({
+const noConstructStackSuffix = createRule({
+  name: "no-construct-stack-suffix",
   meta: {
     type: "problem",
     docs: {
@@ -354,6 +373,7 @@ const noImportPrivate = {
   meta: {
     type: "problem",
     docs: {
+      url: "https://eslint-cdk-plugin.dev/rules/no-import-private",
       description: "Cannot import modules from private dir at different levels of the hierarchy."
     },
     messages: {
@@ -386,7 +406,8 @@ const getDirSegments = (dirPath) => {
   return dirPath.split(path__namespace.sep).filter((segment) => segment !== "");
 };
 
-const noMutablePropertyOfPropsInterface = utils.ESLintUtils.RuleCreator.withoutDocs({
+const noMutablePropertyOfPropsInterface = createRule({
+  name: "no-mutable-property-of-props-interface",
   meta: {
     type: "problem",
     docs: {
@@ -426,7 +447,8 @@ const noMutablePropertyOfPropsInterface = utils.ESLintUtils.RuleCreator.withoutD
   }
 });
 
-const noMutablePublicPropertyOfConstruct = utils.ESLintUtils.RuleCreator.withoutDocs({
+const noMutablePublicPropertyOfConstruct = createRule({
+  name: "no-mutable-public-property-of-construct",
   meta: {
     type: "problem",
     docs: {
@@ -477,64 +499,63 @@ const noMutablePublicPropertyOfConstruct = utils.ESLintUtils.RuleCreator.without
   }
 });
 
-const noParentNameConstructIdMatch = utils.ESLintUtils.RuleCreator.withoutDocs(
-  {
-    meta: {
-      type: "problem",
-      docs: {
-        description: "Enforce that construct IDs does not match the parent construct name."
-      },
-      messages: {
-        invalidConstructId: "Construct ID '{{ constructId }}' should not match parent construct name '{{ parentConstructName }}'. Use a more specific identifier."
-      },
-      schema: [
-        {
-          type: "object",
-          properties: {
-            disallowContainingParentName: {
-              type: "boolean",
-              default: false
-            }
-          },
-          additionalProperties: false
-        }
-      ]
+const noParentNameConstructIdMatch = createRule({
+  name: "no-parent-name-construct-id-match",
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Enforce that construct IDs does not match the parent construct name."
+    },
+    messages: {
+      invalidConstructId: "Construct ID '{{ constructId }}' should not match parent construct name '{{ parentConstructName }}'. Use a more specific identifier."
     },
-    defaultOptions: [
+    schema: [
       {
-        disallowContainingParentName: false
+        type: "object",
+        properties: {
+          disallowContainingParentName: {
+            type: "boolean",
+            default: false
+          }
+        },
+        additionalProperties: false
       }
-    ],
-    create(context) {
-      const option = context.options[0] || {
-        disallowContainingParentName: false
-      };
-      const parserServices = utils.ESLintUtils.getParserServices(context);
-      return {
-        ClassBody(node) {
-          const type = parserServices.getTypeAtLocation(node);
-          if (!isConstructOrStackType(type)) return;
-          const parent = node.parent;
-          if (parent?.type !== utils.AST_NODE_TYPES.ClassDeclaration) return;
-          const parentClassName = parent.id?.name;
-          if (!parentClassName) return;
-          for (const body of node.body) {
-            if (body.type !== utils.AST_NODE_TYPES.MethodDefinition || !["method", "constructor"].includes(body.kind) || body.value.type !== utils.AST_NODE_TYPES.FunctionExpression) {
-              continue;
-            }
-            validateConstructorBody({
-              expression: body.value,
-              parentClassName,
-              context,
-              parserServices,
-              option
-            });
+    ]
+  },
+  defaultOptions: [
+    {
+      disallowContainingParentName: false
+    }
+  ],
+  create(context) {
+    const option = context.options[0] || {
+      disallowContainingParentName: false
+    };
+    const parserServices = utils.ESLintUtils.getParserServices(context);
+    return {
+      ClassBody(node) {
+        const type = parserServices.getTypeAtLocation(node);
+        if (!isConstructOrStackType(type)) return;
+        const parent = node.parent;
+        if (parent?.type !== utils.AST_NODE_TYPES.ClassDeclaration) return;
+        const parentClassName = parent.id?.name;
+        if (!parentClassName) return;
+        for (const body of node.body) {
+          if (body.type !== utils.AST_NODE_TYPES.MethodDefinition || !["method", "constructor"].includes(body.kind) || body.value.type !== utils.AST_NODE_TYPES.FunctionExpression) {
+            continue;
           }
+          validateConstructorBody({
+            expression: body.value,
+            parentClassName,
+            context,
+            parserServices,
+            option
+          });
         }
-      };
-    }
+      }
+    };
   }
-);
+});
 const validateConstructorBody = ({
   expression,
   parentClassName,
@@ -767,7 +788,8 @@ const validateConstructId$2 = ({
   }
 };
 
-const noVariableConstructId = utils.ESLintUtils.RuleCreator.withoutDocs({
+const noVariableConstructId = createRule({
+  name: "no-variable-construct-id",
   meta: {
     type: "problem",
     docs: {
@@ -832,7 +854,8 @@ const QUOTE_TYPE = {
   SINGLE: "'",
   DOUBLE: '"'
 };
-const pascalCaseConstructId = utils.ESLintUtils.RuleCreator.withoutDocs({
+const pascalCaseConstructId = createRule({
+  name: "pascal-case-construct-id",
   meta: {
     type: "problem",
     docs: {
@@ -881,7 +904,8 @@ const validateConstructId = (node, context) => {
   });
 };
 
-const propsNameConvention = utils.ESLintUtils.RuleCreator.withoutDocs({
+const propsNameConvention = createRule({
+  name: "props-name-convention",
   meta: {
     type: "problem",
     docs: {
@@ -928,7 +952,8 @@ const propsNameConvention = utils.ESLintUtils.RuleCreator.withoutDocs({
   }
 });
 
-const requireJSDoc = utils.ESLintUtils.RuleCreator.withoutDocs({
+const requireJSDoc = createRule({
+  name: "require-jsdoc",
   meta: {
     type: "problem",
     docs: {
@@ -993,7 +1018,8 @@ const requireJSDoc = utils.ESLintUtils.RuleCreator.withoutDocs({
   }
 });
 
-const requirePassingThis = utils.ESLintUtils.RuleCreator.withoutDocs({
+const requirePassingThis = createRule({
+  name: "require-passing-this",
   meta: {
     type: "problem",
     docs: {
@@ -1058,7 +1084,8 @@ const requirePassingThis = utils.ESLintUtils.RuleCreator.withoutDocs({
   }
 });
 
-const requirePropsDefaultDoc = utils.ESLintUtils.RuleCreator.withoutDocs({
+const requirePropsDefaultDoc = createRule({
+  name: "require-props-default-doc",
   meta: {
     type: "problem",
     docs: {

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import tsParser from "@typescript-eslint/parser";
 declare const rules: {
-    "construct-constructor-property": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructorProperty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+    "construct-constructor-property": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructorProperty" | "invalidConstructorType" | "invalidConstructorIdType", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     "no-construct-in-interface": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidInterfaceProperty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     "no-construct-in-public-property-of-construct": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidPublicPropertyOfConstruct", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     "no-construct-stack-suffix": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructId", [{
@@ -36,7 +36,7 @@ declare const configs: {
                     version: string;
                 };
                 rules: {
-                    "construct-constructor-property": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructorProperty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+                    "construct-constructor-property": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructorProperty" | "invalidConstructorType" | "invalidConstructorIdType", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
                     "no-construct-in-interface": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidInterfaceProperty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
                     "no-construct-in-public-property-of-construct": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidPublicPropertyOfConstruct", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
                     "no-construct-stack-suffix": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructId", [{
@@ -75,7 +75,7 @@ declare const configs: {
                     version: string;
                 };
                 rules: {
-                    "construct-constructor-property": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructorProperty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+                    "construct-constructor-property": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructorProperty" | "invalidConstructorType" | "invalidConstructorIdType", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
                     "no-construct-in-interface": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidInterfaceProperty", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
                     "no-construct-in-public-property-of-construct": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidPublicPropertyOfConstruct", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
                     "no-construct-stack-suffix": import("@typescript-eslint/utils/ts-eslint").RuleModule<"invalidConstructId", [{