microsoft / microsoft/TypeScript
Unclear error message when using undeclared parameter in JSDoc.
Open
Nobody has claimed this yet.
Experience Enhancement
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
Bug Report
🔎 Search Terms
ts8032
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about
ts8032
⏯ Playground Link
Playground link with relevant code
💻 Code
/**
* @param {Object} opts
* @param {number} [opts.thisWorks]
* @param {number} [undeclaredParam.thisDoesnt]
*/
function foo(opts) {
}
🙁 Actual behavior
It emits TS8032 with a vague error message: Qualified name 'undeclaredVar.thisDoesnt' is not allowed without a leading '@param {object} undeclaredVar'.
🙂 Expected behavior
A clear error message explaining that undeclaredParam does not exist.
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 linked TypeScript Playground and the TS8032 diagnostic for the provided JSDoc example. Compare the actual message with the expected explanation that the undeclared parameter does not exist, then verify the corrected wording against the same example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100