install @types definition from fork

Question

Context

I forked DefinitelyTyped and made a workaround to one type definition. This workaround is on a branch in this fork.

This change shouldn't be merged back, since it's only a temporary workaround.

Question

How do I install this customized type definition via npm or yarn?

Problems

• I can't just install the branch, since it would install the whole DefinitelyTyped repo instead of just the library.
• Ideally I'd like to have it installed the same way default type definitions are, so that no additional (global) configuration is required.

Answer 1

If this is just temporary like you say (or maybe a very specific use case), it probably makes most sense to just copy the modified type definitions into the repository of your project. You can then reference these definitions just like you would with any custom typings (see my other answer for instructions).

Answer 2

This could be a time consuming process but doable (to the best of my knowledge).

Use the types-publisher project. The Manually Running section in the Readme covers the steps that needs to be executed.

The following steps specified in the Readme should be sufficient to generate and publish the package to your npm account:

1. Update the local DefinitelyTyped repo
2. Parse the definitions
3. Calculate versions
4. Generate packages on disk
5. Publish packages on disk
6. Publish registry

In the settings.json have the scopeName equal to npm username.

The package can be used as npm i @username/package-name