@yuu1111/quality-check 0.5.0 → 0.6.0

package/README.ja.md

@@ -72,7 +72,7 @@ engineは `biome` → `typecheck` → `knip` → `comment-check` → `document-s
 | engine | 起動するcommand | 受け取る条件 |
 |--------|-----------------|--------------|
 | `biome` | `biome check` | `targets`、`args` 除外pathは `biome.json` が持つ |
-| `typecheck` | `tsc --noEmit` | `args` 設定は `tsconfig.json` が持つ |
+| `typecheck` | `tsc --noEmit` | `args`、`projects` 設定は `tsconfig.json` が持つ |
 | `knip` | `knip` | `args` 設定は `knip.ts` が持つ |
 | `comment-check` | `comment-check --json` | `ignore`、`targets`、`args` |
 | `document-style-check` | `document-style-check lint --json` | `ignore`、`targets`、`args` |
@@ -109,10 +109,9 @@ biome: ignore skipped (biome.json holds its settings)
 
 Biome、型検査、Knipの設定は `biome.json`、`tsconfig.json`、`knip.ts` が持つ このCLIは同じfileからengineの起動と結果の集約だけを行う
 
-`comment-check` はbaseline差分を無効化する未作成のpathを渡して起動する 新規と解消済みの判定はengineごとではなく統合CLIが1つのbaseline fileで行うため、既存の `comment-baseline.json` がある場合は `--update-baseline` で移す
+engineのbinaryは利用Projectの `node_modules/.bin` から実行時に解決する engineを自分のscriptから呼ばないProjectではKnipが `@yuu1111/comment-check` などを未使用依存として報告するため `knip.ts` の `ignoreDependencies` で理由付きに宣言する
 
-`typecheck` は `tsc --noEmit` を回すだけなので、tsconfigを複数持つProjectは対象のtsconfigごとに起動する必要がある
+`comment-check` はbaseline差分を無効化する未作成のpathを渡して起動する 新規と解消済みの判定はengineごとではなく統合CLIが1つのbaseline fileで行うため、既存の `comment-baseline.json` がある場合は `--update-baseline` で移す
 
-## License
+`typecheck` は `projects` に並べたtsconfigごとに `tsc --noEmit -p <path>` を起動する 省略時はカレントの `tsconfig.json` を1回だけ読み、`args` はすべての起動へ足す
 
-MIT

package/README.md

@@ -78,7 +78,7 @@ engine in `config`. Each engine runs:
 | Engine | Command | Conditions |
 |--------|---------|------------|
 | `biome` | `biome check` | `targets`, `args`; `biome.json` holds the excluded paths |
-| `typecheck` | `tsc --noEmit` | `args`; `tsconfig.json` holds the settings |
+| `typecheck` | `tsc --noEmit` | `args`, `projects`; `tsconfig.json` holds the settings |
 | `knip` | `knip` | `args`; `knip.ts` holds the settings |
 | `comment-check` | `comment-check --json` | `ignore`, `targets`, `args` |
 | `document-style-check` | `document-style-check lint --json` | `ignore`, `targets`, `args` |
@@ -122,14 +122,16 @@ Biome, the type checker, and Knip keep their settings in `biome.json`,
 `tsconfig.json`, and `knip.ts`. This CLI starts the engines from one file and
 aggregates the results.
 
+An engine binary is resolved at run time from the `node_modules/.bin` of the
+project. A project that never calls an engine from its own scripts therefore
+sees Knip report `@yuu1111/comment-check` and its siblings as unused
+dependencies, so it declares them in `ignoreDependencies` with the reason.
+
 `comment-check` runs with an unwritten baseline path so that it reports every
 finding. The new-and-resolved diff is done by this CLI from a single baseline
 file, so an existing `comment-baseline.json` is moved over with
 `--update-baseline`.
 
-`typecheck` only runs `tsc --noEmit`, so a project with more than one tsconfig
-has to start it once per target.
-
-## License
-
-MIT
+`typecheck` starts `tsc --noEmit -p <path>` once per path in `projects`. Without
+it the current `tsconfig.json` is read once, and `args` are added to every
+start.