require-props-default-doc

ℹ️ This rule is not included in the recommended rules.

Requires @default JSDoc documentation for optional properties in Props interfaces.(e.g., MyConstructProps, StackProps).
This rule does not apply to class properties or non-Props interfaces.

---

🔧 How to use

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

✅ Correct Examples

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

interface MyConstructProps {
  // ✅ `@default` JSDoc comment for optional property
  /**
   * @default - No S3 bucket
   */
  readonly bucket?: IBucket;
}

// ✅ This rule does not apply to interfaces that are not Props
interface Config {
  readonly bucket?: IBucket;
}

❌ Incorrect Examples

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

interface MyConstructProps {
  // ❌ Must write `@default` JSDoc comment
  readonly bucket?: IBucket;
}

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

interface StackProps {
  // ❌ Must write `@default` JSDoc comment
  /** Some description without default value */
  readonly bucket?: IBucket;
}