JSDoc style comment format to document/typecheck/autocomplete attributes and properties
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 46
- Avg merge
- 10m
- Merged PRs (30d)
- 2
Description
Idea from @hexagoncircle
Example somewhere in a component definition file:
<!---
time-difference shows the relative time difference between a date and now.
@param {string} date
@param {string} locale
@param {("year"|"quarter"|"month"|"week"|"day"|"hour"|"minute"|"second")} units
@param {boolean} live
@param {integer} interval (in seconds)
--->
Also this might generate some relevant JSON for autocomplete in IDEs: https://mastodon.social/@khalidabuhakmeh/110225863097859563
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how component definition files are currently handled and compare the proposed comment example with the linked JetBrains Web Types format. Clarify the comment syntax, supported attributes and properties, and whether generating IDE autocomplete JSON is in scope; done should be a documented format with agreed typechecking or autocomplete output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100