microsoft / microsoft/DefinitelyTyped-tools

notNeededPackage checks should forbid forwarding to libraryName like "@types/*"

Open
#246 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
423
Forks
237
Avg merge
18h 18m
Merged PRs (30d)
11

Description

In https://github.com/DefinitelyTyped/DefinitelyTyped/pull/52591, this resulted from a misunderstanding about what to do when the source package is deprecated. The error message for this new check should explain that source package deprecation doesn't necessarily mean that the DT package should be deprecated.

Contributor guide

No contributing guide indexed for this repository

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 by examining the notNeededPackage checks and the related DefinitelyTyped PR 52591. Confirm how forwarding to a libraryName such as "@types/*" is handled, then review the error wording for the source-package-deprecation case. Done means the check rejects the forwarding and clearly explains that source deprecation does not automatically deprecate the DT package.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.