npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-pkg-installer

v1.2.0

Published

TypeScript package installer

Downloads

12

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

mhfrantzmhfrantzjimlloydjimlloyd

Keywords

typescript

Readme

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.