microsoft / microsoft/DefinitelyTyped-tools

Can't mark old package as deprecated when renaming

Open
#505 7 comments 0 reactions 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

Hello! In order to solve https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/652 in https://github.com/Maxim-Mazurok/google-api-typings-generator/pull/655 I'll be changing the naming pattern of @types/gapi.client.* packages in order to accommodate multiple versions that can't be described as ${major}.${minor}, such as v2beta1, directory_v1, reports_v1, etc.

So now instead of having one @types/gapi.client.admin package, we'll have two: @types/gapi.client.admin-directory_v1 and @types/gapi.client.admin-reports_v1.

The current @types/gapi.client.admin package is essentially the same as the new @types/gapi.client.admin-reports_v1 will be.

So, I'd like to mark @types/gapi.client.admin as deprecated and point developers to the new one.

I could only find one way to mark @types package as deprecated on npm: using notNeededPackages.json. But this will say Bla provides its own type definitions which isn't correct, we're just renaming the types package.

I'd like to have an option to deprecate the old name in favor of the new one so that devs know where to find new versions.

I'd be happy to open PR to add renamedPackages.json with the option to specify the old and the new name that would work similarly to generateNotNeededPackage(), let me know if this is something you'd be open to, thanks!

For now, I'll probably add some deprecation messages and will keep both new and old packages.

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 reviewing notNeededPackages.json and the generateNotNeededPackage() path mentioned in the issue. Determine how a renamed package could be deprecated while pointing developers to its replacement, then verify that the generated npm metadata gives the intended guidance for both package names.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.