microsoft / microsoft/TypeScript
Add properties in JSDoc generation on destructuring in javascript file
Open
Nobody has claimed this yet.
Domain: JSDoc
Domain: LS: Quick Fixes
In Discussion
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
JSDoc destructuring generate property javascript
Suggestion
When you use the JSDoc generation on function using destructuring, it could list the properties.
Use Cases
Avoid redundancy when writing code.
It could be useful for Javascript files and Typescript files.
Examples
Action:
Actual:
Expectation:
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript / JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. new expression-level syntax)
Contributor guide
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 reproducing the JSDoc-generation examples in the issue for destructured functions in JavaScript and TypeScript. Trace the JSDoc generation entry point and existing tests, then verify that the generated documentation lists destructured properties without changing runtime JavaScript output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100