@tyyyho/treg 0.1.12 → 0.1.13

package/README.md

@@ -8,11 +8,13 @@ It applies infra setup such as lint, format, TypeScript, test, husky, and AI ski
 ## Quick Start
 
 ```bash
-pnpm dlx @tyyyho/treg init
-# or
 npx @tyyyho/treg init
 ```
 
+```bash
+pnpm dlx @tyyyho/treg init
+```
+
 `init` auto-detects framework from dependencies.
 
 ## Commands
@@ -23,13 +25,16 @@ 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, and test runners
+- `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
@@ -69,6 +74,18 @@ Add only lint + format:
 npx @tyyyho/treg add --features lint,format
 ```
 
+Use oxfmt instead of prettier:
+
+```bash
+npx @tyyyho/treg add --features format --formatter oxfmt
+```
+
+Skip format/test setup to keep existing project rules untouched:
+
+```bash
+npx @tyyyho/treg add --no-format --no-test-runner
+```
+
 Use Vitest for test feature:
 
 ```bash
@@ -98,6 +115,8 @@ npx @tyyyho/treg init --framework react --dir ./packages/web
 - `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.zh-hant.md

@@ -8,11 +8,13 @@
 ## 快速開始
 
 ```bash
-pnpm dlx @tyyyho/treg init
-# 或
 npx @tyyyho/treg init
 ```
 
+```bash
+pnpm dlx @tyyyho/treg init
+```
+
 `init` 會依照依賴自動偵測 framework。
 
 ## 指令
@@ -23,13 +25,16 @@ npx @tyyyho/treg <command> [options]
 
 - `init`：初始化基礎規範（依賴自動偵測 framework）
 - `add`：在既有專案中新增指定 feature
-- `list`：列出支援的 framework、feature 與 test runner
+- `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`：覆寫既有設定檔
@@ -69,6 +74,18 @@ npx @tyyyho/treg init --framework react
 npx @tyyyho/treg add --features lint,format
 ```
 
+改用 oxfmt（不使用 prettier）：
+
+```bash
+npx @tyyyho/treg add --features format --formatter oxfmt
+```
+
+若要保留既有設定，可跳過 format/test 安裝：
+
+```bash
+npx @tyyyho/treg add --no-format --no-test-runner
+```
+
 test feature 使用 Vitest：
 
 ```bash
@@ -98,6 +115,8 @@ npx @tyyyho/treg init --framework react --dir ./packages/web
 - `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` 會輸出完整計畫且不寫入任何檔案。

package/dist/init-project/cli.js

@@ -21,19 +21,23 @@ const ALLOWED_FEATURES = [
     "husky",
 ];
 const ALLOWED_TEST_RUNNERS = ["jest", "vitest"];
+const ALLOWED_FORMATTERS = ["prettier", "oxfmt"];
 export const USAGE = `Usage: treg <command> [options]
 
 Commands:
   init                                Initialize infra rules in a project (framework auto-detected from dependencies)
   add                                 Add selected infra features to an existing project
-  list                                List supported frameworks, features, and test runners
+  list                                List supported frameworks, features, formatters, and test runners
 
 Options:
   --framework <node|react|next|vue|svelte|nuxt>
                                       Optional framework override (default: auto-detected)
   --features <lint,format,typescript,test,husky>
                                       Features to install (all selected by default)
+  --no-format                         Skip format feature setup and avoid changing format config/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 (default: vue/nuxt=vitest, others=jest)
   --pm <pnpm|npm|yarn|auto>           Package manager (auto-detected if omitted)
   --force                             Overwrite existing config files
@@ -61,16 +65,22 @@ function isFeatureName(value) {
 function isTestRunner(value) {
     return includes(ALLOWED_TEST_RUNNERS, value);
 }
+function isFormatter(value) {
+    return includes(ALLOWED_FORMATTERS, value);
+}
 export function parseArgs(argv) {
     const options = {
         command: "init",
         projectDir: null,
         framework: null,
+        formatter: "prettier",
         features: [],
         testRunner: null,
         pm: null,
         force: false,
         dryRun: false,
+        noFormat: false,
+        noTestRunner: false,
         skipHuskyInstall: false,
         skills: true,
         help: false,
@@ -110,6 +120,13 @@ export function parseArgs(argv) {
         else if (arg.startsWith("--dir=")) {
             options.projectDir = readInlineFlagValue(arg, "--dir");
         }
+        else if (arg === "--formatter") {
+            options.formatter = readFlagValue(argv, i, "--formatter");
+            i += 1;
+        }
+        else if (arg.startsWith("--formatter=")) {
+            options.formatter = readInlineFlagValue(arg, "--formatter");
+        }
         else if (arg === "--test-runner") {
             options.testRunner = readFlagValue(argv, i, "--test-runner");
             i += 1;
@@ -130,6 +147,12 @@ export function parseArgs(argv) {
         else if (arg === "--dry-run") {
             options.dryRun = true;
         }
+        else if (arg === "--no-format") {
+            options.noFormat = true;
+        }
+        else if (arg === "--no-test-runner") {
+            options.noTestRunner = true;
+        }
         else if (arg === "--skip-husky-install") {
             options.skipHuskyInstall = true;
         }
@@ -182,6 +205,9 @@ function validateParsedOptions(options) {
     if (options.framework && !isFrameworkId(options.framework)) {
         throw new Error(`Unsupported framework: ${options.framework}`);
     }
+    if (!isFormatter(options.formatter)) {
+        throw new Error(`Unsupported formatter: ${options.formatter}`);
+    }
     if (options.testRunner && !isTestRunner(options.testRunner)) {
         throw new Error(`Unsupported test runner: ${options.testRunner}`);
     }
@@ -193,6 +219,12 @@ function validateParsedOptions(options) {
 }
 export function resolveFeatures(options) {
     const selected = new Set(options.features.length > 0 ? options.features : ALLOWED_FEATURES);
+    if (options.noFormat) {
+        selected.delete("format");
+    }
+    if (options.noTestRunner) {
+        selected.delete("test");
+    }
     return {
         lint: selected.has("lint"),
         format: selected.has("format"),
@@ -204,6 +236,7 @@ export function resolveFeatures(options) {
 export function printSupportedTargets() {
     console.log("Frameworks: node, react, next, vue, svelte, nuxt");
     console.log("Features: lint, format, typescript, test, husky");
+    console.log("Formatters: prettier, oxfmt");
     console.log("Test runners: jest, vitest");
 }
 export function resolveTestRunner(frameworkId, testRunner) {

package/dist/init-project/index.js

@@ -52,7 +52,7 @@ export async function main(argv = process.argv.slice(2)) {
     console.log(`${options.dryRun ? "[dry-run] " : ""}Framework=${framework.id}, features=${Object.entries(enabledFeatures)
         .filter(([, enabled]) => enabled)
         .map(([name]) => name)
-        .join(", ")}, testRunner=${testRunner}`);
+        .join(", ")}, formatter=${options.formatter}, testRunner=${testRunner}`);
     console.log(formatStep(2, TOTAL_STEPS, "Run mrm rules", options.dryRun));
     await runFeatureRules(context);
     console.log(formatStep(3, TOTAL_STEPS, "Finalize", options.dryRun));

package/dist/init-project/mrm-rules/format.js

@@ -25,20 +25,35 @@ const PRETTIER_IGNORE = [
     "package-lock.json",
     "yarn.lock",
 ];
+function getFormatterScripts(formatter) {
+    if (formatter === "oxfmt") {
+        return {
+            format: "oxfmt --write .",
+            formatCheck: "oxfmt --check .",
+        };
+    }
+    return {
+        format: "prettier --write .",
+        formatCheck: "prettier --check .",
+    };
+}
 export async function runFormatRule(context) {
-    const { projectDir, pm, force, dryRun } = context;
-    installPackages(projectDir, pm, ["prettier"], true, dryRun);
-    await writeFile(projectDir, ".prettierrc.json", PRETTIER_CONFIG, force, dryRun);
+    const { projectDir, pm, force, dryRun, formatter } = context;
+    const { format, formatCheck } = getFormatterScripts(formatter);
+    installPackages(projectDir, pm, [formatter], true, dryRun);
+    if (formatter === "prettier") {
+        await writeFile(projectDir, ".prettierrc.json", PRETTIER_CONFIG, force, dryRun);
+    }
     withProjectCwd(projectDir, () => {
         if (dryRun) {
             console.log("[dry-run] Would update .prettierignore");
-            console.log("[dry-run] Would set package scripts: format, format:check");
+            console.log(`[dry-run] Would set package scripts: format (${format}), format:check (${formatCheck})`);
             return;
         }
         lines(".prettierignore").add(PRETTIER_IGNORE).save();
         packageJson()
-            .setScript("format", "prettier --write .")
-            .setScript("format:check", "prettier --check .")
+            .setScript("format", format)
+            .setScript("format:check", formatCheck)
             .save();
     });
 }

package/package.json

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