Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.36 KB

README.md

File metadata and controls

60 lines (39 loc) · 2.36 KB
Raw

ts-pkg-installer

TypeScript package installer (TSPI)

This module contains a command-line executable (ts-pkg-installer) that is designed to be used as an NPM "postinstall" hook for any NPM module that has a TypeScript (TS) interface.

Why do I need this tool?

If you build TS NPM modules for Node.js, and you want to reuse those TS modules to create more modules, then you may need this tool.

If you use the TSD tool (TypeScript DefinitelyTyped), then you may need this tool.

If you have ever tried to reuse a TS module and had problems (namely, duplicate declarations) because some TSD declaration files are referenced multiple times in a set of modules, then you probably need this tool.

What about 'tsd link'?

The TSD "link" command is an attempt to address the same problem. TSD "link" does export the declaration files, but it does not reconcile multiple dependencies on the same TSD declaration file. That is the use case that motivated TSPI's design.

How does it work?

The tool performs two related tasks:

  1. It exports your module declaration file to a depending package's "typings" directory, normalizing reference paths as necessary.

  2. It aggregates the TSD dependencies into a single TSD configuration file (node_modules/tsd.json), so that the depending package can install a single copy of each TSD declaration file.

How do I use it?

You simply need to "npm install" this package, and then set "ts-pkg-installer" as your "postinstall" script. When anyone installs your package, the script will do its thing.

You must also use the TSD tool to install the typings that this tool decides are necessary. Typically, you will have your own TSD config file (tsd.json); this tool will generate another one (node_modules/tsd.json). To install both sets of typings, you need to run TSD twice:

TSD=./node_modules/.bin/tsd
$TSD reinstall
$TSD --config node_modules/tsd.json reinstall

There is a sample project under test/data/repo that shows how to use make with this tool.

Isn't that too good to be true?

Probably. There may be scenarios that were not anticipated in the design and implementation of this tool. Let me know if it doesn't work for you.

Are all those tests necessary?

I think so. There are Mocha unit tests that focus on particular small features, and Cucumber tests that perform integration tests in the NPM installation context.