microsoft / microsoft/TypeScript
Warn when JSDoc type cast misses parentheses
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
Search Terms
jsdoc. type castSuggestion
JSDoc type cast currently requires parentheses for technical reasons (#18212), but it does not warn when they don't exist.
Use Cases
// This doesn't work, the JSDoc comment is silently ignored
// A warning message will help.
const img = /** @type {HTMLImageElement} */ document.getElementById('#cat')
img.src = 'cat.gif'
Examples
const img = /** @type {HTMLImageElement} */ document.getElementById('#cat')
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^ Warning: The JSDoc type cast misses parentheses and is being ignored
img.src = 'cat.gif'
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. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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 JSDoc type-cast handling described in the issue and the referenced issue #18212, then locate the related diagnostic and regression tests. The change is complete when a missing-parentheses cast produces the shown warning without changing JavaScript output, while parenthesized casts retain their current behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100