@yuu1111/knip-config 0.0.0

package/README.md

@@ -0,0 +1,64 @@
+# @yuu1111/knip-config
+
+Shared [Knip](https://knip.dev/) configuration.
+
+## Install
+
+```bash
+bun add -D @yuu1111/knip-config knip
+```
+
+## Usage
+
+Knip loads `knip.ts`, so import the preset that matches the project and add the
+project specific entries:
+
+```ts
+import { application } from "@yuu1111/knip-config/application"
+
+export default {
+	...application,
+	entry: ["src/main.ts"]
+}
+```
+
+## Presets
+
+| Preset | Use case |
+|--------|----------|
+| `base` | Shared defaults |
+| `application` | Applications whose entry points are resolved by a framework |
+| `library` | Libraries whose entry points are their public API |
+
+### base
+
+- `ignoreExportsUsedInFile` keeps exports that are only referenced inside their own file out of the report
+
+### application
+
+- `includeEntryExports` stays off because the entry points of an application are not a public contract
+
+### library
+
+- `includeEntryExports` is on so an export that is no longer part of the public API is reported
+
+## Notes
+
+Dynamic entry points, CLI binaries, and generated files stay in the consuming
+project because a shared preset cannot infer them from the project layout.
+
+A repository that also holds another project keeps that project out of the
+report with `ignore`, so its files are not read as source of the parent:
+
+```ts
+import { application } from "@yuu1111/knip-config/application"
+
+export default {
+	...application,
+	ignore: ["FFXIVReplayAnalyzer/**"]
+}
+```
+
+On such a repository the preset alone took the unused exports from 48 to 41,
+and the nested project took the report down to the single unused type that the
+repository really has left.

package/application.ts

@@ -0,0 +1,9 @@
+import type { KnipConfig } from "knip";
+import { base } from "./base";
+
+// frameworkが動的に読み込むentrypointは利用Projectが明示する
+export const application = {
+	...base,
+	// applicationのentryは公開契約ではないため未使用exportとして報告しない
+	includeEntryExports: false,
+} satisfies KnipConfig;

package/base.ts

@@ -0,0 +1,6 @@
+import type { KnipConfig } from "knip";
+
+export const base = {
+	// 同一file内で参照しているexportは内部利用とみなす
+	ignoreExportsUsedInFile: true,
+} satisfies KnipConfig;

package/library.ts

@@ -0,0 +1,8 @@
+import type { KnipConfig } from "knip";
+import { base } from "./base";
+
+// 公開APIのentryから未使用になったexportを報告する
+export const library = {
+	...base,
+	includeEntryExports: true,
+} satisfies KnipConfig;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@yuu1111/knip-config",
+  "version": "0.0.0",
+  "description": "Shared Knip configuration",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yuu1111/configs.git",
+    "directory": "packages/knip-config"
+  },
+  "type": "module",
+  "exports": {
+    "./application": "./application.ts",
+    "./base": "./base.ts",
+    "./library": "./library.ts"
+  },
+  "files": [
+    "application.ts",
+    "base.ts",
+    "library.ts"
+  ],
+  "keywords": [
+    "knip",
+    "config"
+  ],
+  "peerDependencies": {
+    "knip": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "knip": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "knip": "^6.34.0"
+  }
+}