@tzwzx/codesweep 1.2.1 → 1.2.2
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 +165 -0
- package/README.md +2 -0
- package/package.json +5 -5
package/README.ja.md
ADDED
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
# codesweep
|
|
2
|
+
|
|
3
|
+
[English](https://github.com/tzwzx/codesweep/blob/main/README.md) | 日本語
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@tzwzx/codesweep) [](./LICENSE)
|
|
6
|
+
|
|
7
|
+
lint、format、typecheck、test をはじめとするコード品質チェックのコマンドをまとめて実行します。プロジェクトごとの設定は YAML ファイルで行います。
|
|
8
|
+
|
|
9
|
+
## なぜ codesweep なのか
|
|
10
|
+
|
|
11
|
+
[concurrently](https://www.npmjs.com/package/concurrently) や [npm-run-all2](https://www.npmjs.com/package/npm-run-all2) といったタスクランナーはコマンドの並列実行を得意としていますが、「まず自動修正をかけ、そのあとすべてを並列で検証する」といった多段構成のパイプラインは、`package.json` の中で読みづらいワンライナーになりがちです。codesweep なら、パイプライン全体を 1 つの YAML ファイルで宣言し、逐次ステージと並列ステージを自由に組み合わせて、単一のコマンドで実行できます。
|
|
12
|
+
|
|
13
|
+
「品質チェックをまとめて一気に走らせたい」場面のために作られています。AI コーディングエージェントによるタスク後のチェック、コミット前フック、CI などです。ステージ内のコマンドはフェイルスルーします。1 つ失敗しても他のチェックは打ち切られないため、1 回の実行ですべてのエラーを確認できます。
|
|
14
|
+
|
|
15
|
+
まとめると、ビルドキャッシュや依存関係グラフが必要なら [wireit](https://www.npmjs.com/package/wireit) を、数個のコマンドを並列に実行したいだけなら `concurrently` 単体で十分です。宣言的で多段構成の品質チェックパイプラインが欲しいなら、codesweep が向いています。
|
|
16
|
+
|
|
17
|
+
## 動作要件
|
|
18
|
+
|
|
19
|
+
- Node.js >= 22(または Bun >= 1)
|
|
20
|
+
|
|
21
|
+
## インストール
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# npm
|
|
25
|
+
npm install @tzwzx/codesweep
|
|
26
|
+
|
|
27
|
+
# bun
|
|
28
|
+
bun add @tzwzx/codesweep
|
|
29
|
+
|
|
30
|
+
# pnpm
|
|
31
|
+
pnpm add @tzwzx/codesweep
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
インストール後は、`npx @tzwzx/codesweep`、`bunx @tzwzx/codesweep`、`./node_modules/.bin/codesweep` のいずれかで `codesweep` バイナリを実行できます。
|
|
35
|
+
|
|
36
|
+
## CLI の使い方
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
codesweep <command> [options]
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
- **`init`** — カレントディレクトリに `codesweep.yml` のひな形を作成します。サブコマンドとして予約されています(後述の注記を参照)。
|
|
43
|
+
- **mode** — `codesweep.yml` で定義した任意のモード(例: `check` や `fix`)。
|
|
44
|
+
- **`--config` / `-c <path>`** — 設定ファイルのパス(デフォルト: `./codesweep.yml`)。
|
|
45
|
+
- **`--quiet` / `-q`** — 失敗したものだけを表示します。[Quiet mode](#quiet-mode) を参照してください。
|
|
46
|
+
- **`--help` / `-h`** — ヘルプを表示します。
|
|
47
|
+
|
|
48
|
+
例:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
codesweep init
|
|
52
|
+
codesweep check
|
|
53
|
+
codesweep fix
|
|
54
|
+
codesweep check --config ./packages/app/codesweep.yml
|
|
55
|
+
codesweep check --quiet
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
終了コードは、成功時が `0`、失敗時が `1` です。実行が終わると経過時間が表示されます。
|
|
59
|
+
|
|
60
|
+
## Quiet mode
|
|
61
|
+
|
|
62
|
+
`--quiet` は各コマンドの出力をバッファリングし、失敗したものだけを表示します。すべて成功した実行では**出力が一切ありません**。結果は終了コードが伝えます。
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
codesweep check # every tool's progress, summaries and exit lines
|
|
66
|
+
codesweep check --quiet # (nothing)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
これは CI を想定した機能です。ビルドがグリーンなのに、次に読む人が数千行の「問題は見つかりませんでした」に埋もれてしまう、という事態を避けられます。また、出力の多いアナライザーも成功している間はコストがかからないため、ログを溢れさせることなくパイプラインに入れたままにできます。
|
|
70
|
+
|
|
71
|
+
実際に失敗した場合は、失敗したコマンドごとに出力の全文が表示されます。
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
❌ Command failed: npm run typecheck
|
|
75
|
+
src/app.ts(12,7): error TS2322: Type 'string' is not assignable to type 'number'.
|
|
76
|
+
|
|
77
|
+
❌ codesweep check failed (8.21s)
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
すべてのコマンドは最後まで実行されるため、1 回の実行ですべてのエラーが一度に明らかになります。quiet モードが変えるのは表示される内容だけで、実行される内容は変わりません。
|
|
81
|
+
|
|
82
|
+
CI 専用のモードと組み合わせると便利です。
|
|
83
|
+
|
|
84
|
+
```yaml
|
|
85
|
+
check:
|
|
86
|
+
- parallel:
|
|
87
|
+
- npm run lint
|
|
88
|
+
- npm run typecheck
|
|
89
|
+
|
|
90
|
+
check-ci:
|
|
91
|
+
- parallel:
|
|
92
|
+
- npm run lint
|
|
93
|
+
- npm run typecheck
|
|
94
|
+
- npm run test
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
codesweep check-ci --quiet
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## ライブラリとしての使い方
|
|
102
|
+
|
|
103
|
+
codesweep はプログラムから呼び出すこともできます。`import { codesweep } from "@tzwzx/codesweep"` として `await codesweep("check")` を実行します(第 2 引数に設定ファイルのパス、第 3 引数に `{ quiet: true }` を渡すこともできます)。
|
|
104
|
+
|
|
105
|
+
## 設定ファイル: `codesweep.yml`
|
|
106
|
+
|
|
107
|
+
`init` を実行すると、カレントディレクトリに `codesweep.yml` のひな形が生成されます(同名のファイルが既に存在する場合は失敗します)。事前にインストールしていなくても実行できます。
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
npx @tzwzx/codesweep init
|
|
111
|
+
|
|
112
|
+
# or with bun
|
|
113
|
+
bunx @tzwzx/codesweep init
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
生成される内容は次のとおりです。
|
|
117
|
+
|
|
118
|
+
```yaml
|
|
119
|
+
# codesweep configuration
|
|
120
|
+
# https://github.com/tzwzx/codesweep
|
|
121
|
+
|
|
122
|
+
check:
|
|
123
|
+
- parallel: # Stage 1: run checks in parallel
|
|
124
|
+
- npm run lint
|
|
125
|
+
- npm run typecheck
|
|
126
|
+
- npm test
|
|
127
|
+
|
|
128
|
+
fix:
|
|
129
|
+
- sequential: # Stage 1: apply auto-fixes
|
|
130
|
+
- npm run fix
|
|
131
|
+
- parallel: # Stage 2: verify after fixing
|
|
132
|
+
- npm run typecheck
|
|
133
|
+
- npm test
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
**モード**を 1 つ以上定義します。各モードは**ステージ**の順序付きリストです。各ステージは `parallel` か `sequential` のいずれかで、空でないシェルコマンド文字列の配列を持ちます。モード名は自由に付けられますが、`"init"` はサブコマンドとして予約されているため、モード名には使えません。
|
|
137
|
+
|
|
138
|
+
### 動作
|
|
139
|
+
|
|
140
|
+
- **ステージ**は 1 つずつ順番に実行されます(ステージ 2 はステージ 1 が終わってから始まります)。
|
|
141
|
+
- **ステージ内**では、`parallel` はコマンドを同時に実行し、`sequential` は順番に実行します。
|
|
142
|
+
- **フェイルスルー**: ステージ内の 1 つのコマンドが失敗しても、そのステージの他のコマンドは実行されます。その後、ステージ全体が失敗として扱われます。
|
|
143
|
+
|
|
144
|
+
### バリデーションルール
|
|
145
|
+
|
|
146
|
+
- 設定は空でないオブジェクトでなければなりません。
|
|
147
|
+
- 各モードの値はステージの配列でなければなりません。
|
|
148
|
+
- 各ステージは `parallel` と `sequential` のどちらか一方だけを持たなければなりません(両方は不可)。
|
|
149
|
+
- コマンドリストは、空でない文字列からなる空でない配列でなければなりません。
|
|
150
|
+
|
|
151
|
+
## 開発
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
bun install
|
|
155
|
+
bun run build # outputs to dist/
|
|
156
|
+
bun run dev # tsc --watch
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## 変更履歴
|
|
160
|
+
|
|
161
|
+
[CHANGELOG.md](CHANGELOG.md) を参照してください。
|
|
162
|
+
|
|
163
|
+
## ライセンス
|
|
164
|
+
|
|
165
|
+
MIT — [LICENSE](LICENSE) を参照してください。
|
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# codesweep
|
|
2
2
|
|
|
3
|
+
English | [日本語](https://github.com/tzwzx/codesweep/blob/main/README.ja.md)
|
|
4
|
+
|
|
3
5
|
[](https://www.npmjs.com/package/@tzwzx/codesweep) [](./LICENSE)
|
|
4
6
|
|
|
5
7
|
Run lint, format, typecheck, test, and other code quality commands in one go. Configure each project with a YAML file.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tzwzx/codesweep",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.2",
|
|
4
4
|
"description": "Run code quality checks in one command 🧹",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"cli",
|
|
@@ -59,12 +59,12 @@
|
|
|
59
59
|
"yaml": "2.9.0"
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
62
|
-
"@types/node": "26.1.
|
|
62
|
+
"@types/node": "26.1.2",
|
|
63
63
|
"bun-types": "1.3.14",
|
|
64
|
-
"fallow": "3.
|
|
64
|
+
"fallow": "3.10.0",
|
|
65
65
|
"lefthook": "2.1.10",
|
|
66
|
-
"oxfmt": "0.
|
|
67
|
-
"oxlint": "1.
|
|
66
|
+
"oxfmt": "0.61.0",
|
|
67
|
+
"oxlint": "1.76.0",
|
|
68
68
|
"syncpack": "15.3.2",
|
|
69
69
|
"typescript": "7.0.2",
|
|
70
70
|
"ultracite": "7.9.4"
|