Knip configuration for @kitschpatrol/shared-config.
npm install @kitschpatrol/knip-config
Knip configuration for @kitschpatrol/shared-config.
It's a shared Knip config, plus a command-line tool ksc-knip to perform Knip-related project initialization, linting, and fixing.
> [!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
To use just this Knip 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/knip-config
3. Add the starter knip.config.ts files to your project root, and add any customizations you'd like:
`sh`
pnpm exec ksc-knip init
Integrate with your package.json scripts as you see fit, for example:
`json`
{
"scripts": {
"lint": "ksc-knip lint"
}
}
To create a knip.config.ts in your project root:
`sh`
pnpm exec ksc-knip init
(Note that this will delete the knip property in your package.json!)
_Or_
To create a knip property in package.json:
`sh`
pnpm exec ksc-knip init --location package
(Note that this will delete the knip.config.ts file in your project root!)
#### Command: ksc-knip
Kitschpatrol's Knip shared configuration tools.
This section lists top-level commands for ksc-knip.
Usage:
`txt`
ksc-knip
| Command | Description |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| init | Initialize by copying starter config files to your project root or to your package.json file. |lint
| | Check for unused code and dependencies. Package-scoped. In a monorepo, it will also run in all packages below the current working directory. |print-config
| | Print the effective Knip configuration. Package-scoped. Searches up to the root of a monorepo if necessary. |
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| --help | Show help | boolean |--version
| | Show version number | boolean |
_See the sections below for more information on each subcommand._
#### Subcommand: ksc-knip init
Initialize by copying starter config files to your project root or to your package.json file.
Usage:
`txt`
ksc-knip init
| Option | Description | Type | Default |
| ------------------- | ------------------- | -------------------- | -------- |
| --location | TK | "file" "package" | "file" |--help
| | Show help | boolean | |--version
| | Show version number | boolean | |
#### Subcommand: ksc-knip lint
Check for unused code and dependencies. Package-scoped. In a monorepo, it will also run in all packages below the current working directory.
Usage:
`txt`
ksc-knip lint
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| --help | Show help | boolean |--version
| | Show version number | boolean |
#### Subcommand: ksc-knip print-config
Print the effective Knip configuration. Package-scoped. Searches up to the root of a monorepo if necessary.
Usage:
`txt`
ksc-knip print-config
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| --help | Show help | boolean |--version
| | Show version number | boolean` |
MIT © Eric Mika