Table of Contents

• Introduction
• Usage
• API
  • check
  • dryRun

Introduction

When working with typescript in a monorepo, you can use the references field of tsconfig.json to point to packages that your code depends on locally, so Typescript can efficently build and infer types as your codebase grows.

Nx already manages a dependency graph of your local typescript packages based on the dependencies on your package.json.

nx-update-ts-references will use this dependency graph to ensure your typescript configuration is up to date, so you don't have to manage it manually.

Installation

npm i nx-update-ts-references

Register it as a target in your project.json:

{
    "targets": {
        "update-ts-references": {
            "executor": "nx-update-ts-references:update-ts-references"
        }
    }
}

You can also use the API directly as a CLI:

pnpx update-ts-references --packageRoot ./path/to/project

Usage

Due to Nx deriving the dependency graph from your dependency's tsconfig.json, and the rest of the fields of tsconfig.json being maintained, those are the only two inputs, and the tsconfig.json file is the out, this is a trivially cacheable operation:

{
    "namedInputs": {
        "tsConfig": [
            "{projectRoot}/tsconfig.json"
        ]
    },
    "targets": {
        "update-ts-references": {
            "executor": "nx-update-ts-references:update-ts-references",
            "cache": true,
            "inputs": [
                "^tsConfig",
                "{projectRoot}/tsconfig.json"
            ],
            "outputs": [
                "{projectRoot}/tsconfig.json"
            ],
        }
    }
}

It is recommended to include this in every project that is based on typescript.

API

The following options can be passed as options to CLI and as the plugin options object.

All CLI parameters support both camelCase and kabob-case.

Options: