@yuu1111/knip-config 1.0.1 → 1.0.3

package/README.ja.md

@@ -34,6 +34,7 @@ export default {
 ### base
 
 - `ignoreExportsUsedInFile` は自分のfile内だけで参照されるexportを報告から外す
+- `ignoreFiles` は `quality-check` が実行時に読み込む `quality.config.ts` を報告から外す
 
 ### application
 
@@ -54,8 +55,6 @@ import { application } from "@yuu1111/knip-config/application"
 
 export default {
 	...application,
-	ignore: ["FFXIVReplayAnalyzer/**"]
+	ignore: ["another-project/**"]
 }
 ```
-
-そのrepositoryではpresetだけで未使用exportが48件から41件になり、入れ子Projectを外すとrepositoryに本当に残った未使用type 1件まで減った

package/README.md

@@ -57,10 +57,6 @@ 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.

package/application.ts

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

package/base.ts

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

package/library.ts

@@ -1,9 +1,11 @@
 import type { KnipConfig } from "knip";
 import { base } from "./base";
 
-// 公開APIのentryから未使用になったexportを報告する
-/** 公開APIのentryを持つlibrary向けのknip設定を提供する */
+/**
+ * 公開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.1",
+	"version": "1.0.3",
 	"description": "Shared Knip configuration",
 	"license": "MIT",
 	"repository": {