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

@typescript-tools/typescript-build-linker

v4.0.3

Published

Link together TypeScript packages in a monorepo

Downloads

11

Readme

typescript-build-linker

License NPM Package Build Status semantic-release

Link together TypeScript packages in a monorepo

Automatically manage TypeScript Project References in a Lerna monorepo.

The Problem

Whereas Lerna was created for managing JavaScript monorepos, TypeScript monorepos have additional requirements introduced by the compilation step.

Specifically, the TypeScript compiler can only create an accurate DAG of build dependencies when TypeScript Project References are up to date.

The Solution

The typescript-build-linker uses your monorepo's package.json files as the single source of truth to calculate the DAG of internal package dependencies, and automates upkeep of your TypeScript Project References.

This affords us two ways to build:

  1. from the top level

    Build every package, in the proper order, using cached results from prior compilations where possible.

  2. a single package

    Builds the specified package and all internal dependencies, in the proper order, using cached results from prior compilations where possible.

Install

npm install --save-dev @typescript-tools/typescript-build-linker

Use

Usage:
    typescript-build-linker [<repository>]

Options:
    <repository>    Path to monorepo root, defaults to cwd

Point tsl at the root directory of your monorepo and it will write the references list in each tsconfig.json file of every leaf package and parent directory.

When the DEBUG environment variable is set to link, the typescript-build-linker will print the file modifications it's making to stdout.

Integrate into Your Build System

Simply configure typescript-build-linker to run before tsc.

Example package.json in monorepo root:

{
  "name": "root",
  "private": true,
  "scripts": {
    "bootstrap": "lerna bootstrap --hoist --strict --force-local",
    "prebuild": "typescript-build-linker .",
    "build": "tsc --build --verbose packages"
  },
  "devDependencies": {
    "@typescript-tools/typescript-build-linker": "latest",
    "lerna": "^4.0.0"
  }
}

Limitations

JSON vs jsonc

Note that some tsconfig.json files include comments; this is not valid JSON syntax, but rather JSONC. The typescript-build-linker currently does not support JSONC, so be sure to strip out the comments from your tsconfig.json files before use.

As mentioned in the update-ts-references FAQ, it is possible to use the extends keyword to shunt the comments to a JSON file not managed by the typescript-build-linker.

Single Threaded Builds

There is an open issue in the TypeScript project to support multi-threaded compilation, but for now the stock tooling can only compile packages serially.

Related

Acknowledgments