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 â
js
// eslint.config.mjs
export default [
{
// ... some configs
rules: {
"cdk/require-props-default-doc": "error",
},
},
];
â Correct Examples â
ts
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 â
ts
import { IBucket } from "aws-cdk-lib/aws-s3";
interface MyConstructProps {
// â Must write `@default` JSDoc comment
readonly bucket?: IBucket;
}
ts
import { IBucket } from "aws-cdk-lib/aws-s3";
interface StackProps {
// â Must write `@default` JSDoc comment
/** Some description without default value */
readonly bucket?: IBucket;
}