@yuu1111/knip-config 1.0.2 → 1.0.4

package/README.ja.md

@@ -34,7 +34,8 @@ export default {
 ### base
 
 - `ignoreExportsUsedInFile` は自分のfile内だけで参照されるexportを報告から外す
-- `ignoreFiles` は `quality-check` が実行時に読み込む `quality.config.ts` を報告から外す
+- `entry` は `quality-check` が実行時に読み込む `quality.config.ts` をentry pointとして扱う 未使用fileとして報告せず、このfileがimportするexportも利用中とみなす
+- `ignoreIssues` は `quality.config.ts` 自身のexportを報告から外す 利用側の入口は `quality-check` のAPIであり、このfileのexportではない
 
 ### application
 
@@ -48,6 +49,15 @@ export default {
 
 動的なentry point、CLI binary、生成物は共有presetがProject構成から推測できないため利用Project側に残す
 
+`base` が足す `entry` は、利用Projectが `entry` を書くと置き換わる 自分のentryを足すときは `quality.config.ts` も並べる
+
+```ts
+export default {
+	...application,
+	entry: ["src/main.ts", "quality.config.ts"]
+}
+```
+
 別Projectを同居させているrepositoryは `ignore` でそのProjectを報告から外し、親のsourceとして読ませない
 
 ```ts
@@ -55,8 +65,8 @@ import { application } from "@yuu1111/knip-config/application"
 
 export default {
 	...application,
-	ignore: ["FFXIVReplayAnalyzer/**"]
+	ignore: ["another-project/**"]
 }
 ```
 
-そのrepositoryではpresetだけで未使用exportが48件から41件になり、入れ子Projectを外すとrepositoryに本当に残った未使用type 1件まで減った
+`workspaces` を持つrepositoryで `entry` をtop levelに書くとKnipがconfiguration hintを出す 報告ではないため終了codeは変わらない

package/README.md

@@ -35,6 +35,8 @@ export default {
 ### base
 
 - `ignoreExportsUsedInFile` keeps exports that are only referenced inside their own file out of the report
+- `entry` treats `quality.config.ts`, which `quality-check` loads at run time, as an entry point: it is not reported as an unused file and the exports it imports count as used
+- `ignoreIssues` keeps the exports of `quality.config.ts` itself out of the report, because the entry point of a consuming project is the API of `quality-check` and not the exports of this file
 
 ### application
 
@@ -49,6 +51,16 @@ export default {
 Dynamic entry points, CLI binaries, and generated files stay in the consuming
 project because a shared preset cannot infer them from the project layout.
 
+The `entry` that `base` adds is replaced when a project writes its own `entry`,
+so an added entry lists `quality.config.ts` as well:
+
+```ts
+export default {
+	...application,
+	entry: ["src/main.ts", "quality.config.ts"]
+}
+```
+
 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:
 
@@ -57,10 +69,10 @@ import { application } from "@yuu1111/knip-config/application"
 
 export default {
 	...application,
-	ignore: ["FFXIVReplayAnalyzer/**"]
+	ignore: ["another-project/**"]
 }
 ```
 
-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.
+Knip prints a configuration hint when a repository with `workspaces` writes
+`entry` at the top level. A hint is not a report, so the exit code does not
+change.

package/application.ts

@@ -1,9 +1,8 @@
 import type { KnipConfig } from "knip";
 import { base } from "./base";
 
-// frameworkが動的に読み込むentrypointは利用Projectが明示する
 /**
- * application向けのknip設定を提供する
+ * frameworkが動的に読み込むentryは利用Projectが明示するapplication向けのknip設定を提供する
  */
 export const application = {
 	...base,

package/base.ts

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

package/library.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/knip-config",
-	"version": "1.0.2",
+	"version": "1.0.4",
 	"description": "Shared Knip configuration",
 	"license": "MIT",
 	"repository": {