@yuu1111/knip-config 1.0.6 → 1.0.7

package/README.ja.md

@@ -12,7 +12,7 @@ bun add -D @yuu1111/knip-config knip
 
 ## Usage
 
-Knipは `knip.ts` を読むため、Projectに合うpresetをimportしてProject固有のentryを足す
+Knipは `knip.ts` を読むため、Projectに合うpresetをimportし、presetが推測できないentryを足す
 
 ```ts
 import { application } from "@yuu1111/knip-config/application"
@@ -25,31 +25,39 @@ export default {
 
 ## Presets
 
-| Preset | Use case |
-|--------|----------|
-| `base` | 共有の既定値 |
-| `application` | entry pointをframeworkが解決するapplication |
-| `library` | entry pointが公開APIそのものであるlibrary |
+| Preset | `includeEntryExports` | 用途 |
+|--------|----------------------|------|
+| `base` | — | 共有の既定値 |
+| `application` | `false` | entry pointをframeworkが解決するapplication |
+| `library` | `true` | entry pointが公開APIそのものであるlibrary |
 
 ### base
 
-- `ignoreExportsUsedInFile` は自分のfile内だけで参照されるexportを報告から外す
-- `entry` は `quality-check` が実行時に読み込む `quality.config.ts` をentry pointとして扱う 未使用fileとして報告せず、このfileがimportするexportも利用中とみなす
-- `ignoreIssues` は `quality.config.ts` 自身のexportを報告から外す 利用側の入口は `quality-check` のAPIであり、このfileのexportではない
+すべてのpresetが `base` をextendsする
+
+| Setting | 値 |
+|---------|-----|
+| `entry` | `["quality.config.ts"]` |
+| `ignoreExportsUsedInFile` | `true` |
+| `ignoreIssues` | `{"quality.config.ts": ["exports"]}` |
+
+`quality-check` は `quality.config.ts` を実行時に読み込むため、このfileはentry pointとして扱われ未使用fileとして報告しない
+`ignoreIssues` はこのfileのexportを報告から外す
+利用側の公開APIは `quality-check` のAPIであり、このfileのexportではない
 
 ### application
 
-- applicationのentry pointは公開契約ではないため `includeEntryExports` はoffのままにする
+applicationのentry pointは公開契約ではないため `includeEntryExports: false` を設定する
 
 ### library
 
-- 公開APIから外れたexportを報告するため `includeEntryExports` をonにする
+公開APIから外れたexportを報告するため `includeEntryExports: true` を設定する
 
-## Notes
+## Config
 
-動的なentry point、CLI binary、生成物は共有presetがProject構成から推測できないため利用Project側に残す
+動的なentry point、CLI binary、生成物は共有presetがProject構成から推測できないため、利用Project側で足す
 
-`base` が足す `entry` は、利用Projectが `entry` を書くと置き換わる 自分のentryを足すときは `quality.config.ts` も並べる
+`entry` は利用Projectが書くと置き換わるため `quality.config.ts` も並べる
 
 ```ts
 export default {
@@ -58,7 +66,7 @@ export default {
 }
 ```
 
-`workspaces` を設定に書くと、`base` が足すtop levelの `entry` はroot workspaceへ届かない root workspace側にも `entry` を書く
+`workspaces` を使う場合、`base` が足すtop levelの `entry` はroot workspaceへ届かないためroot workspace側にも書く
 
 ```ts
 export default {
@@ -70,15 +78,14 @@ export default {
 }
 ```
 
+`workspaces` を持つrepositoryがtop levelにも `entry` を書くとKnipがconfiguration hintを出す
+報告ではないため終了codeは変わらない
+
 別Projectを同居させているrepositoryは `ignore` でそのProjectを報告から外し、親のsourceとして読ませない
 
 ```ts
-import { application } from "@yuu1111/knip-config/application"
-
 export default {
 	...application,
 	ignore: ["another-project/**"]
 }
 ```
-
-`workspaces` を持つrepositoryで `entry` をtop levelに書くとKnipがconfiguration hintを出す 報告ではないため終了codeは変わらない

package/README.md

@@ -12,8 +12,7 @@ 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:
+Knip loads `knip.ts`, so import the preset that matches the project and add the entries it cannot infer:
 
 ```ts
 import { application } from "@yuu1111/knip-config/application"
@@ -26,33 +25,38 @@ export default {
 
 ## 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 |
+| Preset | `includeEntryExports` | Use case |
+|--------|----------------------|----------|
+| `base` | — | Shared defaults |
+| `application` | `false` | Applications whose entry points a framework resolves |
+| `library` | `true` | Libraries whose entry points are their public API |
 
 ### 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
+Every preset extends `base`.
+
+| Setting | Value |
+|---------|-------|
+| `entry` | `["quality.config.ts"]` |
+| `ignoreExportsUsedInFile` | `true` |
+| `ignoreIssues` | `{"quality.config.ts": ["exports"]}` |
+
+`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.
 
 ### application
 
-- `includeEntryExports` stays off because the entry points of an application are not a public contract
+Sets `includeEntryExports: false`, 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
+Sets `includeEntryExports: true`, so an export that is no longer part of the public API is reported.
 
-## Notes
+## Config
 
-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 shared preset cannot see dynamic entry points, CLI binaries, or generated files, so the project adds them.
 
-The `entry` that `base` adds is replaced when a project writes its own `entry`,
-so an added entry lists `quality.config.ts` as well:
+`entry` is replaced when the project writes its own, so list `quality.config.ts` too:
 
 ```ts
 export default {
@@ -61,8 +65,7 @@ export default {
 }
 ```
 
-Writing `workspaces` in the config means the top-level `entry` that `base`
-adds does not reach the root workspace, so the root workspace repeats it:
+`workspaces` does not inherit the top-level `entry` in the root workspace, so write it there too:
 
 ```ts
 export default {
@@ -74,18 +77,14 @@ export default {
 }
 ```
 
-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:
+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.
 
-```ts
-import { application } from "@yuu1111/knip-config/application"
+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:
 
+```ts
 export default {
 	...application,
 	ignore: ["another-project/**"]
 }
 ```
-
-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

@@ -6,6 +6,5 @@ import { base } from "./base";
  */
 export const application = {
 	...base,
-	// applicationのentryは公開契約ではないため未使用exportとして報告しない
 	includeEntryExports: false,
 } satisfies KnipConfig;

package/base.ts

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

package/library.ts

@@ -6,6 +6,5 @@ import { base } from "./base";
  */
 export const library = {
 	...base,
-	// 公開APIから外れたexportを未使用として報告する
 	includeEntryExports: true,
 } satisfies KnipConfig;

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@yuu1111/knip-config",
-	"version": "1.0.6",
+	"version": "1.0.7",
 	"description": "Shared Knip configuration",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/yuu1111/configs.git",
-		"directory": "packages/knip-config"
+		"directory": "packages/config/knip-config"
 	},
 	"type": "module",
 	"exports": {