require-props-default-doc

ℹ️ このルールは recommended ルールには含まれていません。

Props インターフェイスのオプショナルのプロパティには @default JSDoc ドキュメントを必須とします（例：MyConstructProps、StackProps）
クラスのプロパティや Props ではないインターフェースには適用されません。

---

🔧 使用方法

// eslint.config.mjs
export default [
  {
    // ... some configs
    rules: {
      "cdk/require-props-default-doc": "error",
    },
  },
];

✅ 正しい例

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

interface MyConstructProps {
  // ✅ `@default` コメントが記載されている
  /**
   * @default - S3バケットを紐づけない
   */
  readonly bucket?: IBucket;
}

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

❌ 不正な例

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

interface MyConstructProps {
  // ❌ `@default`コメントを記載する必要があります
  readonly bucket?: IBucket;
}

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

interface MyConstructProps {
  // ❌ `@default`コメントを記載する必要があります
  /** デフォルト値の説明がないJSDocコメント */
  readonly bucket?: IBucket;
}