@yuu1111/quality-check 0.7.0 → 0.8.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、code-style-check、comment-check、document-style-check、TSDoc checkerを1つのCLIへまとめる baselineの差分判定もここで行う
 
 ## Install
 
@@ -30,14 +30,22 @@ export default defineConfig({
 		biome: true,
 		typecheck: true,
 		knip: true,
+		"code-style-check": true,
 		"comment-check": true,
 		"document-style-check": true,
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { enable: ["japanese-period"], ignore: ["another-project"] },
-		"document-style-check": { enable: ["japanese-period"] },
-		"tsdoc-check": { error: ["missing-doc"] },
+		"comment-check": {
+			enable: ["japanese-period"],
+			ignore: ["another-project"],
+		},
+		"document-style-check": {
+			enable: ["japanese-period"],
+		},
+		"tsdoc-check": {
+			error: ["missing-doc"],
+		},
 	},
 });
 ```
@@ -66,15 +74,16 @@ quality-check: 1 of 3 engines failed
 | `config` | engineごとの起動条件 |
 | `baseline` | baseline fileのpath `false` なら差分判定を行わない |
 
-engineは `biome` → `typecheck` → `knip` → `comment-check` → `document-style-check` → `tsdoc-check` の順に実行する
+engineは `biome` → `typecheck` → `knip` → `code-style-check` → `comment-check` → `document-style-check` → `tsdoc-check` の順に実行する
 
-`engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineが受け取る条件は次のとおり
+`engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineごとの条件は複数行のobjectとして書き、ruleやoptionを足しても他のengineの行が動かないようにする engineが受け取る条件は次のとおり
 
 | engine | 起動するcommand | 受け取る条件 |
 |--------|-----------------|--------------|
 | `biome` | `biome check` | `targets`、`args` 除外pathは `biome.json` が持つ |
 | `typecheck` | `tsc --noEmit` | `args`、`projects` 設定は `tsconfig.json` が持つ |
 | `knip` | `knip` | `args` 設定は `knip.ts` が持つ |
+| `code-style-check` | `code-style-check --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名） |
@@ -117,4 +126,3 @@ engineのbinaryは利用Projectの `node_modules/.bin` から実行時に解決
 `enable` は `comment-check` と `document-style-check` のopt-in ruleだけを受け取り、それぞれのcommandの `--enable <rule>` になる 他のengineへ書くとunknown optionとして拒否し、既定のrule集合は変えない このCLIはengineを同梱しないため、opt-in ruleを有効にするProjectは対応するengine packageも同じ変更で更新する
 
 `typecheck` は `projects` に並べたtsconfigごとに `tsc --noEmit -p <path>` を起動する 省略時はカレントの `tsconfig.json` を1回だけ読み、`args` はすべての起動へ足す
-

package/README.md

@@ -2,9 +2,9 @@
 
 # @yuu1111/quality-check
 
-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.
+Runs Biome, the type checker, Knip, code-style-check, 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
 
@@ -33,14 +33,22 @@ export default defineConfig({
 		biome: true,
 		typecheck: true,
 		knip: true,
+		"code-style-check": true,
 		"comment-check": true,
 		"document-style-check": true,
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { enable: ["japanese-period"], ignore: ["another-project"] },
-		"document-style-check": { enable: ["japanese-period"] },
-		"tsdoc-check": { error: ["missing-doc"] },
+		"comment-check": {
+			enable: ["japanese-period"],
+			ignore: ["another-project"],
+		},
+		"document-style-check": {
+			enable: ["japanese-period"],
+		},
+		"tsdoc-check": {
+			error: ["missing-doc"],
+		},
 	},
 });
 ```
@@ -70,17 +78,19 @@ 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`, `typecheck`, `knip`, `comment-check`,
-`document-style-check`, `tsdoc-check`.
+Engines run in the order `biome`, `typecheck`, `knip`, `code-style-check`,
+`comment-check`, `document-style-check`, `tsdoc-check`.
 
 `engines` only delegates the start-up, and the conditions belong under the
-engine in `config`. Each engine runs:
+engine in `config`. Write an engine's conditions as a multi-line object, so a
+new rule or option changes one engine's block alone. Each engine runs:
 
 | Engine | Command | Conditions |
 |--------|---------|------------|
 | `biome` | `biome check` | `targets`, `args`; `biome.json` holds the excluded paths |
 | `typecheck` | `tsc --noEmit` | `args`, `projects`; `tsconfig.json` holds the settings |
 | `knip` | `knip` | `args`; `knip.ts` holds the settings |
+| `code-style-check` | `code-style-check --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) |

package/bin/cli.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env bun
+import { run } from "../dist/cli.js";
+
+run();

package/dist/cli.js

@@ -198,6 +198,7 @@ var ENGINE_NAMES = [
   "biome",
   "typecheck",
   "knip",
+  "code-style-check",
   "comment-check",
   "document-style-check",
   "tsdoc-check"
@@ -219,6 +220,7 @@ var ENGINE_OPTION_KEYS = {
   biome: ["args", "ignore", "targets"],
   typecheck: ["args", "ignore", "projects", "targets"],
   knip: ["args", "ignore", "targets"],
+  "code-style-check": ["args", "ignore", "targets"],
   "comment-check": ["args", "enable", "ignore", "targets"],
   "document-style-check": ["args", "enable", "ignore", "targets"],
   "tsdoc-check": ["args", "error", "ignore", "targets"]
@@ -375,6 +377,7 @@ import { existsSync as existsSync3 } from "fs";
 import { dirname, join } from "path";
 var ENGINE_BINS = {
   biome: "biome",
+  "code-style-check": "code-style-check",
   "comment-check": "comment-check",
   "document-style-check": "document-style-check",
   knip: "knip",
@@ -393,6 +396,7 @@ var ENGINE_LIMITS = {
     ignore: "knip.ts holds its settings",
     targets: "knip analyzes the whole project"
   },
+  "code-style-check": {},
   "comment-check": {},
   "document-style-check": {},
   "tsdoc-check": {}
@@ -412,7 +416,7 @@ function skippedEngineOptions(name, options) {
   return skipped;
 }
 function isFindingEngine(name) {
-  return name === "comment-check" || name === "document-style-check" || name === "tsdoc-check";
+  return name === "code-style-check" || name === "comment-check" || name === "document-style-check" || name === "tsdoc-check";
 }
 function resolveExecutable(name, cwd) {
   const shims = process.platform === "win32" ? WINDOWS_SHIMS : POSIX_SHIMS;
@@ -507,6 +511,9 @@ function buildEngineCommand(name, executable, context) {
       ...extra
     ];
   }
+  if (name === "code-style-check") {
+    return [executable, "--json", ...targets, ...ignoreArguments, ...extra];
+  }
   return [
     executable,
     "--json",
@@ -858,4 +865,12 @@ async function main(argv) {
   }
   return results.some((result) => result.status !== "passed") ? 1 : 0;
 }
-runCli(main);
+function run() {
+  runCli(main);
+}
+if (import.meta.main) {
+  run();
+}
+export {
+  run
+};

package/package.json

@@ -1,15 +1,15 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.7.0",
+	"version": "0.8.0",
 	"description": "Integrated quality check runner",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/yuu1111/configs.git",
-		"directory": "packages/quality-check"
+		"directory": "packages/engine/quality-check"
 	},
 	"type": "module",
 	"bin": {
-		"quality-check": "dist/cli.js"
+		"quality-check": "bin/cli.js"
 	},
 	"exports": {
 		".": "./src/config.ts",
@@ -17,6 +17,7 @@
 	},
 	"files": [
 		"README.ja.md",
+		"bin",
 		"src/config.ts",
 		"src/engines.ts",
 		"dist"

package/src/config.ts

@@ -9,6 +9,7 @@ export const ENGINE_NAMES = [
 	"biome",
 	"typecheck",
 	"knip",
+	"code-style-check",
 	"comment-check",
 	"document-style-check",
 	"tsdoc-check",
@@ -70,6 +71,7 @@ export interface EngineConfigMap {
 	biome: EngineOptions;
 	typecheck: TypecheckOptions;
 	knip: EngineOptions;
+	"code-style-check": EngineOptions;
 	"comment-check": CommentCheckOptions;
 	"document-style-check": DocumentStyleCheckOptions;
 	"tsdoc-check": TsdocCheckOptions;
@@ -123,6 +125,7 @@ const ENGINE_OPTION_KEYS: Record<EngineName, readonly string[]> = {
 	biome: ["args", "ignore", "targets"],
 	typecheck: ["args", "ignore", "projects", "targets"],
 	knip: ["args", "ignore", "targets"],
+	"code-style-check": ["args", "ignore", "targets"],
 	"comment-check": ["args", "enable", "ignore", "targets"],
 	"document-style-check": ["args", "enable", "ignore", "targets"],
 	"tsdoc-check": ["args", "error", "ignore", "targets"],

package/src/engines.ts

@@ -29,6 +29,7 @@ export type EngineRunner = (
  */
 export const ENGINE_BINS: Record<EngineName, string> = {
 	biome: "biome",
+	"code-style-check": "code-style-check",
 	"comment-check": "comment-check",
 	"document-style-check": "document-style-check",
 	knip: "knip",
@@ -76,6 +77,7 @@ export const ENGINE_LIMITS: Record<
 		ignore: "knip.ts holds its settings",
 		targets: "knip analyzes the whole project",
 	},
+	"code-style-check": {},
 	"comment-check": {},
 	"document-style-check": {},
 	"tsdoc-check": {},
@@ -107,6 +109,7 @@ export function skippedEngineOptions(
  */
 export function isFindingEngine(name: EngineName): boolean {
 	return (
+		name === "code-style-check" ||
 		name === "comment-check" ||
 		name === "document-style-check" ||
 		name === "tsdoc-check"
@@ -249,6 +252,9 @@ export function buildEngineCommand(
 			...extra,
 		];
 	}
+	if (name === "code-style-check") {
+		return [executable, "--json", ...targets, ...ignoreArguments, ...extra];
+	}
 	return [
 		executable,
 		"--json",