feat: add rule construct props must readonly (#34)

* feat: add rule * feat: add documents * feat: update rule docs
ren-yamanashi · Nov 18, 2024 · edf7b49 · edf7b49
1 parent 9475f3c
commit edf7b49
Show file tree

Hide file tree

Showing 27 changed files with 231 additions and 22 deletions.
diff --git a/docs/getting-started/example.md b/docs/getting-started/example.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - Example for eslint.config.mjs
 titleTemplate: ":title"
 prev: false
 ---

diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - Getting Started
 titleTemplate: ":title"
 ---
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,8 @@
 ---
 # https://vitepress.dev/reference/default-theme-home-page
 layout: home
-
+title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+titleTemplate: ":title"
 hero:
   name: "eslint-plugin-cdk"
   text: "ESLint plugin for AWS CDK"

diff --git a/docs/ja/getting-started/example.md b/docs/ja/getting-started/example.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - Example for eslint.config.mjs
 titleTemplate: ":title"
 prev: false
 ---

diff --git a/docs/ja/getting-started/index.md b/docs/ja/getting-started/index.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - Getting Started
 titleTemplate: ":title"
 ---
 

diff --git a/docs/ja/index.md b/docs/ja/index.md
@@ -1,7 +1,8 @@
 ---
 # https://vitepress.dev/reference/default-theme-home-page
 layout: home
-
+title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+titleTemplate: ":title"
 hero:
   name: "eslint-plugin-cdk"
   text: "ESLint plugin for AWS CDK"

diff --git a/docs/ja/rules/index.md b/docs/ja/rules/index.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - Rules
 titleTemplate: ":title"
 ---
 

diff --git a/docs/ja/rules/no-class-in-interface.md b/docs/ja/rules/no-class-in-interface.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-class-in-interface
 titleTemplate: ":title"
 ---
 

diff --git a/docs/ja/rules/no-construct-stack-suffix.md b/docs/ja/rules/no-construct-stack-suffix.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-construct-stack-suffix
 titleTemplate: ":title"
 ---
 

diff --git a/docs/ja/rules/no-import-private.md b/docs/ja/rules/no-import-private.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-import-private
 titleTemplate: ":title"
 next: false
 ---

diff --git a/docs/ja/rules/no-mutable-props-interface.md b/docs/ja/rules/no-mutable-props-interface.md
@@ -0,0 +1,26 @@
+---
+title: eslint-plugin-cdk - no-mutable-props-interface
+titleTemplate: ":title"
+---
+
+# no-mutable-props-interface
+
+このルールは、コンストラクトまたはスタックの、`Props`(インターフェース)のパブリック変数を変更可能にすることを禁止します。
+
+Props で変更可能なパブリック変数を指定すると、意図しない副作用を引き起こす可能性があるため推奨されません。
+
+#### ✅ 正しい例
+
+```ts
+interface MyConstructProps {
+  readonly bucket: IBucket;
+}
+```
+
+#### ❌ 誤った例
+
+```ts
+interface MyConstructProps {
+  bucket: IBucket;
+}
+```
diff --git a/docs/ja/rules/no-mutable-public-fields.md b/docs/ja/rules/no-mutable-public-fields.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-mutable-public-fields
 titleTemplate: ":title"
 ---
 

diff --git a/docs/ja/rules/no-parent-name-construct-id-match.md b/docs/ja/rules/no-parent-name-construct-id-match.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-parent-name-construct-id-match
 titleTemplate: ":title"
 ---
 

diff --git a/docs/ja/rules/no-public-class-fields.md b/docs/ja/rules/no-public-class-fields.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-public-class-fields
 titleTemplate: ":title"
 ---
 

diff --git a/docs/ja/rules/pascal-case-construct-id.md b/docs/ja/rules/pascal-case-construct-id.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - pascal-case-construct-id
 titleTemplate: ":title"
 prev: false
 ---

diff --git a/docs/rules/index.md b/docs/rules/index.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - Rules
 titleTemplate: ":title"
 ---
 

diff --git a/docs/rules/no-class-in-interface.md b/docs/rules/no-class-in-interface.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-class-in-interface
 titleTemplate: ":title"
 ---
 

diff --git a/docs/rules/no-construct-stack-suffix.md b/docs/rules/no-construct-stack-suffix.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-construct-stack-suffix
 titleTemplate: ":title"
 ---
 

diff --git a/docs/rules/no-import-private.md b/docs/rules/no-import-private.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-import-private
 titleTemplate: ":title"
 next: false
 ---

diff --git a/docs/rules/no-mutable-props-interface.md b/docs/rules/no-mutable-props-interface.md
@@ -0,0 +1,26 @@
+---
+title: eslint-plugin-cdk - no-mutable-props-interface
+titleTemplate: ":title"
+---
+
+# no-mutable-props-interface
+
+This rule disallow making public properties of constructs or stack `props` (interfaces) mutable.
+
+It is not a good to specify mutable public properties in props, as this can lead to unintended side effects.
+
+#### ✅ Correct Example
+
+```ts
+interface MyConstructProps {
+  readonly bucket: IBucket;
+}
+```
+
+#### ❌ Incorrect Example
+
+```ts
+interface MyConstructProps {
+  bucket: IBucket;
+}
+```
diff --git a/docs/rules/no-mutable-public-fields.md b/docs/rules/no-mutable-public-fields.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-mutable-public-fields
 titleTemplate: ":title"
 ---
 

diff --git a/docs/rules/no-parent-name-construct-id-match.md b/docs/rules/no-parent-name-construct-id-match.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-parent-name-construct-id-match
 titleTemplate: ":title"
 ---
 

diff --git a/docs/rules/no-public-class-fields.md b/docs/rules/no-public-class-fields.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - no-public-class-fields
 titleTemplate: ":title"
 ---
 

diff --git a/docs/rules/pascal-case-construct-id.md b/docs/rules/pascal-case-construct-id.md
@@ -1,5 +1,5 @@
 ---
-title: eslint-plugin-cdk - ESLint plugin for AWS CDK
+title: eslint-plugin-cdk - pascal-case-construct-id
 titleTemplate: ":title"
 prev: false
 ---

diff --git a/src/__tests__/no-mutable-props-interface.test.ts b/src/__tests__/no-mutable-props-interface.test.ts
@@ -0,0 +1,101 @@
+import { RuleTester } from "@typescript-eslint/rule-tester";
+
+import { noMutablePropsInterface } from "../no-mutable-props-interface.mjs";
+
+const ruleTester = new RuleTester({
+  languageOptions: {
+    parserOptions: {
+      projectService: {
+        allowDefaultProject: ["*.ts*"],
+      },
+    },
+  },
+});
+
+ruleTester.run("no-mutable-props-interface", noMutablePropsInterface, {
+  valid: [
+    // WHEN: All properties are readonly
+    {
+      code: `
+        interface TestProps {
+          readonly name: string;
+          readonly age: number;
+        }
+      `,
+    },
+    // WHEN: Interface name does not end with "Props"
+    {
+      code: `
+        interface Test {
+          name: string;
+          age: number;
+        }
+      `,
+    },
+    // WHEN: Optional properties are readonly
+    {
+      code: `
+        interface UserProps {
+          readonly name: string;
+          readonly age?: number;
+        }
+      `,
+    },
+  ],
+  invalid: [
+    // WHEN: readonly is not set
+    {
+      code: `
+        interface TestProps {
+          name: string;
+          age: number;
+        }
+      `,
+      output: `
+        interface TestProps {
+          readonly name: string;
+          readonly age: number;
+        }
+      `,
+      errors: [
+        { messageId: "noMutablePropsInterface" },
+        { messageId: "noMutablePropsInterface" },
+      ],
+    },
+    // WHEN: Some properties do not have readonly
+    {
+      code: `
+        interface UserProps {
+          readonly name: string;
+          age: number;
+        }
+      `,
+      output: `
+        interface UserProps {
+          readonly name: string;
+          readonly age: number;
+        }
+      `,
+      errors: [{ messageId: "noMutablePropsInterface" }],
+    },
+    // WHEN: Optional properties do not have readonly
+    {
+      code: `
+        interface ConfigProps {
+          name: string;
+          age?: number;
+        }
+      `,
+      output: `
+        interface ConfigProps {
+          readonly name: string;
+          readonly age?: number;
+        }
+      `,
+      errors: [
+        { messageId: "noMutablePropsInterface" },
+        { messageId: "noMutablePropsInterface" },
+      ],
+    },
+  ],
+});
diff --git a/src/index.mts b/src/index.mts
@@ -1,6 +1,7 @@
 import { noClassInInterfaceProps } from "./no-class-in-interface.mjs";
 import { noConstructStackSuffix } from "./no-construct-stack-suffix.mjs";
 import { noImportPrivate } from "./no-import-private.mjs";
+import { noMutablePropsInterface } from "./no-mutable-props-interface.mjs";
 import { noMutablePublicFields } from "./no-mutable-public-fields.mjs";
 import { noParentNameConstructIdMatch } from "./no-parent-name-construct-id-match.mjs";
 import { noPublicClassFields } from "./no-public-class-fields.mjs";
@@ -15,6 +16,7 @@ const plugin = {
     "no-public-class-fields": noPublicClassFields,
     "pascal-case-construct-id": pascalCaseConstructId,
     "no-mutable-public-fields": noMutablePublicFields,
+    "no-mutable-props-interface": noMutablePropsInterface,
   },
   configs: {
     recommended: {
@@ -26,6 +28,7 @@ const plugin = {
         "cdk/no-public-class-fields": "error",
         "cdk/pascal-case-construct-id": "error",
         "cdk/no-mutable-public-fields": "warn",
+        "cdk/no-mutable-props-interface": "warn",
       },
     },
   },

diff --git a/src/no-mutable-props-interface.mts b/src/no-mutable-props-interface.mts
@@ -0,0 +1,51 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+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) {
+    const sourceCode = context.sourceCode;
+
+    return {
+      TSInterfaceDeclaration(node) {
+        // NOTE: Interface name check for "Props"
+        if (!node.id.name.endsWith("Props")) return;
+
+        for (const property of node.body.body) {
+          if (
+            property.type !== "TSPropertySignature" ||
+            property.key.type !== "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}`);
+            },
+          });
+        }
+      },
+    };
+  },
+});