@kitschpatrol/knip-config

Knip configuration for @kitschpatrol/shared-config.

Overview

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

Setup

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:

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

2. Add the package:

   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:

   pnpm exec ksc-knip init

Usage

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

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

Configuration

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

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:

pnpm exec ksc-knip init --location package

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

CLI

Command: ksc-knip

Kitschpatrol's Knip shared configuration tools.

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

Usage:

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

| 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-knip init

Initialize by copying starter config files to your project root or to your package.json file.

Usage:

ksc-knip init

| Option | Description | Type | Default | | ------------------- | ------------------- | -------------------- | -------- | | --location | TK | "file" "package" | "file" | | --help-h | Show help | boolean | | | --version-v | 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:

ksc-knip lint

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | 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:

ksc-knip print-config

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

License

MIT © Eric Mika