@kitschpatrol/knip-config 5.0.0

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import type { KnipConfig } from 'knip';
+/**
+ * Must return a POJO to be merged into package.json
+ */
+declare const sharedKnipConfig: KnipConfig;
+/**
+ * **\@Kitschpatrol's Shared Knip Configuration**
+ * @see [@kitschpatrol/knip-config](https://github.com/kitschpatrol/shared-config/tree/main/packages/knip-config)
+ * @see [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config)
+ * @example
+ * ```ts
+ * import { knipConfig } from '@kitschpatrol/knip-config'
+ *
+ * export default knipConfig({
+ *   // Customizations here
+ * })
+ * ```
+ */
+export declare function knipConfig(config?: KnipConfig): KnipConfig;
+export default sharedKnipConfig;

package/dist/index.js

@@ -0,0 +1,33 @@
+import { deepmerge } from 'deepmerge-ts';
+// export { commandDefinition } from './command.js'
+/**
+ * Must return a POJO to be merged into package.json
+ */
+const sharedKnipConfig = {
+    entry: [
+        'scripts/**/*.ts',
+        '.remarkrc.js',
+        'cspell.config.js',
+        'eslint.config.ts',
+        'mdat.config.ts',
+        'prettier.config.js',
+        'stylelint.config.js',
+    ],
+};
+/**
+ * **\@Kitschpatrol's Shared Knip Configuration**
+ * @see [@kitschpatrol/knip-config](https://github.com/kitschpatrol/shared-config/tree/main/packages/knip-config)
+ * @see [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config)
+ * @example
+ * ```ts
+ * import { knipConfig } from '@kitschpatrol/knip-config'
+ *
+ * export default knipConfig({
+ *   // Customizations here
+ * })
+ * ```
+ */
+export function knipConfig(config) {
+    return deepmerge(sharedKnipConfig, config);
+}
+export default sharedKnipConfig;

package/init/knip.config.ts

@@ -0,0 +1,3 @@
+import { knipConfig } from '@kitschpatrol/knip-config'
+
+export default knipConfig()

package/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Eric Mika
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@kitschpatrol/knip-config",
+  "version": "5.0.0",
+  "description": "Knip configuration for @kitschpatrol/shared-config.",
+  "keywords": [
+    "shared-config",
+    "knip-config",
+    "knip",
+    "cli",
+    "kpi",
+    "kpi-knip"
+  ],
+  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kitschpatrol/shared-config/cli.git",
+    "directory": "packages/knip-config"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Eric Mika",
+    "email": "eric@ericmika.com",
+    "url": "https://ericmika.com"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "kpi-knip": "bin/cli.js"
+  },
+  "files": [
+    "dist/*",
+    "bin/*",
+    "init/*"
+  ],
+  "dependencies": {
+    "@pinojs/json-colorizer": "^4.0.0",
+    "cosmiconfig": "^9.0.0",
+    "deepmerge-ts": "^7.1.4",
+    "execa": "^9.5.2",
+    "fs-extra": "^11.3.0",
+    "knip": "^5.43.6"
+  },
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=10.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc && ../../scripts/build.ts",
+    "cli": "node ./bin/cli.js"
+  }
+}

package/readme.md

@@ -0,0 +1,189 @@
+<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
+
+<!-- title -->
+
+# @kitschpatrol/knip-config
+
+<!-- /title -->
+
+<!-- badges -->
+
+[![NPM Package @kitschpatrol/knip-config](https://img.shields.io/npm/v/@kitschpatrol/knip-config.svg)](https://npmjs.com/package/@kitschpatrol/knip-config)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+<!-- /badges -->
+
+<!-- description -->
+
+**Knip configuration for @kitschpatrol/shared-config.**
+
+<!-- /description -->
+
+## Overview
+
+It's a shared [Knip](https://knip.dev) config, plus a command-line tool `kpi-knip` to perform Knip-related project initialization, linting, and fixing.
+
+<!-- recommendation -->
+
+> [!Important]
+>
+> **You can use this package on its own, but it's recommended to use [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@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`](https://www.npmjs.com/package/@kitschpatrol/shared-config), which also automatically invokes the command line functionality in this package via its `kpi` command
+
+<!-- /recommendation -->
+
+## Setup
+
+To use just this Knip config in isolation:
+
+1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
+
+   ```sh
+   pnpm dlx @kitschpatrol/repo-config 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 kpi-knip init
+   ```
+
+## Usage
+
+Integrate with your `package.json` scripts as you see fit, for example:
+
+```json
+{
+  "scripts": {
+    "lint": "kpi-knip lint"
+  }
+}
+```
+
+### Configuration
+
+To create a `knip.config.ts` in your project root:
+
+```sh
+pnpm exec kpi-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 kpi-knip init --location package
+```
+
+(Note that this will delete the `knip.config.ts` file in your project root!)
+
+### CLI
+
+<!-- cli-help -->
+
+#### Command: `kpi-knip`
+
+Kitschpatrol's Knip shared configuration tools.
+
+This section lists top-level commands for `kpi-knip`.
+
+Usage:
+
+```txt
+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.            |
+| `fix`          | Automatically remove 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`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+_See the sections below for more information on each subcommand._
+
+#### Subcommand: `kpi-knip init`
+
+Initialize by copying starter config files to your project root or to your package.json file.
+
+Usage:
+
+```txt
+kpi-knip init
+```
+
+| Option              | Description         | Type                 | Default  |
+| ------------------- | ------------------- | -------------------- | -------- |
+| `--location`        | TK                  | `"file"` `"package"` | `"file"` |
+| `--help`<br>`-h`    | Show help           | `boolean`            |          |
+| `--version`<br>`-v` | Show version number | `boolean`            |          |
+
+#### Subcommand: `kpi-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
+kpi-knip lint
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-knip fix`
+
+Automatically remove unused code and dependencies. Package-scoped. In a monorepo, it will also run in all packages below the current working directory.
+
+Usage:
+
+```txt
+kpi-knip fix
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-knip print-config`
+
+Print the effective Knip configuration. Package-scoped. Searches up to the root of a monorepo if necessary.
+
+Usage:
+
+```txt
+kpi-knip print-config
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+<!-- /cli-help -->
+
+<!-- license -->
+
+## License
+
+[MIT](license.txt) © Eric Mika
+
+<!-- /license -->