microsoft / microsoft/TypeScript

Allow Program#getSemanticDiagnostics to ignore @ts-ignore

Open
#25,238 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: API In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

ts-ignore

Suggestion

Add a parameter to program.getSemanticDiagnostics to turn off filtering by // @ts-ignore comments.

Use Cases

#25166 proposes an option to report unused // @ts-ignore comments. Since this would require yet another compilerOption, I think this should better be done by external tooling like a linter.

Currently there is no way for external tools to know if there would actually be a semantic diagnostic without the comment. With the proposed API one could check that there is at least one diagnostic per ignore comment.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Program#getSemanticDiagnostics API and inspect how @ts-ignore comments filter semantic diagnostics. Done means the API accepts an option that disables this filtering, allowing external tooling to observe diagnostics that would otherwise be suppressed; the issue names no files or tests to run.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.