@kitschpatrol/knip-config NPM

@kitschpatrol/knip-config

Knip configuration for @kitschpatrol/shared-config.

Overview

It's a shared Knip config, plus a command-line tool kpi-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 kpi command

Setup

To use just this Knip 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/knip-config
```
Add the starter knip.config.ts files to your project root, and add any customizations you'd like:
```
pnpm exec kpi-knip init
```

Usage

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

{
  "scripts": {
    "lint": "kpi-knip lint"
  }
}

Configuration

To create a knip.config.ts in your project root:

pnpm exec kpi-knip init

(Note that this will delete the knip property in your package.json!)

To create a knip property in package.json:

pnpm exec kpi-knip init --location package

(Note that this will delete the knip.config.ts file in your project root!)

CLI

Command: `kpi-knip`

Kitschpatrol's Knip shared configuration tools.

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

Usage:

kpi-knip <command>

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.