no-mutable-property-of-props-interface

✅ recommended を使用した場合、このルールが有効になります。

🔧 このルールによってエラーになるコードは ESLint の --fix コマンド で自動修正できます。

このルールは、CDK Construct または Stack の、Props (interface) の public プロパティを変更可能にすることを禁止します。
(readonly 修飾子がない Props プロパティの定義を禁止します)

Props で変更可能な public プロパティを指定すると、意図しない副作用を引き起こす可能性があるため、推奨されません。

---

🔧 使用方法

// eslint.config.mjs
export default [
  {
    // ... some configs
    rules: {
      "cdk/no-mutable-property-of-props-interface": "error",
    },
  },
];

✅ 正しい例

import { IBucket } from "aws-cdk-lib/aws-s3";

interface MyConstructProps {
  // ✅ readonly なプロパティは許可されます
  readonly bucket: IBucket;
}

import { IBucket } from "aws-cdk-lib/aws-s3";

// ✅ Props ではない interface には、このルールは適用されません
interface MyInterface {
  bucket: IBucket;
}

❌ 不正な例

import { IBucket } from "aws-cdk-lib/aws-s3";

interface MyConstructProps {
  // ❌ Props のプロパティは `readonly` にすべきです
  bucket: IBucket;
}

View on Playground