Microsoft/TypeScript

Unable to use `@ts-ignore` in JSDoc comments.

Open

#47,392 opened on Jan 11, 2022

View on GitHub
 (2 comments) (3 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: JSDocHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

Bug Report

🔎 Search Terms

ts-ignore jsdoc

🕗 Version & Regression Information

  • This changed between versions 3.8.3 and 3.9.7

⏯ Playground Link

--> Playground link with relevant code

💻 Code

/**
// @ts-ignore
 * @param {number} x
 */
function foo() {

}

🙁 Actual behavior

The error is not ignored

🙂 Expected behavior

The error is ignored

Contributor guide

Research direction
Investigate how @ts ignore is parsed and applied in JSDoc comments. Use git bisect between versions 3.8.3 and 3.9.7 to find the commit that changed behavior. Focus on the type checker or parser code path that handles suppression comments.
Tech stack
typescript
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60