@yuu1111/knip-config 1.0.7 → 2.1.0

package/README.ja.md

@@ -37,13 +37,14 @@ export default {
 
 | Setting | 値 |
 |---------|-----|
-| `entry` | `["quality.config.ts"]` |
+| `entry` | `["quality.json"]` |
 | `ignoreExportsUsedInFile` | `true` |
-| `ignoreIssues` | `{"quality.config.ts": ["exports"]}` |
-
-`quality-check` は `quality.config.ts` を実行時に読み込むため、このfileはentry pointとして扱われ未使用fileとして報告しない
-`ignoreIssues` はこのfileのexportを報告から外す
+| `treatConfigHintsAsErrors` | `true` |
+| `treatTagHintsAsErrors` | `true` |
+`quality-check` は `quality.json` を実行時に読み込むため、このfileはentry pointとして扱われ未使用fileとして報告しない
 利用側の公開APIは `quality-check` のAPIであり、このfileのexportではない
+`treatConfigHintsAsErrors` は設定がProjectの実態と合わなくなったときに実行を失敗させる
+`treatTagHintsAsErrors` は抑制しなくなったtagがあるときに実行を失敗させる
 
 ### application
 
@@ -57,30 +58,32 @@ applicationのentry pointは公開契約ではないため `includeEntryExports:
 
 動的なentry point、CLI binary、生成物は共有presetがProject構成から推測できないため、利用Project側で足す
 
-`entry` は利用Projectが書くと置き換わるため `quality.config.ts` も並べる
+`entry` は利用Projectが書くと置き換わるため `quality.json` も並べる
 
 ```ts
 export default {
 	...application,
-	entry: ["src/main.ts", "quality.config.ts"]
+	entry: ["src/main.ts", "quality.json"]
 }
 ```
 
-`workspaces` を使う場合、`base` が足すtop levelの `entry` はroot workspaceへ届かないためroot workspace側にも書く
+`workspaces` を使う場合、`base` が足すtop levelの `entry` はroot workspaceへ届かないためroot workspace側へ移す
+top levelの `entry` を残すとKnipがconfiguration hintを出し、`base` はhintをerrorとして扱うため実行が失敗する
 
 ```ts
+import { application } from "@yuu1111/knip-config/application"
+
+const { entry, ...base } = application
+
 export default {
-	...application,
+	...base,
 	workspaces: {
-		".": { entry: ["quality.config.ts"] },
+		".": { entry },
 		"packages/app": { entry: ["src/cli.ts"] }
 	}
 }
 ```
 
-`workspaces` を持つrepositoryがtop levelにも `entry` を書くとKnipがconfiguration hintを出す
-報告ではないため終了codeは変わらない
-
 別Projectを同居させているrepositoryは `ignore` でそのProjectを報告から外し、親のsourceとして読ませない
 
 ```ts

package/README.md

@@ -37,12 +37,15 @@ Every preset extends `base`.
 
 | Setting | Value |
 |---------|-------|
-| `entry` | `["quality.config.ts"]` |
+| `entry` | `["quality.json"]` |
 | `ignoreExportsUsedInFile` | `true` |
-| `ignoreIssues` | `{"quality.config.ts": ["exports"]}` |
+| `treatConfigHintsAsErrors` | `true` |
+| `treatTagHintsAsErrors` | `true` |
 
-`quality-check` loads `quality.config.ts` at run time, so the file counts as an entry point and is not reported as unused.
-`ignoreIssues` keeps its exports out of the report, because the public API of a consuming project is the API of `quality-check` and not the exports of this file.
+`quality-check` loads `quality.json` at run time, so the file counts as an entry point and is not reported as unused.
+`ignoreExportsUsedInFile` keeps its exports out of the report, because the public API of a consuming project is the API of `quality-check` and not the exports of this file.
+`treatConfigHintsAsErrors` fails the run when a configuration no longer matches the project.
+`treatTagHintsAsErrors` fails the run when a suppression tag no longer suppresses anything.
 
 ### application
 
@@ -56,29 +59,32 @@ Sets `includeEntryExports: true`, so an export that is no longer part of the pub
 
 A shared preset cannot see dynamic entry points, CLI binaries, or generated files, so the project adds them.
 
-`entry` is replaced when the project writes its own, so list `quality.config.ts` too:
+`entry` is replaced when the project writes its own, so list `quality.json` too:
 
 ```ts
 export default {
 	...application,
-	entry: ["src/main.ts", "quality.config.ts"]
+	entry: ["src/main.ts", "quality.json"]
 }
 ```
 
-`workspaces` does not inherit the top-level `entry` in the root workspace, so write it there too:
+`workspaces` does not inherit the top-level `entry` in the root workspace, so move `entry` there:
 
 ```ts
+import { application } from "@yuu1111/knip-config/application"
+
+const { entry, ...base } = application
+
 export default {
-	...application,
+	...base,
 	workspaces: {
-		".": { entry: ["quality.config.ts"] },
+		".": { entry },
 		"packages/app": { entry: ["src/cli.ts"] }
 	}
 }
 ```
 
-Knip prints a configuration hint when a repository with `workspaces` also writes `entry` at the top level.
-A hint is not a report, so the exit code does not change.
+Knip prints a configuration hint when a repository with `workspaces` also writes `entry` at the top level, and `base` fails the run on a hint.
 
 A repository that also holds another project keeps it out of the report with `ignore`, so its files are not read as source of the parent:
 

package/base.ts

@@ -4,7 +4,8 @@ import type { KnipConfig } from "knip";
  * 各presetが共通で継承するbase設定を提供する
  */
 export const base = {
-	entry: ["quality.config.ts"],
+	entry: ["quality.json"],
 	ignoreExportsUsedInFile: true,
-	ignoreIssues: { "quality.config.ts": ["exports"] },
+	treatConfigHintsAsErrors: true,
+	treatTagHintsAsErrors: true,
 } satisfies KnipConfig;

package/package.json

@@ -1,7 +1,8 @@
 {
 	"name": "@yuu1111/knip-config",
-	"version": "1.0.7",
+	"version": "2.1.0",
 	"description": "Shared Knip configuration",
+	"homepage": "https://yuu1111.github.io/configs/packages/config/knip-config/",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/yuu1111/configs.git",