@kitschpatrol/typescript-config NPM

@kitschpatrol/typescript-config

TypeScript configuration for @kitschpatrol/shared-config.

Overview

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

!IMPORTANT
You can use this package on its own, but it's recommended to use @kitschpatrol/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 @kitschpatrol/shared-config, which also automatically invokes the command line functionality in this package via its kpi 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:

Install the .npmrc in your project root. This is required for correct PNPM behavior:
```
pnpm dlx @kitschpatrol/repo-config init
```

Add the package:

pnpm add -D @kitschpatrol/typescript-config

Add the starter tsconfig.json and tsconfig.build.json files to your project root, and add any customizations you'd like:
```
pnpm exec kpi-typescript init
```

Usage

You can call kpi-typescript directly, or use the script bundled with the config.

Integrate with your package.json scripts as you see fit, for example:

{
  "scripts": {
    "lint": "kpi-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 */

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

CLI

Command: `kpi-typescript`

Kitschpatrol's TypeScript shared configuration tools.

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

Usage:

kpi-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.