microsoft / microsoft/TypeScript
Report errors (and quickfixes) for incorrect JSDoc
Open
Nobody has claimed this yet.
Domain: JSDoc
In Discussion
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: nightly (2.4.0-dev.20170515)
Code
/**
* @param abcdeg A parameter
*/
function f(abcdefg: number) {
abcdeg;
}
Expected behavior:
Can fix spelling for either abcdeg.
Actual behavior:
Does not work in jsdoc.
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 with the TypeScript/JSDoc handling for the provided function example and trace how misspelled @param names and references are currently processed. Determine where diagnostics and quickfixes for these mismatches are produced. Done means the example reports the spelling error and offers a correction for either occurrence, with appropriate tests added for both cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100