microsoft / microsoft/DefinitelyTyped-tools

dependencies on other @types packages are specified as "*"

Open
#38 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

See https://github.com/DefinitelyTyped/DefinitelyTyped/pull/38624#issuecomment-537216366

Given some @types package P that depends on another @types package Q,
P's dependencies are implicitly published as

"dependencies": {
  "@types/q": "*"
}

Assume there is an update Q' and an update P' that depends on Q'.

Consumers of P who update to P' do not get Q' installed, because the old version of Q in the consumer's lockfile satisfies the dependency of "*". This leaves consumers of P to either manually edit their lockfile or explicitly depend on Q' in their application, both of which are not ideal solutions.

Definitely Typed should implicitly add the newest version of other DT packages to the published package.json.

Related: microsoft/types-publisher#11 microsoft/types-publisher#12 microsoft/types-publisher#360

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 with the linked pull-request comment and related issues microsoft/types-publisher#11, #12, and #360 to understand the publishing behavior. Trace how Definitely Typed dependencies become the published package.json, then verify that a package update causes its newest dependent @types package versions to be specified rather than "*".

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
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.