@envsa/typescript-config

TypeScript configuration for @envsa/shared-config.

Overview

It's a shared TypeScript tsconfig.json config, plus a command-line tool envsa-typescript to perform TypesScript-related validation and linting.

[!IMPORTANT]

You can use this package on its own, but it's recommended to use @envsa/shared-config instead for a single-dependency and single-package approach to linting and fixing your project.

This package is included as a dependency in @envsa/shared-config, which also automatically invokes the command line functionality in this package via its envsa command

Setup

[!NOTE]

The package treats typescript as a peer dependency - it expects you to have typescript installed in your project.

To use just this TypeScript config in isolation:

1. Install the .npmrc in your project root. This is required for correct PNPM behavior:

pnpm dlx @envsa/repo-config init

2. Add the package:

pnpm add -D @envsa/typescript-config

3. Add the starter tsconfig.json and tsconfig.build.json files to your project root, and add any customizations you'd like:

pnpm exec envsa-typescript init

Usage

You can call envsa-typescript directly, or use the script bundled with the config. Integrate wih your package.json script as you see fit, for example:

{
  "scripts": {
    "lint": "envsa-typescript lint"
  }
}

Ignoring files

See the tsconfig.json exclude key. .gitignore files are not ignored.

Ignoring code

See the TypeScript directive comments documentation for more details.

Entire files (at top):

/* @ts-nocheck */

Next line:

/* @ts-ignore */

or

/* @ts-expect-error - reason */

CLI

Command: envsa-typescript

Envsa's TypeScript shared configuration tools.

This section lists top-level commands for envsa-typescript.

Usage:

envsa-typescript <command>

| Command | Description | | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | init | Initialize by copying starter config files to your project root. | | lint | Run type checking on your project. Package-scoped. In a monorepo, it will also run in all packages below the current working directory. | | print-config | Print the TypeScript configuration for the project. Package-scoped. Searches up to the root of a monorepo if necessary. |

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

See the sections below for more information on each subcommand.

Subcommand: envsa-typescript init

Initialize by copying starter config files to your project root.

Usage:

envsa-typescript init

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

Subcommand: envsa-typescript lint

Run type checking on your project. Package-scoped. In a monorepo, it will also run in all packages below the current working directory.

Usage:

envsa-typescript lint

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

Subcommand: envsa-typescript print-config

Print the TypeScript configuration for the project. Package-scoped. Searches up to the root of a monorepo if necessary.

Usage:

envsa-typescript print-config

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

Notes

General

• tsconfig Cheat Sheet

Other shared tsconfig projects

• tsconfig/bases
• sindresorhus/tsconfig
• total-typescript/tsconfig

Future integrations

• Are The Types Wrong,
  e.g. attw --format ascii --no-summary --profile esm-only --pack .

Credits

Eric Mika is the author of the original @kitschpatrol/shared-config project on which this is based.

License

MIT © Liam Rella