@yuu1111/knip-config 1.0.0 → 1.0.2

package/README.ja.md

@@ -0,0 +1,62 @@
+[English](README.md)
+
+# @yuu1111/knip-config
+
+共有の [Knip](https://knip.dev/) 設定
+
+## Install
+
+```bash
+bun add -D @yuu1111/knip-config knip
+```
+
+## Usage
+
+Knipは `knip.ts` を読むため、Projectに合うpresetをimportしてProject固有のentryを足す
+
+```ts
+import { application } from "@yuu1111/knip-config/application"
+
+export default {
+	...application,
+	entry: ["src/main.ts"]
+}
+```
+
+## Presets
+
+| Preset | Use case |
+|--------|----------|
+| `base` | 共有の既定値 |
+| `application` | entry pointをframeworkが解決するapplication |
+| `library` | entry pointが公開APIそのものであるlibrary |
+
+### base
+
+- `ignoreExportsUsedInFile` は自分のfile内だけで参照されるexportを報告から外す
+- `ignoreFiles` は `quality-check` が実行時に読み込む `quality.config.ts` を報告から外す
+
+### application
+
+- applicationのentry pointは公開契約ではないため `includeEntryExports` はoffのままにする
+
+### library
+
+- 公開APIから外れたexportを報告するため `includeEntryExports` をonにする
+
+## Notes
+
+動的なentry point、CLI binary、生成物は共有presetがProject構成から推測できないため利用Project側に残す
+
+別Projectを同居させているrepositoryは `ignore` でそのProjectを報告から外し、親のsourceとして読ませない
+
+```ts
+import { application } from "@yuu1111/knip-config/application"
+
+export default {
+	...application,
+	ignore: ["FFXIVReplayAnalyzer/**"]
+}
+```
+
+そのrepositoryではpresetだけで未使用exportが48件から41件になり、入れ子Projectを外すとrepositoryに本当に残った未使用type 1件まで減った

package/README.md

@@ -1,3 +1,5 @@
+[日本語](README.ja.md)
+
 # @yuu1111/knip-config
 
 Shared [Knip](https://knip.dev/) configuration.

package/application.ts

@@ -2,7 +2,9 @@ import type { KnipConfig } from "knip";
 import { base } from "./base";
 
 // frameworkが動的に読み込むentrypointは利用Projectが明示する
-/** application向けのknip設定を提供する */
+/**
+ * application向けのknip設定を提供する
+ */
 export const application = {
 	...base,
 	// applicationのentryは公開契約ではないため未使用exportとして報告しない

package/base.ts

@@ -1,7 +1,11 @@
 import type { KnipConfig } from "knip";
 
-/** 各knip設定が共通で継承するbase設定を提供する */
+/**
+ * 各knip設定が共通で継承するbase設定を提供する
+ */
 export const base = {
 	// 同一file内で参照しているexportは内部利用とみなす
 	ignoreExportsUsedInFile: true,
+	// quality-checkが実行時に読み込むため、Projectのsourceとして報告しない
+	ignoreFiles: ["quality.config.ts"],
 } satisfies KnipConfig;

package/library.ts

@@ -2,7 +2,9 @@ import type { KnipConfig } from "knip";
 import { base } from "./base";
 
 // 公開APIのentryから未使用になったexportを報告する
-/** 公開APIのentryを持つlibrary向けのknip設定を提供する */
+/**
+ * 公開APIのentryを持つlibrary向けのknip設定を提供する
+ */
 export const library = {
 	...base,
 	includeEntryExports: true,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/knip-config",
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"description": "Shared Knip configuration",
 	"license": "MIT",
 	"repository": {
@@ -15,6 +15,7 @@
 		"./library": "./library.ts"
 	},
 	"files": [
+		"README.ja.md",
 		"application.ts",
 		"base.ts",
 		"library.ts"