-
-
Notifications
You must be signed in to change notification settings - Fork 834
feat: automatically add @default ... to @Prop() jsdoc #6139
Copy link
Copy link
Closed
Labels
Good First IssueThis is a good first issue for someone wantng to contribute to Stencil!This is a good first issue for someone wantng to contribute to Stencil!Help Wanted
Description
Prerequisites
- I have read the Contributing Guidelines.
- I agree to follow the Code of Conduct.
- I have searched for existing issues that already include this feature request, without success.
Describe the Feature Request
Stencil could add a @default 'whatever' to a @Prop() jsdoc when it's able to derive the default value.
Describe the Use Case
It'd be a nice quality of life improvement :) - It makes life easier for consuming apps to know what the default is to stop redundancy.
Describe Preferred Solution
Stencil automatically adds @default ... when it detects a default value AND it doesn't find one set manually
Describe Alternatives
Manually adding @default ...
Related Code
No response
Additional Information
Stencil does something similar now for @readonly when a @Prop() only has a getter method.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Good First IssueThis is a good first issue for someone wantng to contribute to Stencil!This is a good first issue for someone wantng to contribute to Stencil!Help Wanted