feat(compiler): Automatically add @default JSDoc to @Prop() declarations

[yashwanth-yenugu]

What is the current behavior?

Currently, Stencil does not automatically add @default JSDoc to @Prop() declarations, even when a default value is present in the component's property definition. Developers have to manually add this JSDoc.

Closes: 6139

What is the new behavior?

Stencil will now automatically add @default 'value' to the JSDoc of a @Prop() when a default value is detected for that property and no @default JSDoc is already present. This improves developer quality of life by reducing redundancy and making component APIs clearer.

Documentation

No new documentation is required, as this is an automatic behavior change.

Does this introduce a breaking change?

[ ] Yes
[x] No

Testing

Unit tests have been added to src/compiler/types/tests/generate-prop-types.spec.ts to verify the new behavior, including cases where a default value is present and where @default JSDoc is already manually set. All tests are passing.

Other information

This feature is similar to how Stencil automatically adds @readonly when a @Prop() only has a getter method.

[christian-bromann]

Awesome, thanks a lot!

[christian-bromann]

@yashwanth-yenugu it seems like some of the CI tests are failing, mind taking a look? Let me know if I can help with them.

[yashwanth-yenugu]

Hi @christian-bromann , I’ve pushed a fix for the CI issues — the tests are now passing ✅
could you please take another look and let me know if anything else is needed? Thanks.

[christian-bromann]

Thank you 🙏