@yuu1111/quality-check 0.3.0 → 0.4.0

package/README.ja.md

@@ -2,7 +2,7 @@
 
 # @yuu1111/quality-check
 
-Projectごとのscriptから個別に呼んでいたBiome、Knip、comment-check、document-style-check、TSDoc checkerを1つのCLIへまとめる baselineの差分判定もここで行う
+Projectごとのscriptから個別に呼んでいたBiome、型検査、Knip、comment-check、document-style-check、TSDoc checkerを1つのCLIへまとめる baselineの差分判定もここで行う
 
 ## Install
 
@@ -28,6 +28,7 @@ import { defineConfig } from "@yuu1111/quality-check";
 export default defineConfig({
 	engines: {
 		biome: true,
+		typecheck: true,
 		knip: true,
 		"comment-check": true,
 		"document-style-check": true,
@@ -64,17 +65,18 @@ quality-check: 1 of 3 engines failed
 | `config` | engineごとの起動条件 |
 | `baseline` | baseline fileのpath `false` なら差分判定を行わない |
 
-engineは `biome` → `knip` → `comment-check` → `document-style-check` → `tsdoc-check` の順に実行する
+engineは `biome` → `typecheck` → `knip` → `comment-check` → `document-style-check` → `tsdoc-check` の順に実行する
 
 `engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineが受け取る条件は次のとおり
 
-| engine | 受け取る条件 |
-|--------|--------------|
-| `biome` | `targets`、`args` 除外pathは `biome.json` が持つ |
-| `knip` | `args` 設定は `knip.ts` が持つ |
-| `comment-check` | `ignore`、`targets`、`args` |
-| `document-style-check` | `ignore`、`targets`、`args` |
-| `tsdoc-check` | `ignore`、`targets`、`args`、`error`（違反として扱うrule名） |
+| engine | 起動するcommand | 受け取る条件 |
+|--------|-----------------|--------------|
+| `biome` | `biome check` | `targets`、`args` 除外pathは `biome.json` が持つ |
+| `typecheck` | `tsc --noEmit` | `args` 設定は `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` |
+| `tsdoc-check` | `tsdoc-check --json` | `ignore`、`targets`、`args`、`error`（違反として扱うrule名） |
 
 `args` はengineの既定引数の後ろへ足す 設定fileで表せない起動条件や、engineの引数が変わったときの逃げ道として使う
 
@@ -101,10 +103,12 @@ engineが受け取らない条件を書いた場合は渡さず、その旨を
 biome: ignore skipped (biome.json holds its settings)
 ```
 
-BiomeとKnipの除外pathは `biome.json` と `knip.ts` が持つ このCLIは同じfileからengineの起動と結果の集約だけを行う
+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` で移す
 
+`typecheck` は `tsc --noEmit` を回すだけなので、tsconfigを複数持つProjectは対象のtsconfigごとに起動する必要がある
+
 ## License
 
 MIT

package/README.md

@@ -2,8 +2,9 @@
 
 # @yuu1111/quality-check
 
-Runs Biome, Knip, comment-check, document-style-check, and the TSDoc checker
-from one CLI instead of one script per project. The baseline diff lives here too.
+Runs Biome, the type checker, Knip, comment-check, document-style-check, and the
+TSDoc checker from one CLI instead of one script per project. The baseline diff
+lives here too.
 
 ## Install
 
@@ -30,6 +31,7 @@ import { defineConfig } from "@yuu1111/quality-check";
 export default defineConfig({
 	engines: {
 		biome: true,
+		typecheck: true,
 		knip: true,
 		"comment-check": true,
 		"document-style-check": true,
@@ -67,19 +69,20 @@ quality-check: 1 of 3 engines failed
 | `config` | Conditions of each engine |
 | `baseline` | Baseline file path; `false` disables the diff |
 
-Engines run in the order `biome`, `knip`, `comment-check`,
+Engines run in the order `biome`, `typecheck`, `knip`, `comment-check`,
 `document-style-check`, `tsdoc-check`.
 
 `engines` only delegates the start-up, and the conditions belong under the
-engine in `config`. Each engine takes:
+engine in `config`. Each engine runs:
 
-| Engine | Conditions |
-|--------|------------|
-| `biome` | `targets`, `args`; `biome.json` holds the excluded paths |
-| `knip` | `args`; `knip.ts` holds the settings |
-| `comment-check` | `ignore`, `targets`, `args` |
-| `document-style-check` | `ignore`, `targets`, `args` |
-| `tsdoc-check` | `ignore`, `targets`, `args`, `error` (rule names to fail on) |
+| Engine | Command | Conditions |
+|--------|---------|------------|
+| `biome` | `biome check` | `targets`, `args`; `biome.json` holds the excluded paths |
+| `typecheck` | `tsc --noEmit` | `args`; `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` |
+| `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
 express and for the case where an engine changes its arguments.
@@ -109,14 +112,18 @@ so:
 biome: ignore skipped (biome.json holds its settings)
 ```
 
-Biome and Knip keep their excluded paths in `biome.json` and `knip.ts`. This
-CLI starts the engines from one file and aggregates the results.
+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.
 
 `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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"description": "Integrated quality check runner",
 	"license": "MIT",
 	"repository": {

package/src/config.ts

@@ -7,6 +7,7 @@ import { pathToFileURL } from "node:url";
  */
 export const ENGINE_NAMES = [
 	"biome",
+	"typecheck",
 	"knip",
 	"comment-check",
 	"document-style-check",
@@ -43,6 +44,7 @@ export interface TsdocCheckOptions extends EngineOptions {
  */
 export interface EngineConfigMap {
 	biome: EngineOptions;
+	typecheck: EngineOptions;
 	knip: EngineOptions;
 	"comment-check": EngineOptions;
 	"document-style-check": EngineOptions;
@@ -95,6 +97,7 @@ function isEngineName(value: string): value is EngineName {
 
 const ENGINE_OPTION_KEYS: Record<EngineName, readonly string[]> = {
 	biome: ["args", "ignore", "targets"],
+	typecheck: ["args", "ignore", "targets"],
 	knip: ["args", "ignore", "targets"],
 	"comment-check": ["args", "ignore", "targets"],
 	"document-style-check": ["args", "ignore", "targets"],

package/src/engines.ts

@@ -33,6 +33,7 @@ export const ENGINE_BINS: Record<EngineName, string> = {
 	"document-style-check": "document-style-check",
 	knip: "knip",
 	"tsdoc-check": "tsdoc-check",
+	typecheck: "tsc",
 };
 
 const WINDOWS_SHIMS = [".exe", ".cmd", ".bat", ""];
@@ -65,6 +66,10 @@ export const ENGINE_LIMITS: Record<
 	Partial<Record<"ignore" | "targets", string>>
 > = {
 	biome: { ignore: "biome.json holds its settings" },
+	typecheck: {
+		ignore: "tsconfig.json holds its settings",
+		targets: "tsc checks the project named by tsconfig.json",
+	},
 	knip: {
 		ignore: "knip.ts holds its settings",
 		targets: "knip analyzes the whole project",
@@ -164,6 +169,9 @@ export function buildEngineCommand(
 	if (name === "biome") {
 		return [executable, "check", ...targets, ...extra];
 	}
+	if (name === "typecheck") {
+		return [executable, "--noEmit", ...extra];
+	}
 	if (name === "knip") {
 		return [executable, ...extra];
 	}