@yuu1111/quality-check 0.5.1 → 0.7.0

package/README.ja.md

@@ -35,7 +35,8 @@ export default defineConfig({
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { ignore: ["another-project"] },
+		"comment-check": { enable: ["japanese-period"], ignore: ["another-project"] },
+		"document-style-check": { enable: ["japanese-period"] },
 		"tsdoc-check": { error: ["missing-doc"] },
 	},
 });
@@ -72,10 +73,10 @@ 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` |
+| `comment-check` | `comment-check --json` | `ignore`、`targets`、`args`、`enable`（有効にするrule名） |
+| `document-style-check` | `document-style-check lint --json` | `ignore`、`targets`、`args`、`enable`（有効にするrule名） |
 | `tsdoc-check` | `tsdoc-check --json` | `ignore`、`targets`、`args`、`error`（違反として扱うrule名） |
 
 `args` はengineの既定引数の後ろへ足す 設定fileで表せない起動条件や、engineの引数が変わったときの逃げ道として使う
@@ -113,8 +114,7 @@ engineのbinaryは利用Projectの `node_modules/.bin` から実行時に解決
 
 `comment-check` はbaseline差分を無効化する未作成のpathを渡して起動する 新規と解消済みの判定はengineごとではなく統合CLIが1つのbaseline fileで行うため、既存の `comment-baseline.json` がある場合は `--update-baseline` で移す
 
-`typecheck` は `tsc --noEmit` を回すだけなので、tsconfigを複数持つProjectは対象のtsconfigごとに起動する必要がある
+`enable` は `comment-check` と `document-style-check` のopt-in ruleだけを受け取り、それぞれのcommandの `--enable <rule>` になる 他のengineへ書くとunknown optionとして拒否し、既定のrule集合は変えない このCLIはengineを同梱しないため、opt-in ruleを有効にするProjectは対応するengine packageも同じ変更で更新する
 
-## License
+`typecheck` は `projects` に並べたtsconfigごとに `tsc --noEmit -p <path>` を起動する 省略時はカレントの `tsconfig.json` を1回だけ読み、`args` はすべての起動へ足す
 
-MIT

package/README.md

@@ -38,7 +38,8 @@ export default defineConfig({
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { ignore: ["another-project"] },
+		"comment-check": { enable: ["japanese-period"], ignore: ["another-project"] },
+		"document-style-check": { enable: ["japanese-period"] },
 		"tsdoc-check": { error: ["missing-doc"] },
 	},
 });
@@ -78,10 +79,10 @@ 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` |
+| `comment-check` | `comment-check --json` | `ignore`, `targets`, `args`, `enable` (rule names to turn on) |
+| `document-style-check` | `document-style-check lint --json` | `ignore`, `targets`, `args`, `enable` (rule names to turn on) |
 | `tsdoc-check` | `tsdoc-check --json` | `ignore`, `targets`, `args`, `error` (rule names to fail on) |
 
 `args` is appended after the engine defaults, for conditions the config cannot
@@ -132,9 +133,12 @@ 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.
+`enable` names the opt-in rules of `comment-check` and `document-style-check`
+and becomes `--enable <rule>` on each of their commands. The other engines
+reject the field, and the default rule set stays as it is. This CLI ships no
+engine of its own, so a project that turns an opt-in rule on updates the
+matching engine package in the same change.
 
-## 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.