eslint-cdk-plugin 2.2.0 → 3.0.2

package/src/rules/no-parent-name-construct-id-match.ts

@@ -15,10 +15,9 @@ type Options = [
   }
 ];
 
-type Context = TSESLint.RuleContext<"noParentNameConstructIdMatch", Options>;
+type Context = TSESLint.RuleContext<"invalidConstructId", Options>;
 
 type ValidateStatementArgs<T extends TSESTree.Statement> = {
-  node: TSESTree.ClassBody;
   statement: T;
   parentClassName: string;
   context: Context;
@@ -27,7 +26,6 @@ type ValidateStatementArgs<T extends TSESTree.Statement> = {
 };
 
 type ValidateExpressionArgs<T extends TSESTree.Expression> = {
-  node: TSESTree.ClassBody;
   expression: T;
   parentClassName: string;
   context: Context;
@@ -50,7 +48,7 @@ export const noParentNameConstructIdMatch = ESLintUtils.RuleCreator.withoutDocs(
           "Enforce that construct IDs does not match the parent construct name.",
       },
       messages: {
-        noParentNameConstructIdMatch:
+        invalidConstructId:
           "Construct ID '{{ constructId }}' should not match parent construct name '{{ parentConstructName }}'. Use a more specific identifier.",
       },
       schema: [
@@ -99,7 +97,6 @@ export const noParentNameConstructIdMatch = ESLintUtils.RuleCreator.withoutDocs(
               continue;
             }
             validateConstructorBody({
-              node,
               expression: body.value,
               parentClassName,
               context,
@@ -118,7 +115,6 @@ export const noParentNameConstructIdMatch = ESLintUtils.RuleCreator.withoutDocs(
  * - validate each statement in the constructor body
  */
 const validateConstructorBody = ({
-  node,
   expression,
   parentClassName,
   context,
@@ -131,7 +127,6 @@ const validateConstructorBody = ({
         const newExpression = statement.declarations[0].init;
         if (newExpression?.type !== AST_NODE_TYPES.NewExpression) continue;
         validateConstructId({
-          node,
           context,
           expression: newExpression,
           parentClassName,
@@ -143,7 +138,6 @@ const validateConstructorBody = ({
       case AST_NODE_TYPES.ExpressionStatement: {
         if (statement.expression?.type !== AST_NODE_TYPES.NewExpression) break;
         validateStatement({
-          node,
           statement,
           parentClassName,
           context,
@@ -154,7 +148,6 @@ const validateConstructorBody = ({
       }
       case AST_NODE_TYPES.IfStatement: {
         traverseStatements({
-          node,
           context,
           parentClassName,
           statement: statement.consequent,
@@ -167,7 +160,6 @@ const validateConstructorBody = ({
         for (const switchCase of statement.cases) {
           for (const statement of switchCase.consequent) {
             traverseStatements({
-              node,
               context,
               parentClassName,
               statement,
@@ -188,7 +180,6 @@ const validateConstructorBody = ({
  * - Validates construct IDs against parent class name
  */
 const traverseStatements = ({
-  node,
   statement,
   parentClassName,
   context,
@@ -199,7 +190,6 @@ const traverseStatements = ({
     case AST_NODE_TYPES.BlockStatement: {
       for (const body of statement.body) {
         validateStatement({
-          node,
           statement: body,
           parentClassName,
           context,
@@ -213,7 +203,6 @@ const traverseStatements = ({
       const newExpression = statement.expression;
       if (newExpression?.type !== AST_NODE_TYPES.NewExpression) break;
       validateStatement({
-        node,
         statement,
         parentClassName,
         context,
@@ -226,7 +215,6 @@ const traverseStatements = ({
       const newExpression = statement.declarations[0].init;
       if (newExpression?.type !== AST_NODE_TYPES.NewExpression) break;
       validateConstructId({
-        node,
         context,
         expression: newExpression,
         parentClassName,
@@ -244,7 +232,6 @@ const traverseStatements = ({
  * - Extracts and validates construct IDs from new expressions
  */
 const validateStatement = ({
-  node,
   statement,
   parentClassName,
   context,
@@ -256,7 +243,6 @@ const validateStatement = ({
       const newExpression = statement.declarations[0].init;
       if (newExpression?.type !== AST_NODE_TYPES.NewExpression) break;
       validateConstructId({
-        node,
         context,
         expression: newExpression,
         parentClassName,
@@ -269,7 +255,6 @@ const validateStatement = ({
       const newExpression = statement.expression;
       if (newExpression?.type !== AST_NODE_TYPES.NewExpression) break;
       validateConstructId({
-        node,
         context,
         expression: newExpression,
         parentClassName,
@@ -280,7 +265,6 @@ const validateStatement = ({
     }
     case AST_NODE_TYPES.IfStatement: {
       validateIfStatement({
-        node,
         statement,
         parentClassName,
         context,
@@ -291,7 +275,6 @@ const validateStatement = ({
     }
     case AST_NODE_TYPES.SwitchStatement: {
       validateSwitchStatement({
-        node,
         statement,
         parentClassName,
         context,
@@ -308,7 +291,6 @@ const validateStatement = ({
  * - Validate recursively if `if` statements are nested
  */
 const validateIfStatement = ({
-  node,
   statement,
   parentClassName,
   context,
@@ -316,7 +298,6 @@ const validateIfStatement = ({
   option,
 }: ValidateStatementArgs<TSESTree.IfStatement>): void => {
   traverseStatements({
-    node,
     context,
     parentClassName,
     statement: statement.consequent,
@@ -330,7 +311,6 @@ const validateIfStatement = ({
  * - Validate recursively if `switch` statements are nested
  */
 const validateSwitchStatement = ({
-  node,
   statement,
   parentClassName,
   context,
@@ -340,7 +320,6 @@ const validateSwitchStatement = ({
   for (const caseStatement of statement.cases) {
     for (const _consequent of caseStatement.consequent) {
       traverseStatements({
-        node,
         context,
         parentClassName,
         statement: _consequent,
@@ -355,7 +334,6 @@ const validateSwitchStatement = ({
  * Validate that parent construct name and child id do not match
  */
 const validateConstructId = ({
-  node,
   context,
   expression,
   parentClassName,
@@ -385,8 +363,8 @@ const validateConstructId = ({
     formattedConstructId.includes(formattedParentClassName)
   ) {
     context.report({
-      node,
-      messageId: "noParentNameConstructIdMatch",
+      node: secondArg,
+      messageId: "invalidConstructId",
       data: {
         constructId: secondArg.value,
         parentConstructName: parentClassName,
@@ -396,8 +374,8 @@ const validateConstructId = ({
   }
   if (formattedParentClassName === formattedConstructId) {
     context.report({
-      node,
-      messageId: "noParentNameConstructIdMatch",
+      node: secondArg,
+      messageId: "invalidConstructId",
       data: {
         constructId: secondArg.value,
         parentConstructName: parentClassName,

package/src/rules/no-variable-construct-id.ts

@@ -8,7 +8,7 @@ import {
 import { getConstructorPropertyNames } from "../utils/parseType";
 import { isConstructType } from "../utils/typeCheck";
 
-type Context = TSESLint.RuleContext<"noVariableConstructId", []>;
+type Context = TSESLint.RuleContext<"invalidConstructId", []>;
 
 /**
  * Enforce using literal strings for Construct ID.
@@ -22,7 +22,7 @@ export const noVariableConstructId = ESLintUtils.RuleCreator.withoutDocs({
       description: `Enforce using literal strings for Construct ID.`,
     },
     messages: {
-      noVariableConstructId: "Shouldn't use a parameter as a Construct ID.",
+      invalidConstructId: "Shouldn't use a parameter as a Construct ID.",
     },
     schema: [],
   },
@@ -73,8 +73,8 @@ const validateConstructId = (
   }
 
   context.report({
-    node,
-    messageId: "noVariableConstructId",
+    node: secondArg,
+    messageId: "invalidConstructId",
   });
 };
 

package/src/rules/pascal-case-construct-id.ts

@@ -16,7 +16,7 @@ const QUOTE_TYPE = {
 
 type QuoteType = (typeof QUOTE_TYPE)[keyof typeof QUOTE_TYPE];
 
-type Context = TSESLint.RuleContext<"pascalCaseConstructId", []>;
+type Context = TSESLint.RuleContext<"invalidConstructId", []>;
 
 /**
 /**
@@ -32,7 +32,7 @@ export const pascalCaseConstructId = ESLintUtils.RuleCreator.withoutDocs({
       description: "Enforce PascalCase for Construct ID.",
     },
     messages: {
-      pascalCaseConstructId: "Construct ID must be PascalCase.",
+      invalidConstructId: "Construct ID must be PascalCase.",
     },
     schema: [],
     fixable: "code",
@@ -90,8 +90,8 @@ const validateConstructId = (
   if (isPascalCase(secondArg.value)) return;
 
   context.report({
-    node,
-    messageId: "pascalCaseConstructId",
+    node: secondArg,
+    messageId: "invalidConstructId",
     fix: (fixer) => {
       const pascalCaseValue = toPascalCase(secondArg.value);
       return fixer.replaceText(secondArg, `${quote}${pascalCaseValue}${quote}`);

package/src/rules/require-passing-this.ts

@@ -13,7 +13,7 @@ type Options = [
   }
 ];
 
-type Context = TSESLint.RuleContext<"requirePassingThis", Options>;
+type Context = TSESLint.RuleContext<"missingPassingThis", Options>;
 
 /**
  * Enforces that `this` is passed to the constructor
@@ -28,7 +28,7 @@ export const requirePassingThis = ESLintUtils.RuleCreator.withoutDocs({
       description: "Require passing `this` in a constructor.",
     },
     messages: {
-      requirePassingThis: "Require passing `this` in a constructor.",
+      missingPassingThis: "Require passing `this` in a constructor.",
     },
     schema: [
       {
@@ -72,8 +72,8 @@ export const requirePassingThis = ESLintUtils.RuleCreator.withoutDocs({
         // NOTE: If `allowNonThisAndDisallowScope` is false, require `this` for all cases
         if (!options.allowNonThisAndDisallowScope) {
           context.report({
-            node,
-            messageId: "requirePassingThis",
+            node: argument,
+            messageId: "missingPassingThis",
             fix: (fixer) => {
               return fixer.replaceText(argument, "this");
             },
@@ -87,8 +87,8 @@ export const requirePassingThis = ESLintUtils.RuleCreator.withoutDocs({
           argument.name === "scope"
         ) {
           context.report({
-            node,
-            messageId: "requirePassingThis",
+            node: argument,
+            messageId: "missingPassingThis",
             fix: (fixer) => {
               return fixer.replaceText(argument, "this");
             },

package/src/rules/no-mutable-props-interface.ts

@@ -1,58 +0,0 @@
-import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
-
-/**
- * Disallow mutable properties in Props interfaces
- * @param context - The rule context provided by ESLint
- * @returns An object containing the AST visitor functions
- * @see {@link https://eslint-cdk-plugin.dev/rules/no-mutable-props-interface} - Documentation
- */
-export const noMutablePropsInterface = ESLintUtils.RuleCreator.withoutDocs({
-  meta: {
-    type: "problem",
-    docs: {
-      description: "Disallow mutable properties in Props interfaces",
-    },
-    fixable: "code",
-    messages: {
-      noMutablePropsInterface:
-        "Property '{{ propertyName }}' in Props interface should be readonly.",
-    },
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    return {
-      TSInterfaceDeclaration(node) {
-        const sourceCode = context.sourceCode;
-
-        // NOTE: Interface name check for "Props"
-        if (!node.id.name.endsWith("Props")) return;
-
-        for (const property of node.body.body) {
-          // NOTE: check property signature
-          if (
-            property.type !== AST_NODE_TYPES.TSPropertySignature ||
-            property.key.type !== AST_NODE_TYPES.Identifier
-          ) {
-            continue;
-          }
-
-          // NOTE: Skip if already readonly
-          if (property.readonly) continue;
-
-          context.report({
-            node: property,
-            messageId: "noMutablePropsInterface",
-            data: {
-              propertyName: property.key.name,
-            },
-            fix: (fixer) => {
-              const propertyText = sourceCode.getText(property);
-              return fixer.replaceText(property, `readonly ${propertyText}`);
-            },
-          });
-        }
-      },
-    };
-  },
-});

package/src/rules/no-mutable-public-fields.ts

@@ -1,75 +0,0 @@
-import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
-
-import { isConstructOrStackType } from "../utils/typeCheck";
-
-/**
- * Disallow mutable public class fields
- * @param context - The rule context provided by ESLint
- * @returns An object containing the AST visitor functions
- * @see {@link https://eslint-cdk-plugin.dev/rules/no-mutable-public-fields} - Documentation
- */
-export const noMutablePublicFields = ESLintUtils.RuleCreator.withoutDocs({
-  meta: {
-    type: "problem",
-    docs: {
-      description: "Disallow mutable public class fields",
-    },
-    fixable: "code",
-    messages: {
-      noMutablePublicFields:
-        "Public field '{{ propertyName }}' should be readonly. Consider adding the 'readonly' modifier.",
-    },
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    const parserServices = ESLintUtils.getParserServices(context);
-
-    return {
-      ClassDeclaration(node) {
-        const sourceCode = context.sourceCode;
-        const type = parserServices.getTypeAtLocation(node);
-        if (!isConstructOrStackType(type)) return;
-
-        for (const member of node.body.body) {
-          // NOTE: check property definition
-          if (
-            member.type !== AST_NODE_TYPES.PropertyDefinition ||
-            member.key.type !== AST_NODE_TYPES.Identifier
-          ) {
-            continue;
-          }
-
-          // NOTE: Skip private and protected fields
-          if (["private", "protected"].includes(member.accessibility ?? "")) {
-            continue;
-          }
-
-          // NOTE: Skip if readonly is present
-          if (member.readonly) continue;
-
-          context.report({
-            node: member,
-            messageId: "noMutablePublicFields",
-            data: {
-              propertyName: member.key.name,
-            },
-            fix: (fixer) => {
-              const accessibility = member.accessibility ? "public " : "";
-              const paramText = sourceCode.getText(member);
-              const [key, value] = paramText.split(":");
-              const replacedKey = key.startsWith("public ")
-                ? key.replace("public ", "")
-                : key;
-
-              return fixer.replaceText(
-                member,
-                `${accessibility}readonly ${replacedKey}:${value}`
-              );
-            },
-          });
-        }
-      },
-    };
-  },
-});

package/src/rules/no-public-class-fields.ts

@@ -1,154 +0,0 @@
-import {
-  AST_NODE_TYPES,
-  ESLintUtils,
-  ParserServicesWithTypeInformation,
-  TSESLint,
-  TSESTree,
-} from "@typescript-eslint/utils";
-
-import { SYMBOL_FLAGS } from "../constants/tsInternalFlags";
-import { isConstructOrStackType } from "../utils/typeCheck";
-
-type Context = TSESLint.RuleContext<"noPublicClassFields", []>;
-
-/**
- * Disallow class types in public class fields
- * @param context - The rule context provided by ESLint
- * @returns An object containing the AST visitor functions
- * @see {@link https://eslint-cdk-plugin.dev/rules/no-public-class-fields} - Documentation
- */
-export const noPublicClassFields = ESLintUtils.RuleCreator.withoutDocs({
-  meta: {
-    type: "problem",
-    docs: {
-      description: "Disallow class types in public class fields",
-    },
-    messages: {
-      noPublicClassFields:
-        "Public field '{{ propertyName }}' should not use class type '{{ typeName }}'. Consider using an interface or type alias instead.",
-    },
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    const parserServices = ESLintUtils.getParserServices(context);
-    return {
-      ClassDeclaration(node) {
-        const type = parserServices.getTypeAtLocation(node);
-        if (!isConstructOrStackType(type)) return;
-
-        // NOTE: Check class members
-        validateClassMember(node, context, parserServices);
-
-        // NOTE: Check constructor parameter properties
-        const constructor = node.body.body.find(
-          (member): member is TSESTree.MethodDefinition =>
-            member.type === AST_NODE_TYPES.MethodDefinition &&
-            member.kind === "constructor"
-        );
-        if (
-          !constructor ||
-          constructor.value.type !== AST_NODE_TYPES.FunctionExpression
-        ) {
-          return;
-        }
-
-        validateConstructorParameterProperty(
-          constructor,
-          context,
-          parserServices
-        );
-      },
-    };
-  },
-});
-
-/**
- * check the public variable of the class
- * - if it is a class type, report an error
- */
-const validateClassMember = (
-  node: TSESTree.ClassDeclaration,
-  context: Context,
-  parserServices: ParserServicesWithTypeInformation
-) => {
-  for (const member of node.body.body) {
-    if (
-      member.type !== AST_NODE_TYPES.PropertyDefinition ||
-      member.key.type !== AST_NODE_TYPES.Identifier
-    ) {
-      continue;
-    }
-
-    // NOTE: Skip private and protected fields
-    if (["private", "protected"].includes(member.accessibility ?? "")) {
-      continue;
-    }
-
-    // NOTE: Skip fields without type annotation
-    if (!member.typeAnnotation) continue;
-
-    const type = parserServices.getTypeAtLocation(member);
-    if (!type.symbol) continue;
-
-    // NOTE: In order not to make it dependent on the typescript library, it defines its own unions.
-    //       Therefore, the type information structures do not match.
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
-    const isClass = type.symbol.flags === SYMBOL_FLAGS.CLASS;
-    if (!isClass) continue;
-
-    context.report({
-      node: member,
-      messageId: "noPublicClassFields",
-      data: {
-        propertyName: member.key.name,
-        typeName: type.symbol.name,
-      },
-    });
-  }
-};
-
-/**
- * check the constructor parameter property
- * - if it is a class type, report an error
- */
-const validateConstructorParameterProperty = (
-  constructor: TSESTree.MethodDefinition,
-  context: Context,
-  parserServices: ParserServicesWithTypeInformation
-) => {
-  for (const param of constructor.value.params) {
-    if (
-      param.type !== AST_NODE_TYPES.TSParameterProperty ||
-      param.parameter.type !== AST_NODE_TYPES.Identifier
-    ) {
-      continue;
-    }
-
-    // NOTE: Skip private and protected parameters
-    if (["private", "protected"].includes(param.accessibility ?? "")) {
-      continue;
-    }
-
-    // NOTE: Skip parameters without type annotation
-    if (!param.parameter.typeAnnotation) continue;
-
-    const type = parserServices.getTypeAtLocation(param);
-    if (!type.symbol) continue;
-
-    // NOTE: In order not to make it dependent on the typescript library, it defines its own unions.
-    //       Therefore, the type information structures do not match.
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
-    const isClass = type.symbol.flags === SYMBOL_FLAGS.CLASS;
-    if (!isClass) continue;
-
-    context.report({
-      node: param,
-      messageId: "noPublicClassFields",
-      data: {
-        propertyName: param.parameter.name,
-        typeName: type.symbol.name,
-      },
-    });
-  }
-};