@tyyyho/treg 0.1.14 → 0.1.16

package/README.md

@@ -1,9 +1,15 @@
 # @tyyyho/treg
 
-[繁體中文 README](./README.zh-hant.md)
+`treg` is a CLI for applying tooling standards in existing repositories.
 
-`treg` is a CLI for quickly setting up project tooling conventions in an existing repository.
-It applies infra setup such as lint, format, TypeScript, test, husky, and AI skill guidance.
+It sets up infrastructure only:
+
+- lint
+- format
+- TypeScript
+- test
+- husky
+- AI skill guidance
 
 ## Quick Start
 
@@ -11,112 +17,65 @@ It applies infra setup such as lint, format, TypeScript, test, husky, and AI ski
 npx @tyyyho/treg init
 ```
 
-```bash
-pnpm dlx @tyyyho/treg init
-```
-
-`init` auto-detects framework from dependencies.
-
 ## Commands
 
-```bash
-npx @tyyyho/treg <command> [options]
-```
-
-- `init`: Initialize infra rules (framework auto-detected from dependencies)
-- `add`: Add selected infra features to an existing project
-- `list`: List supported frameworks, features, formatters, and test runners
-
-## Options
-
-- `--framework <node|react|next|vue|svelte|nuxt>`: Optional framework override
-- `--features <lint,format,typescript,test,husky>`: Features to install (defaults to all)
-- `--no-format`: Skip format feature setup and avoid changing format configs/scripts
-- `--no-test-runner`: Skip test feature setup and avoid changing test runner/config
-- `--dir <path>`: Target directory (defaults to current directory)
-- `--formatter <prettier|oxfmt>`: Formatter for format feature (default: `prettier`)
-- `--test-runner <jest|vitest>`: Optional test runner override when test feature is enabled
-- `--pm <pnpm|npm|yarn|auto>`: Package manager (auto-detected by default)
-- `--force`: Overwrite existing config files
-- `--dry-run`: Print full plan without writing files
-- `--skip-husky-install`: Skip husky install command
-- `--skills`: Update existing `CLAUDE.md`/`AGENTS.md`/`GEMINI.md` with skill guidance (enabled by default)
-- `--no-skills`: Disable skill guidance updates
-- `--help`: Show help
-
-## Features
-
-Default feature set:
-
-- `husky`
-- `typescript`
-- `lint`
-- `format`
-- `test`
+- `init`
+- `add`
+- `list`
 
-## Examples
+## Common Examples
 
-Initialize with auto-detected framework:
+Initialize with auto-detection:
 
 ```bash
 npx @tyyyho/treg init
 ```
 
-Initialize with explicit framework override:
+Initialize with explicit framework:
 
 ```bash
 npx @tyyyho/treg init --framework react
 ```
 
-Add only lint + format:
+Apply selected features:
 
 ```bash
 npx @tyyyho/treg add --features lint,format
 ```
 
-Use oxfmt instead of prettier:
+Use `oxfmt`:
 
 ```bash
 npx @tyyyho/treg add --features format --formatter oxfmt
 ```
 
-Skip format/test setup to keep existing project rules untouched:
+Skip format and test setup:
 
 ```bash
 npx @tyyyho/treg add --no-format --no-test-runner
 ```
 
-Use Vitest for test feature:
+Preview only:
 
 ```bash
-npx @tyyyho/treg init --framework node --features test --test-runner vitest
+npx @tyyyho/treg init --dry-run
 ```
 
-Preview changes only:
-
-```bash
-npx @tyyyho/treg init --framework react --dry-run
-```
-
-Update AI skill guidance:
-
-```bash
-npx @tyyyho/treg add --features lint,format,husky
+## Key Options
+
+```text
+--framework <node|react|next|vue|svelte|nuxt>
+--features <lint,format,typescript,test,husky>
+--no-format
+--no-test-runner
+--formatter <prettier|oxfmt>
+--test-runner <jest|vitest>
+--pm <pnpm|npm|yarn|auto>
+--dir <path>
+--force
+--dry-run
+--skip-husky-install
+--skills
+--no-skills
+--help
 ```
-
-Target a different directory explicitly:
-
-```bash
-npx @tyyyho/treg init --framework react --dir ./packages/web
-```
-
-## Notes
-
-- `init` auto-detects framework from repo dependencies.
-- Detection order is `nuxt -> next -> react -> vue -> svelte -> node`.
-- Default test runner is `vitest` for `vue`/`nuxt`, and `jest` for other frameworks.
-- Default formatter is `prettier` (`--formatter oxfmt` to override).
-- `--no-format` and `--no-test-runner` let you skip format/test setup to avoid overriding existing project config.
-- `add` lets you install only the features you specify.
-- Framework setup uses one stable config per framework (no `--framework-version` variants).
-- `--dry-run` prints the full plan and does not write files.

package/README.npm.md

@@ -0,0 +1,81 @@
+# @tyyyho/treg
+
+`treg` is a CLI for applying tooling standards in existing repositories.
+
+It sets up infrastructure only:
+
+- lint
+- format
+- TypeScript
+- test
+- husky
+- AI skill guidance
+
+## Quick Start
+
+```bash
+npx @tyyyho/treg init
+```
+
+## Commands
+
+- `init`
+- `add`
+- `list`
+
+## Common Examples
+
+Initialize with auto-detection:
+
+```bash
+npx @tyyyho/treg init
+```
+
+Initialize with explicit framework:
+
+```bash
+npx @tyyyho/treg init --framework react
+```
+
+Apply selected features:
+
+```bash
+npx @tyyyho/treg add --features lint,format
+```
+
+Use `oxfmt`:
+
+```bash
+npx @tyyyho/treg add --features format --formatter oxfmt
+```
+
+Skip format and test setup:
+
+```bash
+npx @tyyyho/treg add --no-format --no-test-runner
+```
+
+Preview only:
+
+```bash
+npx @tyyyho/treg init --dry-run
+```
+
+## Key Options
+
+```text
+--framework <node|react|next|vue|svelte|nuxt>
+--features <lint,format,typescript,test,husky>
+--no-format
+--no-test-runner
+--formatter <prettier|oxfmt>
+--test-runner <jest|vitest>
+--pm <pnpm|npm|yarn|auto>
+--dir <path>
+--force
+--dry-run
+--skip-husky-install
+--skills
+--no-skills
+--help
+```

package/README.zh-hant.md

@@ -2,8 +2,27 @@
 
 [English README](./README.md)
 
-`treg` 是一個用於既有專案的 CLI 工具，可快速建立與套用工具鏈規範。
-預設搭建基礎設定，包含 lint、format、TypeScript、test、husky、skills。
+`treg` 是一個用於既有專案的 CLI，可快速套用一致的工具鏈規範。
+
+它只處理基礎設施設定：
+
+- lint
+- format
+- TypeScript
+- test
+- husky
+- AI skill 指引
+
+## 為什麼用 treg
+
+`treg` 可以在既有 repo 中快速建立一致的開發基線，避免每次手動重接工具。
+
+適合用在：
+
+- 快速補齊專案工具鏈
+- 只套用部分 feature
+- 需要可重跑且不破壞設定（`idempotent`）
+- 先看完整計畫再寫檔（`--dry-run`）
 
 ## 快速開始
 
@@ -15,108 +34,110 @@ npx @tyyyho/treg init
 pnpm dlx @tyyyho/treg init
 ```
 
-`init` 會依照依賴自動偵測 framework。
-
-## 指令
-
-```bash
-npx @tyyyho/treg <command> [options]
-```
-
-- `init`：初始化基礎規範（依賴自動偵測 framework）
-- `add`：在既有專案中新增指定 feature
-- `list`：列出支援的 framework、feature、formatter 與 test runner
-
-## 參數
-
-- `--framework <node|react|next|vue|svelte|nuxt>`：可選，手動覆寫 framework
-- `--features <lint,format,typescript,test,husky>`：指定要安裝的 feature（預設全部）
-- `--no-format`：略過 format feature，避免覆寫既有格式化設定與 scripts
-- `--no-test-runner`：略過 test feature，避免覆寫既有測試 runner 與設定
-- `--dir <path>`：指定目標目錄（預設為目前目錄）
-- `--formatter <prettier|oxfmt>`：format feature 使用的 formatter（預設為 `prettier`）
-- `--test-runner <jest|vitest>`：可選，啟用 test feature 時覆寫測試框架
-- `--pm <pnpm|npm|yarn|auto>`：套件管理器（預設自動偵測）
-- `--force`：覆寫既有設定檔
-- `--dry-run`：輸出完整執行計畫，但不寫入檔案
-- `--skip-husky-install`：略過 `husky install`
-- `--skills`：更新既有 `CLAUDE.md`/`AGENTS.md`/`GEMINI.md` 的 skill 指引（預設啟用）
-- `--no-skills`：停用 skill 指引更新
-- `--help`：顯示說明
-
-## Features
-
-預設 feature 組合：
+## 指令總覽
 
-- `husky`
-- `typescript`
-- `lint`
-- `format`
-- `test`
+- `init`：依賴自動偵測 framework 並套用基礎規範。
+- `add`：只套用指定 features。
+- `list`：列出支援的 framework、feature、formatter、test runner。
 
-## 使用範例
+## 常見用法
 
-依賴自動偵測 framework 初始化：
+自動偵測 framework 初始化：
 
 ```bash
 npx @tyyyho/treg init
 ```
 
-手動指定 framework 初始化：
+手動指定 framework：
 
 ```bash
 npx @tyyyho/treg init --framework react
 ```
 
-只安裝 lint + format：
+只套用 lint + format：
 
 ```bash
 npx @tyyyho/treg add --features lint,format
 ```
 
-改用 oxfmt（不使用 prettier）：
+format 改用 `oxfmt`：
 
 ```bash
 npx @tyyyho/treg add --features format --formatter oxfmt
 ```
 
-若要保留既有設定，可跳過 format/test 安裝：
+保留既有設定，跳過 format/test：
 
 ```bash
 npx @tyyyho/treg add --no-format --no-test-runner
 ```
 
-test feature 使用 Vitest：
+只預覽計畫不寫檔：
 
 ```bash
-npx @tyyyho/treg init --framework node --features test --test-runner vitest
+npx @tyyyho/treg init --framework react --dry-run
 ```
 
-僅預覽變更（不寫檔）：
+指定目標目錄：
 
 ```bash
-npx @tyyyho/treg init --framework react --dry-run
+npx @tyyyho/treg init --framework react --dir ./packages/web
 ```
 
-更新 AI skills 指引：
+## 重要預設
 
-```bash
-npx @tyyyho/treg add --features lint,format,husky
+framework 偵測順序：
+
+`nuxt -> next -> react -> vue -> svelte -> node`
+
+測試工具預設：
+
+- `vue` / `nuxt`：`vitest`
+- 其他：`jest`
+
+formatter 預設：
+
+- `prettier`（可用 `--formatter oxfmt` 覆寫）
+
+## CLI 參數
+
+```text
+--framework <node|react|next|vue|svelte|nuxt>
+--features <lint,format,typescript,test,husky>
+--no-format
+--no-test-runner
+--dir <path>
+--formatter <prettier|oxfmt>
+--test-runner <jest|vitest>
+--pm <pnpm|npm|yarn|auto>
+--force
+--dry-run
+--skip-husky-install
+--skills
+--no-skills
+--help
 ```
 
-明確指定其他目錄：
+## AI Skills 行為
+
+啟用 skills 時：
+
+- 若 repo root 已存在 `CLAUDE.md`、`AGENTS.md`、`GEMINI.md`，會更新對應內容。
+- 若檔案不存在，不會自動建立。
+
+## 發布
 
 ```bash
-npx @tyyyho/treg init --framework react --dir ./packages/web
+pnpm release patch
 ```
 
-## 注意事項
+支援目標：
 
-- `init` 會依 repo 依賴自動偵測 framework。
-- 偵測順序：`nuxt -> next -> react -> vue -> svelte -> node`。
-- 預設測試工具為：`vue`/`nuxt` 使用 `vitest`，其他 framework 使用 `jest`。
-- 預設 formatter 為 `prettier`（可用 `--formatter oxfmt` 覆寫）。
-- 可透過 `--no-format` 與 `--no-test-runner` 跳過對 format/test 的設定，避免覆寫既有專案規則。
-- `add` 可只安裝你指定的 features。
-- 每個 framework 僅提供單一穩定設定，不支援 `--framework-version` 版本變體。
-- `--dry-run` 會輸出完整計畫且不寫入任何檔案。
+- `patch`
+- `minor`
+- `major`
+- `prepatch`
+- `preminor`
+- `premajor`
+- `prerelease`
+- 指定版本（`x.y.z`）

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tyyyho/treg",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "CLI tool for initializing development conventions in existing projects.",
   "license": "MIT",
   "repository": {