@tyyyho/treg 0.1.22 → 0.1.26

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.
Files changed (4) hide show
  1. package/README.md +127 -42
  2. package/README.npm.md +127 -42
  3. package/README.zh-hant.md +169 -48
  4. package/package.json +2 -2
package/README.md CHANGED
@@ -1,69 +1,154 @@
1
1
  # @tyyyho/treg
2
2
 
3
- `treg` applies tooling standards to existing repositories.
3
+ [![npm
4
+ version](https://img.shields.io/npm/v/%40tyyyho%2Ftreg)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
5
+ [![npm
6
+ downloads](https://img.shields.io/npm/dm/%40tyyyho%2Ftreg)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
7
+ [![License](https://img.shields.io/npm/l/%40tyyyho%2Ftreg)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
8
+ ![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?logo=typescript&logoColor=white)
4
9
 
5
- Scope:
10
+ [繁體中文 README](./README.zh-hant.md)
6
11
 
7
- - lint
8
- - format
9
- - TypeScript
10
- - test
11
- - husky
12
- - AI skill guidance
12
+ ## Overview
13
13
 
14
- Quick start:
14
+ **treg** is a CLI tool that injects an **engineering
15
+ "immune system"** into your project.
16
+
17
+ When humans and AI collaborate and iterate rapidly, repositories often
18
+ accumulate inconsistent tooling, style drift, and fragile workflows.\
19
+ `treg` helps maintain balance by establishing a clean and consistent
20
+ development baseline.
21
+
22
+ It focuses only on **infrastructure setup**, not application logic.
23
+
24
+ ---
25
+
26
+ ## Features
27
+
28
+ `treg` can configure:
29
+
30
+ - **TypeScript**
31
+ - **ESLint**
32
+ - **Prettier / Oxfmt**
33
+ - **Jest / Vitest**
34
+ - **Husky git hooks**
35
+ - **AI skill guidance**
36
+
37
+ These guardrails help maintain long‑term code health during fast
38
+ iteration.
39
+
40
+ ---
41
+
42
+ ## Quick Start
43
+
44
+ Initialize a project interactively:
15
45
 
16
46
  ```bash
17
47
  npx @tyyyho/treg init
18
48
  ```
19
49
 
20
- Commands:
50
+ Preview changes:
21
51
 
22
- - `init`
23
- - `add`
24
- - `list`
52
+ ```bash
53
+ npx @tyyyho/treg init --dry-run
54
+ ```
25
55
 
26
- `init` interactive questions:
56
+ ---
27
57
 
28
- 1. package manager (`pnpm|npm|yarn|bun`)
29
- 2. features (default: `all`)
30
- 3. test runner (if `test` is selected, supports `skip`)
31
- 4. formatter (if `format` is selected)
32
- 5. ai tools (`Claude|Codex|Gemini`, multi-select, if AI skill guidance is selected)
58
+ ## Commands
33
59
 
34
- `add` examples:
60
+ Command Description
61
+
62
+ ---
63
+
64
+ `init` Initialize project with interactive setup
65
+ `add` Add selected features
66
+ `list` Show supported frameworks and tools
67
+
68
+ ---
69
+
70
+ ## Common Usage
71
+
72
+ Add lint and format:
35
73
 
36
74
  ```bash
37
75
  npx @tyyyho/treg add --features lint,format
76
+ ```
77
+
78
+ Add format with `oxfmt`:
79
+
80
+ ```bash
38
81
  npx @tyyyho/treg add --features format --formatter oxfmt
82
+ ```
83
+
84
+ Add test with `vitest`:
85
+
86
+ ```bash
39
87
  npx @tyyyho/treg add --features test --test-runner vitest
40
88
  ```
41
89
 
42
- Options:
90
+ ---
43
91
 
44
- `init`:
92
+ ## Defaults
45
93
 
46
- ```text
47
- --dry-run
48
- --help
49
- ```
94
+ Framework detection order:
95
+
96
+ nuxt -> next -> react -> vue -> svelte -> node
97
+
98
+ Default test runner:
99
+
100
+ - `vue` / `nuxt`: `vitest`
101
+ - others: `jest`
102
+
103
+ Default formatter:
104
+
105
+ prettier
106
+
107
+ ---
108
+
109
+ ## AI Skills
110
+
111
+ `treg` can update AI guidance files for development tools.
112
+
113
+ Tool File
50
114
 
51
- `add`:
52
-
53
- ```text
54
- --framework <node|react|next|vue|svelte|nuxt>
55
- --features <lint,format,typescript,test,husky>
56
- --dir <path>
57
- --formatter <prettier|oxfmt>
58
- --test-runner <jest|vitest>
59
- --force
60
- --dry-run
61
- --skip-husky-install
62
- --help
115
+ ---
116
+
117
+ Claude `CLAUDE.md`
118
+ Codex `AGENTS.md`
119
+ Gemini `GEMINI.md`
120
+
121
+ Behavior:
122
+
123
+ - only selected tools are updated
124
+ - missing files are created automatically
125
+ - updates occur in the repository root
126
+
127
+ ---
128
+
129
+ ## Philosophy
130
+
131
+ `treg` is intentionally minimal.
132
+
133
+ It does not generate application architecture.\
134
+ It focuses only on establishing the engineering infrastructure that
135
+ keeps repositories healthy during rapid development.
136
+
137
+ ---
138
+
139
+ ## Release
140
+
141
+ ```bash
142
+ npm run release -- patch
63
143
  ```
64
144
 
65
- Defaults:
145
+ Supported targets:
66
146
 
67
- - framework detect order: `nuxt -> next -> react -> vue -> svelte -> node`
68
- - test runner: `vue/nuxt = vitest`, others = `jest`
69
- - formatter: `prettier`
147
+ patch
148
+ minor
149
+ major
150
+ prepatch
151
+ preminor
152
+ premajor
153
+ prerelease
154
+ x.y.z
package/README.npm.md CHANGED
@@ -1,69 +1,154 @@
1
1
  # @tyyyho/treg
2
2
 
3
- `treg` applies tooling standards to existing repositories.
3
+ [![npm
4
+ version](https://img.shields.io/npm/v/%40tyyyho%2Ftreg)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
5
+ [![npm
6
+ downloads](https://img.shields.io/npm/dm/%40tyyyho%2Ftreg)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
7
+ [![License](https://img.shields.io/npm/l/%40tyyyho%2Ftreg)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
8
+ ![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?logo=typescript&logoColor=white)
4
9
 
5
- Scope:
10
+ [繁體中文 README](./README.zh-hant.md)
6
11
 
7
- - lint
8
- - format
9
- - TypeScript
10
- - test
11
- - husky
12
- - AI skill guidance
12
+ ## Overview
13
13
 
14
- Quick start:
14
+ **treg** is a CLI tool that injects an **engineering
15
+ "immune system"** into your project.
16
+
17
+ When humans and AI collaborate and iterate rapidly, repositories often
18
+ accumulate inconsistent tooling, style drift, and fragile workflows.\
19
+ `treg` helps maintain balance by establishing a clean and consistent
20
+ development baseline.
21
+
22
+ It focuses only on **infrastructure setup**, not application logic.
23
+
24
+ ---
25
+
26
+ ## Features
27
+
28
+ `treg` can configure:
29
+
30
+ - **TypeScript**
31
+ - **ESLint**
32
+ - **Prettier / Oxfmt**
33
+ - **Jest / Vitest**
34
+ - **Husky git hooks**
35
+ - **AI skill guidance**
36
+
37
+ These guardrails help maintain long‑term code health during fast
38
+ iteration.
39
+
40
+ ---
41
+
42
+ ## Quick Start
43
+
44
+ Initialize a project interactively:
15
45
 
16
46
  ```bash
17
47
  npx @tyyyho/treg init
18
48
  ```
19
49
 
20
- Commands:
50
+ Preview changes:
21
51
 
22
- - `init`
23
- - `add`
24
- - `list`
52
+ ```bash
53
+ npx @tyyyho/treg init --dry-run
54
+ ```
25
55
 
26
- `init` interactive questions:
56
+ ---
27
57
 
28
- 1. package manager (`pnpm|npm|yarn|bun`)
29
- 2. features (default: `all`)
30
- 3. test runner (if `test` is selected, supports `skip`)
31
- 4. formatter (if `format` is selected)
32
- 5. ai tools (`Claude|Codex|Gemini`, multi-select, if AI skill guidance is selected)
58
+ ## Commands
33
59
 
34
- `add` examples:
60
+ Command Description
61
+
62
+ ---
63
+
64
+ `init` Initialize project with interactive setup
65
+ `add` Add selected features
66
+ `list` Show supported frameworks and tools
67
+
68
+ ---
69
+
70
+ ## Common Usage
71
+
72
+ Add lint and format:
35
73
 
36
74
  ```bash
37
75
  npx @tyyyho/treg add --features lint,format
76
+ ```
77
+
78
+ Add format with `oxfmt`:
79
+
80
+ ```bash
38
81
  npx @tyyyho/treg add --features format --formatter oxfmt
82
+ ```
83
+
84
+ Add test with `vitest`:
85
+
86
+ ```bash
39
87
  npx @tyyyho/treg add --features test --test-runner vitest
40
88
  ```
41
89
 
42
- Options:
90
+ ---
43
91
 
44
- `init`:
92
+ ## Defaults
45
93
 
46
- ```text
47
- --dry-run
48
- --help
49
- ```
94
+ Framework detection order:
95
+
96
+ nuxt -> next -> react -> vue -> svelte -> node
97
+
98
+ Default test runner:
99
+
100
+ - `vue` / `nuxt`: `vitest`
101
+ - others: `jest`
102
+
103
+ Default formatter:
104
+
105
+ prettier
106
+
107
+ ---
108
+
109
+ ## AI Skills
110
+
111
+ `treg` can update AI guidance files for development tools.
112
+
113
+ Tool File
50
114
 
51
- `add`:
52
-
53
- ```text
54
- --framework <node|react|next|vue|svelte|nuxt>
55
- --features <lint,format,typescript,test,husky>
56
- --dir <path>
57
- --formatter <prettier|oxfmt>
58
- --test-runner <jest|vitest>
59
- --force
60
- --dry-run
61
- --skip-husky-install
62
- --help
115
+ ---
116
+
117
+ Claude `CLAUDE.md`
118
+ Codex `AGENTS.md`
119
+ Gemini `GEMINI.md`
120
+
121
+ Behavior:
122
+
123
+ - only selected tools are updated
124
+ - missing files are created automatically
125
+ - updates occur in the repository root
126
+
127
+ ---
128
+
129
+ ## Philosophy
130
+
131
+ `treg` is intentionally minimal.
132
+
133
+ It does not generate application architecture.\
134
+ It focuses only on establishing the engineering infrastructure that
135
+ keeps repositories healthy during rapid development.
136
+
137
+ ---
138
+
139
+ ## Release
140
+
141
+ ```bash
142
+ npm run release -- patch
63
143
  ```
64
144
 
65
- Defaults:
145
+ Supported targets:
66
146
 
67
- - framework detect order: `nuxt -> next -> react -> vue -> svelte -> node`
68
- - test runner: `vue/nuxt = vitest`, others = `jest`
69
- - formatter: `prettier`
147
+ patch
148
+ minor
149
+ major
150
+ prepatch
151
+ preminor
152
+ premajor
153
+ prerelease
154
+ x.y.z
package/README.zh-hant.md CHANGED
@@ -1,51 +1,131 @@
1
+ <div align="center">
2
+
3
+ <img src="https://capsule-render.vercel.app/api?type=waving&color=0:0F172A,30:1D4ED8,70:7C3AED,100:22C55E&height=260&section=header&text=treg&fontSize=72&fontColor=ffffff&animation=fadeIn&fontAlignY=38&desc=Inject%20an%20immune%20system%20into%20your%20codebase&descSize=20&descAlignY=58" width="100%" />
4
+
1
5
  # @tyyyho/treg（繁體中文）
2
6
 
7
+ [![npm version](https://img.shields.io/npm/v/%40tyyyho%2Ftreg?style=for-the-badge)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
8
+ [![License](https://img.shields.io/npm/l/%40tyyyho%2Ftreg?style=for-the-badge)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
9
+ [![npm downloads](https://img.shields.io/npm/dm/%40tyyyho%2Ftreg?style=for-the-badge)](https://www.npmjs.com/package/%40tyyyho%2Ftreg)
10
+ ![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?style=for-the-badge&logo=typescript&logoColor=white)
11
+ ![CLI](https://img.shields.io/badge/CLI-Interactive-111827?style=for-the-badge&logo=gnubash&logoColor=white)
12
+
3
13
  [English README](./README.md)
4
14
 
5
- `treg` 是一個用於既有專案的 CLI，可快速套用一致的工具鏈規範。
6
- 它只處理基礎設施設定：
15
+ </div>
16
+
17
+ ---
18
+
19
+ ## 概覽
20
+
21
+ **treg**
22
+
23
+ 它是一個為專案注入「免疫系統」的 CLI 工具。
24
+ 當開發者與 AI 高速協作時，程式碼庫很容易出現規範不一致、規則重複、流程脆弱等問題。
25
+ `treg` 的角色就像調節型 T 細胞：協助恢復平衡、抑制可避免的混亂，讓專案維持 **乾淨、可維護、可擴展**。
26
+
27
+ `treg` 不產生產品商業邏輯，而是專注於建立可長期保持穩定的工程基線。
28
+
29
+ > **先規範開發流程，才不會被流程反過來牽制。**
30
+
31
+ ---
32
+
33
+ ## 為什麼需要 treg
34
+
35
+ 在 AI 輔助開發時代，專案速度可以很快。
36
+ 但速度若缺少約束，通常會留下看不見的技術債：
37
+
38
+ - 風格漂移
39
+ - 工具鏈不一致
40
+ - commit 衛生不足
41
+ - 測試覆蓋缺漏
42
+ - AI 使用規則不清
43
+
44
+ `treg` 透過一次初始化流程，把一致的工程基線套用到既有 repository。
7
45
 
8
- - lint
9
- - format
10
- - TypeScript
11
- - test
12
- - husky
13
- - AI skill 指引
46
+ ---
47
+
48
+ ## treg 會建立什麼
49
+
50
+ `treg` 可配置：
51
+
52
+ - **TypeScript**
53
+ - **Linting**（ESLint）
54
+ - **Formatting**（Prettier 或 Oxfmt）
55
+ - **Testing**（Jest 或 Vitest）
56
+ - **Git hooks**（Husky）
57
+ - **AI skill guidance**（支援的 AI 工具說明）
58
+
59
+ 這能穩定專案品質，同時不強制你採用特定產品架構。
60
+
61
+ ---
14
62
 
15
63
  ## 快速開始
16
64
 
65
+ 互動式初始化：
66
+
17
67
  ```bash
18
68
  npx @tyyyho/treg init
19
69
  ```
20
70
 
21
- ## 指令總覽
71
+ 只預覽變更：
72
+
73
+ ```bash
74
+ npx @tyyyho/treg init --dry-run
75
+ ```
76
+
77
+ 為既有專案補上指定功能：
78
+
79
+ ```bash
80
+ npx @tyyyho/treg add --features lint,format
81
+ ```
82
+
83
+ ---
84
+
85
+ ## 指令
86
+
87
+ | Command | 說明 |
88
+ | ------- | ----------------------------------------------------- |
89
+ | `init` | 以互動流程初始化專案基線 |
90
+ | `add` | 為既有專案加入指定功能 |
91
+ | `list` | 列出支援的 framework、feature、formatter、test runner |
92
+
93
+ ---
94
+
95
+ ## init 互動流程
22
96
 
23
- - `init`：初始化功能。
24
- - `add`：只為既有專案加入指定功能。
25
- - `list`：列出支援的 framework/feature/formatter/test runner。
97
+ 執行 `init` 時，`treg` 會依序詢問：
26
98
 
27
- ## Init 互動流程
99
+ 1. **Package manager**
100
+ `pnpm | npm | yarn | bun`
28
101
 
29
- 執行 `init` 後，`treg` 會依序詢問：
102
+ 2. **Features**（可複選，預設全選）
103
+ - lint
104
+ - format
105
+ - TypeScript
106
+ - test
107
+ - husky
108
+ - AI skill guidance
30
109
 
31
- 1. 套件管理器（`pnpm|npm|yarn|bun`）
32
- 2. 要加入的功能（可複選，預設全勾）
33
- 3. 測試工具（僅在選到 `test` 時詢問，支援 `skip`）
34
- 4. Formatter（僅在選到 `format` 時詢問）
35
- 5. AI 工具（`Claude|Codex|Gemini` 可複選，僅在選到 AI skill guidance 時詢問）
110
+ 3. **Test runner**（僅在選到 `test` 時詢問）
111
+ - `jest`
112
+ - `vitest`
113
+ - `skip`
36
114
 
37
- 預設勾選功能：
115
+ 4. **Formatter**（僅在選到 `format` 時詢問）
116
+ - `prettier`
117
+ - `oxfmt`
38
118
 
39
- - lint
40
- - format
41
- - TypeScript
42
- - test
43
- - husky
44
- - AI skill guidance
119
+ 5. **AI tools**（僅在選到 AI skill guidance 時詢問）
120
+ - Claude
121
+ - Codex
122
+ - Gemini
123
+
124
+ ---
45
125
 
46
126
  ## 常見用法
47
127
 
48
- 初始化：
128
+ 初始化專案：
49
129
 
50
130
  ```bash
51
131
  npx @tyyyho/treg init
@@ -75,16 +155,18 @@ test 使用 `vitest`：
75
155
  npx @tyyyho/treg add --features test --test-runner vitest
76
156
  ```
77
157
 
158
+ ---
159
+
78
160
  ## CLI 參數
79
161
 
80
- `init` 可用參數：
162
+ ### `init`
81
163
 
82
164
  ```text
83
165
  --dry-run
84
166
  --help
85
167
  ```
86
168
 
87
- `add` 可用參數：
169
+ ### `add`
88
170
 
89
171
  ```text
90
172
  --framework <node|react|next|vue|svelte|nuxt>
@@ -98,30 +180,59 @@ npx @tyyyho/treg add --features test --test-runner vitest
98
180
  --help
99
181
  ```
100
182
 
183
+ ---
184
+
101
185
  ## 預設行為
102
186
 
103
- framework 偵測順序：
187
+ ### Framework 偵測
104
188
 
105
- `nuxt -> next -> react -> vue -> svelte -> node`
189
+ 偵測順序：
106
190
 
107
- 測試工具預設：
191
+ ```text
192
+ nuxt -> next -> react -> vue -> svelte -> node
193
+ ```
194
+
195
+ ### Test Runner
108
196
 
109
197
  - `vue` / `nuxt`：`vitest`
110
198
  - 其他：`jest`
111
199
 
112
- formatter 預設：
200
+ ### Formatter
113
201
 
114
202
  - `prettier`
115
203
 
204
+ ---
205
+
116
206
  ## AI Skills 行為
117
207
 
118
- - 只會更新選擇的 AI 工具對應檔案：
119
- - `Claude -> CLAUDE.md`
120
- - `Codex -> AGENTS.md`
121
- - `Gemini -> GEMINI.md`
122
- - 若檔案已存在會直接更新。
123
- - 選擇的 AI 工具對應檔案不存在時，會先自動建立再注入說明。
124
- - 每個啟用功能的 skill 檔只會建立一次。
208
+ `treg` 可更新所選 AI 工具的說明文件：
209
+
210
+ | Tool | File |
211
+ | ------ | ----------- |
212
+ | Claude | `CLAUDE.md` |
213
+ | Codex | `AGENTS.md` |
214
+ | Gemini | `GEMINI.md` |
215
+
216
+ 行為規則：
217
+
218
+ - 只更新你選擇的工具
219
+ - 缺少的對應文件會自動建立
220
+ - 更新發生在 repository root
221
+ - 每個啟用 feature 的 skill 檔只會生成一次
222
+
223
+ ---
224
+
225
+ ## 核心理念
226
+
227
+ `treg` 的設計刻意保持單一職責。
228
+
229
+ 它 **不** 是完整專案產生器。
230
+ 它 **不** 取代團隊判斷。
231
+ 它 **不** 強制產品架構。
232
+
233
+ 它的目標是建立工程免疫層，避免快速迭代持續侵蝕程式碼品質。
234
+
235
+ ---
125
236
 
126
237
  ## 發布
127
238
 
@@ -131,11 +242,21 @@ npm run release -- patch
131
242
 
132
243
  支援目標：
133
244
 
134
- - `patch`
135
- - `minor`
136
- - `major`
137
- - `prepatch`
138
- - `preminor`
139
- - `premajor`
140
- - `prerelease`
141
- - 指定版本（`x.y.z`）
245
+ ```text
246
+ patch
247
+ minor
248
+ major
249
+ prepatch
250
+ preminor
251
+ premajor
252
+ prerelease
253
+ x.y.z
254
+ ```
255
+
256
+ ---
257
+
258
+ <div align="center">
259
+ <sub>Built to regulate chaotic iteration and protect long-term codebase health.</sub>
260
+ <br />
261
+ <img src="https://capsule-render.vercel.app/api?type=waving&color=0:22C55E,40:06B6D4,75:3B82F6,100:7C3AED&height=120&section=footer" width="100%" />
262
+ </div>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tyyyho/treg",
3
- "version": "0.1.22",
4
- "description": "CLI tool for initializing development conventions in existing projects.",
3
+ "version": "0.1.26",
4
+ "description": "Treg is a CLI tool that injects an engineering \"immune system\" into existing projects.",
5
5
  "license": "MIT",
6
6
  "repository": {
7
7
  "type": "git",