@yuu1111/quality-check 0.0.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +3 -2
- package/README.md +4 -3
- package/package.json +1 -1
- package/src/cli.ts +0 -0
- package/src/config.ts +1 -0
- package/src/engines.ts +16 -1
package/README.ja.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# @yuu1111/quality-check
|
|
4
4
|
|
|
5
|
-
Projectごとのscriptから個別に呼んでいたBiome、Knip、comment-check、TSDoc checkerを1つのCLIへまとめる baselineの差分判定もここで行う
|
|
5
|
+
Projectごとのscriptから個別に呼んでいたBiome、Knip、comment-check、document-style-check、TSDoc checkerを1つのCLIへまとめる baselineの差分判定もここで行う
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -30,6 +30,7 @@ export default defineConfig({
|
|
|
30
30
|
biome: true,
|
|
31
31
|
knip: true,
|
|
32
32
|
"comment-check": true,
|
|
33
|
+
"document-style-check": true,
|
|
33
34
|
"tsdoc-check": { args: ["--error", "missing-doc"] },
|
|
34
35
|
},
|
|
35
36
|
ignore: ["FFXIVReplayAnalyzer"],
|
|
@@ -61,7 +62,7 @@ quality-check: 1 of 3 engines failed
|
|
|
61
62
|
| `baseline` | baseline fileのpath `false` なら差分判定を行わない |
|
|
62
63
|
| `targets` | file走査engineへ渡す対象path |
|
|
63
64
|
|
|
64
|
-
engineは `biome` → `knip` → `comment-check` → `tsdoc-check` の順に実行する
|
|
65
|
+
engineは `biome` → `knip` → `comment-check` → `document-style-check` → `tsdoc-check` の順に実行する
|
|
65
66
|
`args` はengineの既定引数の後ろへ足すため、`tsdoc-check` の `--error` のようなengine固有の指定はここへ置く
|
|
66
67
|
|
|
67
68
|
## Options
|
package/README.md
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# @yuu1111/quality-check
|
|
4
4
|
|
|
5
|
-
Runs Biome, Knip, comment-check, and the TSDoc checker
|
|
6
|
-
one script per project. The baseline diff lives here too.
|
|
5
|
+
Runs Biome, Knip, comment-check, document-style-check, and the TSDoc checker
|
|
6
|
+
from one CLI instead of one script per project. The baseline diff lives here too.
|
|
7
7
|
|
|
8
8
|
## Install
|
|
9
9
|
|
|
@@ -32,6 +32,7 @@ export default defineConfig({
|
|
|
32
32
|
biome: true,
|
|
33
33
|
knip: true,
|
|
34
34
|
"comment-check": true,
|
|
35
|
+
"document-style-check": true,
|
|
35
36
|
"tsdoc-check": { args: ["--error", "missing-doc"] },
|
|
36
37
|
},
|
|
37
38
|
ignore: ["FFXIVReplayAnalyzer"],
|
|
@@ -64,7 +65,7 @@ quality-check: 1 of 3 engines failed
|
|
|
64
65
|
| `baseline` | Baseline file path; `false` disables the diff |
|
|
65
66
|
| `targets` | Targets passed to the file-scanning engines |
|
|
66
67
|
|
|
67
|
-
Engines run in the order `biome`, `knip`, `comment-check`, `tsdoc-check`.
|
|
68
|
+
Engines run in the order `biome`, `knip`, `comment-check`, `document-style-check`, `tsdoc-check`.
|
|
68
69
|
`args` is appended after the engine defaults, so engine-specific flags such as
|
|
69
70
|
`--error` for `tsdoc-check` belong there.
|
|
70
71
|
|
package/package.json
CHANGED
package/src/cli.ts
CHANGED
|
File without changes
|
package/src/config.ts
CHANGED
package/src/engines.ts
CHANGED
|
@@ -25,6 +25,7 @@ export type EngineRunner = (
|
|
|
25
25
|
export const ENGINE_BINS: Record<EngineName, string> = {
|
|
26
26
|
biome: "biome",
|
|
27
27
|
"comment-check": "comment-check",
|
|
28
|
+
"document-style-check": "document-style-check",
|
|
28
29
|
knip: "knip",
|
|
29
30
|
"tsdoc-check": "tsdoc-check",
|
|
30
31
|
};
|
|
@@ -47,7 +48,11 @@ export interface EngineCommandContext {
|
|
|
47
48
|
* 検出をJSONで返すengineか
|
|
48
49
|
*/
|
|
49
50
|
export function isFindingEngine(name: EngineName): boolean {
|
|
50
|
-
return
|
|
51
|
+
return (
|
|
52
|
+
name === "comment-check" ||
|
|
53
|
+
name === "document-style-check" ||
|
|
54
|
+
name === "tsdoc-check"
|
|
55
|
+
);
|
|
51
56
|
}
|
|
52
57
|
|
|
53
58
|
/**
|
|
@@ -112,6 +117,16 @@ export function buildEngineCommand(
|
|
|
112
117
|
...extra,
|
|
113
118
|
];
|
|
114
119
|
}
|
|
120
|
+
if (name === "document-style-check") {
|
|
121
|
+
return [
|
|
122
|
+
executable,
|
|
123
|
+
"lint",
|
|
124
|
+
"--json",
|
|
125
|
+
...context.targets,
|
|
126
|
+
...ignoreArguments,
|
|
127
|
+
...extra,
|
|
128
|
+
];
|
|
129
|
+
}
|
|
115
130
|
return [
|
|
116
131
|
executable,
|
|
117
132
|
"--json",
|