@kitschpatrol/typescript-config


TypeScript configuration for @kitschpatrol/shared-config.

Overview

It's a shared TypeScript tsconfig.json config, plus a command-line tool ksc-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 ksc 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 basic repository configuration files in your project root. This is required for correct PNPM behavior:

``sh
pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init
`

2. Add the package:

`sh
pnpm add -D @kitschpatrol/typescript-config
`

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

`sh
pnpm exec ksc-typescript init
`

Usage

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

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

`json
{
"scripts": {
"lint": "ksc-typescript lint"
}
}
`

$3

See the tsconfig.json exclude key.

.gitignore files are not ignored.

$3

See the TypeScript directive comments documentation for more details.

Entire files (at top):

/ @ts-nocheck /

Next line:

/ @ts-ignore /

or

/ @ts-expect-error - reason /

$3

#### Command: ksc-typescript

Kitschpatrol's TypeScript shared configuration tools.

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

Usage:

`txt
ksc-typescript
`

| 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: ksc-typescript init

Initialize by copying starter config files to your project root.

Usage:

`txt
ksc-typescript init
`

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

#### Subcommand: ksc-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:

`txt
ksc-typescript lint
`

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

#### Subcommand: ksc-typescript print-config

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

Usage:

`txt
ksc-typescript print-config
`

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

Notes

$3

The ksc-typescript lint command will detect whether it's running in a Svelte project, and treat lint as a no-op when that's the case.

This is necessary to prevent unactionable warnings because Svelte doesn't play well with the underlying TypeScript tsc command.

$3

- tsconfig Cheat Sheet

$3

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

$3

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

License

MIT © Eric Mika