@yuu1111/quality-check 0.7.0 → 0.7.1

package/README.ja.md

@@ -35,9 +35,16 @@ export default defineConfig({
 		"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"],
+		},
 	},
 });
 ```
@@ -68,7 +75,7 @@ quality-check: 1 of 3 engines failed
 
 engineは `biome` → `typecheck` → `knip` → `comment-check` → `document-style-check` → `tsdoc-check` の順に実行する
 
-`engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineが受け取る条件は次のとおり
+`engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineごとの条件は複数行のobjectとして書き、ruleやoptionを足しても他のengineの行が動かないようにする engineが受け取る条件は次のとおり
 
 | engine | 起動するcommand | 受け取る条件 |
 |--------|-----------------|--------------|

package/README.md

@@ -38,9 +38,16 @@ export default defineConfig({
 		"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"],
+		},
 	},
 });
 ```
@@ -74,7 +81,8 @@ 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 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 |
 |--------|---------|------------|

package/bin/cli.js

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

package/dist/cli.js

@@ -858,4 +858,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,6 +1,6 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.7.0",
+	"version": "0.7.1",
 	"description": "Integrated quality check runner",
 	"repository": {
 		"type": "git",
@@ -9,7 +9,7 @@
 	},
 	"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"