eslint-cdk-plugin 3.0.0 → 3.0.3

package/dist/index.cjs

@@ -26,7 +26,11 @@ function _interopNamespaceDefault(e) {
 var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 
 var name = "eslint-cdk-plugin";
-var version = "2.2.0";
+var version = "3.0.3";
+
+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;
@@ -49,35 +53,34 @@ const isTargetSuperClassType = (type, targetSuperClasses, typeCheckFunction) =>
   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'"
+    },
+    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);
+      }
+    };
   }
-);
+});
 const validateConstructorProperty = (constructor, context) => {
   const params = constructor.value.params;
   if (params.length < 2) {
@@ -114,7 +117,16 @@ const validateConstructorProperty = (constructor, context) => {
   }
 };
 
-const noConstructInInterface = utils.ESLintUtils.RuleCreator.withoutDocs({
+const SYMBOL_FLAGS = {
+  CLASS: 32
+};
+const SYNTAX_KIND = {
+  CLASS_DECLARATION: 263,
+  CONSTRUCTOR: 176
+};
+
+const noConstructInInterface = createRule({
+  name: "no-construct-in-interface",
   meta: {
     type: "problem",
     docs: {
@@ -136,6 +148,8 @@ const noConstructInInterface = utils.ESLintUtils.RuleCreator.withoutDocs({
           }
           const type = parserServices.getTypeAtLocation(property);
           if (!isConstructOrStackType(type)) continue;
+          const isClass = type.symbol.flags === SYMBOL_FLAGS.CLASS;
+          if (!isClass) continue;
           context.report({
             node: property,
             messageId: "invalidInterfaceProperty",
@@ -150,7 +164,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: {
@@ -195,6 +210,8 @@ const validatePublicPropertyOfConstruct = (node, context, parserServices) => {
     if (!property.typeAnnotation) continue;
     const type = parserServices.getTypeAtLocation(property);
     if (!isConstructOrStackType(type)) continue;
+    const isClass = type.symbol.flags === SYMBOL_FLAGS.CLASS;
+    if (!isClass) continue;
     context.report({
       node: property,
       messageId: "invalidPublicPropertyOfConstruct",
@@ -216,6 +233,8 @@ const validateConstructorParameterProperty = (constructor, context, parserServic
     if (!param.parameter.typeAnnotation) continue;
     const type = parserServices.getTypeAtLocation(param);
     if (!isConstructOrStackType(type)) continue;
+    const isClass = type.symbol.flags === SYMBOL_FLAGS.CLASS;
+    if (!isClass) continue;
     context.report({
       node: param,
       messageId: "invalidPublicPropertyOfConstruct",
@@ -235,11 +254,6 @@ const toPascalCase = (str) => {
   }).join("");
 };
 
-const SYNTAX_KIND = {
-  CLASS_DECLARATION: 263,
-  CONSTRUCTOR: 176
-};
-
 const getConstructorPropertyNames = (type) => {
   const declarations = type.symbol?.declarations;
   if (!declarations?.length) return [];
@@ -262,7 +276,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: {
@@ -345,6 +360,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: {
@@ -377,7 +393,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: {
@@ -417,7 +434,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: {
@@ -468,64 +486,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,
@@ -758,7 +775,8 @@ const validateConstructId$2 = ({
   }
 };
 
-const noVariableConstructId = utils.ESLintUtils.RuleCreator.withoutDocs({
+const noVariableConstructId = createRule({
+  name: "no-variable-construct-id",
   meta: {
     type: "problem",
     docs: {
@@ -823,7 +841,8 @@ const QUOTE_TYPE = {
   SINGLE: "'",
   DOUBLE: '"'
 };
-const pascalCaseConstructId = utils.ESLintUtils.RuleCreator.withoutDocs({
+const pascalCaseConstructId = createRule({
+  name: "pascal-case-construct-id",
   meta: {
     type: "problem",
     docs: {
@@ -872,7 +891,8 @@ const validateConstructId = (node, context) => {
   });
 };
 
-const propsNameConvention = utils.ESLintUtils.RuleCreator.withoutDocs({
+const propsNameConvention = createRule({
+  name: "props-name-convention",
   meta: {
     type: "problem",
     docs: {
@@ -919,7 +939,8 @@ const propsNameConvention = utils.ESLintUtils.RuleCreator.withoutDocs({
   }
 });
 
-const requireJSDoc = utils.ESLintUtils.RuleCreator.withoutDocs({
+const requireJSDoc = createRule({
+  name: "require-jsdoc",
   meta: {
     type: "problem",
     docs: {
@@ -984,7 +1005,8 @@ const requireJSDoc = utils.ESLintUtils.RuleCreator.withoutDocs({
   }
 });
 
-const requirePassingThis = utils.ESLintUtils.RuleCreator.withoutDocs({
+const requirePassingThis = createRule({
+  name: "require-passing-this",
   meta: {
     type: "problem",
     docs: {
@@ -1049,7 +1071,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: {