@tyyyho/treg 0.1.8 → 0.1.11

package/README.md

@@ -1,17 +1,19 @@
 # @tyyyho/treg
 
+[繁體中文 README](./README.zh-hant.md)
+
 `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.
 
 ## Quick Start
 
 ```bash
-pnpm dlx @tyyyho/treg init --framework react
+pnpm dlx @tyyyho/treg init
 # or
-npx @tyyyho/treg init --framework react
+npx @tyyyho/treg init
 ```
 
-`init` requires `--framework`.
+`init` auto-detects framework from dependencies.
 
 ## Commands
 
@@ -19,17 +21,16 @@ npx @tyyyho/treg init --framework react
 npx @tyyyho/treg <command> [options]
 ```
 
-- `init`: Initialize infra rules (requires `--framework`)
+- `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
 
 ## Options
 
-- `--framework <node|react|next|vue|svelte|nuxt>`: Target framework
-- `--framework-version <major>`: Optional major version hint (react only)
+- `--framework <node|react|next|vue|svelte|nuxt>`: Optional framework override
 - `--features <lint,format,typescript,test,husky>`: Features to install (defaults to all)
 - `--dir <path>`: Target directory (defaults to current directory)
-- `--test-runner <jest|vitest>`: Test runner when test feature is enabled
+- `--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
@@ -50,7 +51,13 @@ Default feature set:
 
 ## Examples
 
-Initialize a React project:
+Initialize with auto-detected framework:
+
+```bash
+npx @tyyyho/treg init
+```
+
+Initialize with explicit framework override:
 
 ```bash
 npx @tyyyho/treg init --framework react
@@ -68,12 +75,6 @@ Use Vitest for test feature:
 npx @tyyyho/treg init --framework node --features test --test-runner vitest
 ```
 
-Use react major version variant:
-
-```bash
-npx @tyyyho/treg init --framework react --framework-version 18
-```
-
 Preview changes only:
 
 ```bash
@@ -94,6 +95,9 @@ npx @tyyyho/treg init --framework react --dir ./packages/web
 
 ## Notes
 
-- `init` requires `--framework`.
+- `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.
 - `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

@@ -0,0 +1,103 @@
+# @tyyyho/treg（繁體中文）
+
+[English README](./README.md)
+
+`treg` 是一個用於既有專案的 CLI 工具，可快速建立與套用工具鏈規範。
+預設搭建基礎設定，包含 lint、format、TypeScript、test、husky、skills。
+
+## 快速開始
+
+```bash
+pnpm dlx @tyyyho/treg init
+# 或
+npx @tyyyho/treg init
+```
+
+`init` 會依照依賴自動偵測 framework。
+
+## 指令
+
+```bash
+npx @tyyyho/treg <command> [options]
+```
+
+- `init`：初始化基礎規範（依賴自動偵測 framework）
+- `add`：在既有專案中新增指定 feature
+- `list`：列出支援的 framework、feature 與 test runner
+
+## 參數
+
+- `--framework <node|react|next|vue|svelte|nuxt>`：可選，手動覆寫 framework
+- `--features <lint,format,typescript,test,husky>`：指定要安裝的 feature（預設全部）
+- `--dir <path>`：指定目標目錄（預設為目前目錄）
+- `--test-runner <jest|vitest>`：可選，啟用 test feature 時覆寫測試框架
+- `--pm <pnpm|npm|yarn|auto>`：套件管理器（預設自動偵測）
+- `--force`：覆寫既有設定檔
+- `--dry-run`：輸出完整執行計畫，但不寫入檔案
+- `--skip-husky-install`：略過 `husky install`
+- `--skills`：更新既有 `AGENTS.md`/`CLAUDE.md` 的 skill 指引（預設啟用）
+- `--no-skills`：停用 skill 指引更新
+- `--help`：顯示說明
+
+## Features
+
+預設 feature 組合：
+
+- `husky`
+- `typescript`
+- `lint`
+- `format`
+- `test`
+
+## 使用範例
+
+依賴自動偵測 framework 初始化：
+
+```bash
+npx @tyyyho/treg init
+```
+
+手動指定 framework 初始化：
+
+```bash
+npx @tyyyho/treg init --framework react
+```
+
+只安裝 lint + format：
+
+```bash
+npx @tyyyho/treg add --features lint,format
+```
+
+test feature 使用 Vitest：
+
+```bash
+npx @tyyyho/treg init --framework node --features test --test-runner vitest
+```
+
+僅預覽變更（不寫檔）：
+
+```bash
+npx @tyyyho/treg init --framework react --dry-run
+```
+
+更新 AI skills 指引：
+
+```bash
+npx @tyyyho/treg add --features lint,format,husky
+```
+
+明確指定其他目錄：
+
+```bash
+npx @tyyyho/treg init --framework react --dir ./packages/web
+```
+
+## 注意事項
+
+- `init` 會依 repo 依賴自動偵測 framework。
+- 偵測順序：`nuxt -> next -> react -> vue -> svelte -> node`。
+- 預設測試工具為：`vue`/`nuxt` 使用 `vitest`，其他 framework 使用 `jest`。
+- `add` 可只安裝你指定的 features。
+- 每個 framework 僅提供單一穩定設定，不支援 `--framework-version` 版本變體。
+- `--dry-run` 會輸出完整計畫且不寫入任何檔案。

package/dist/init-project/cli.js

@@ -24,18 +24,17 @@ const ALLOWED_TEST_RUNNERS = ["jest", "vitest"];
 export const USAGE = `Usage: treg <command> [options]
 
 Commands:
-  init                                Initialize infra rules in a project (requires --framework)
+  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
 
 Options:
   --framework <node|react|next|vue|svelte|nuxt>
-                                      Target framework
-  --framework-version <major>         Optional framework major version hint
+                                      Optional framework override (default: auto-detected)
   --features <lint,format,typescript,test,husky>
                                       Features to install (all selected by default)
   --dir <path>                        Target directory (defaults to current directory)
-  --test-runner <jest|vitest>         Test runner when test feature is enabled
+  --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
   --dry-run                           Print planned changes without writing files
@@ -67,9 +66,8 @@ export function parseArgs(argv) {
         command: "init",
         projectDir: null,
         framework: null,
-        frameworkVersion: null,
         features: [],
-        testRunner: "jest",
+        testRunner: null,
         pm: null,
         force: false,
         dryRun: false,
@@ -98,13 +96,6 @@ export function parseArgs(argv) {
         else if (arg.startsWith("--framework=")) {
             options.framework = readInlineFlagValue(arg, "--framework");
         }
-        else if (arg === "--framework-version") {
-            options.frameworkVersion = readFlagValue(argv, i, "--framework-version");
-            i += 1;
-        }
-        else if (arg.startsWith("--framework-version=")) {
-            options.frameworkVersion = readInlineFlagValue(arg, "--framework-version");
-        }
         else if (arg === "--features") {
             options.features.push(...parseCsvValue(argv[i + 1], "--features"));
             i += 1;
@@ -191,15 +182,7 @@ function validateParsedOptions(options) {
     if (options.framework && !isFrameworkId(options.framework)) {
         throw new Error(`Unsupported framework: ${options.framework}`);
     }
-    if (options.frameworkVersion && !/^\d+$/.test(options.frameworkVersion)) {
-        throw new Error("Invalid --framework-version: major version must be numeric");
-    }
-    if (options.frameworkVersion &&
-        options.framework &&
-        options.framework !== "react") {
-        throw new Error(`Unsupported --framework-version for framework: ${options.framework}`);
-    }
-    if (!isTestRunner(options.testRunner)) {
+    if (options.testRunner && !isTestRunner(options.testRunner)) {
         throw new Error(`Unsupported test runner: ${options.testRunner}`);
     }
     for (const feature of options.features) {
@@ -207,9 +190,6 @@ function validateParsedOptions(options) {
             throw new Error(`Unsupported feature in --features: ${feature}`);
         }
     }
-    if (options.command === "init" && !options.help && !options.framework) {
-        throw new Error("Missing required option: --framework");
-    }
 }
 export function resolveFeatures(options) {
     const selected = new Set(options.features.length > 0 ? options.features : ALLOWED_FEATURES);
@@ -226,3 +206,12 @@ export function printSupportedTargets() {
     console.log("Features: lint, format, typescript, test, husky");
     console.log("Test runners: jest, vitest");
 }
+export function resolveTestRunner(frameworkId, testRunner) {
+    if (testRunner) {
+        return testRunner;
+    }
+    if (frameworkId === "vue" || frameworkId === "nuxt") {
+        return "vitest";
+    }
+    return "jest";
+}

package/dist/init-project/frameworks/index.js

@@ -1,7 +1,7 @@
 import { nextFramework } from "./next/index.js";
 import { nodeFramework } from "./node/index.js";
 import { nuxtFramework } from "./nuxt/index.js";
-import { reactFramework, resolveReactFramework } from "./react/index.js";
+import { reactFramework } from "./react/index.js";
 import { svelteFramework } from "./svelte/index.js";
 import { vueFramework } from "./vue/index.js";
 const FRAMEWORK_REGISTRY = {
@@ -20,18 +20,11 @@ const FRAMEWORK_DETECT_ORDER = [
     svelteFramework,
     nodeFramework,
 ];
-export function resolveFramework(frameworkArg, frameworkVersion, packageJson) {
-    if (frameworkArg === "react") {
-        return resolveReactFramework(packageJson, frameworkVersion);
-    }
+export function resolveFramework(frameworkArg, packageJson) {
     if (frameworkArg) {
         return FRAMEWORK_REGISTRY[frameworkArg];
     }
-    const detected = detectFramework(packageJson);
-    if (detected.id === "react") {
-        return resolveReactFramework(packageJson, frameworkVersion);
-    }
-    return detected;
+    return detectFramework(packageJson);
 }
 export function detectFramework(packageJson) {
     const matched = FRAMEWORK_DETECT_ORDER.find(framework => framework.matches(packageJson));

package/dist/init-project/frameworks/react/index.js

@@ -1,27 +1,9 @@
 import { hasPackage } from "../../utils.js";
-import { reactV18Framework } from "./v18/index.js";
-import { reactV19Framework } from "./v19/index.js";
 export const reactFramework = {
     id: "react",
-    variant: "v19",
     testEnvironment: "jsdom",
     tsRequiredExcludes: ["dist", "coverage", "jest.config.js", "public"],
     matches(packageJson) {
         return (hasPackage(packageJson, "react") || hasPackage(packageJson, "react-dom"));
     },
 };
-const REACT_VARIANTS = {
-    "18": reactV18Framework,
-    "19": reactV19Framework,
-};
-export function resolveReactFramework(packageJson, frameworkVersion) {
-    if (frameworkVersion && REACT_VARIANTS[frameworkVersion]) {
-        return REACT_VARIANTS[frameworkVersion];
-    }
-    const detected = packageJson?.dependencies?.react ?? packageJson?.devDependencies?.react;
-    const major = typeof detected === "string" ? detected.match(/\d+/)?.[0] : null;
-    if (major && REACT_VARIANTS[major]) {
-        return REACT_VARIANTS[major];
-    }
-    return reactFramework;
-}

package/dist/init-project/index.js

@@ -1,7 +1,7 @@
 import { existsSync } from "node:fs";
 import { promises as fs } from "node:fs";
 import path from "node:path";
-import { parseArgs, printSupportedTargets, resolveFeatures, USAGE, } from "./cli.js";
+import { parseArgs, printSupportedTargets, resolveFeatures, resolveTestRunner, USAGE, } from "./cli.js";
 import { resolveFramework } from "./frameworks/index.js";
 import { runFeatureRules } from "./mrm-rules/index.js";
 import { detectPackageManager, runScript } from "./package-manager.js";
@@ -37,25 +37,22 @@ export async function main(argv = process.argv.slice(2)) {
     const pm = !options.pm || options.pm === "auto"
         ? detectPackageManager(projectDir)
         : options.pm;
-    const framework = resolveFramework(options.framework, options.frameworkVersion, packageJson);
-    if (options.frameworkVersion && framework.id !== "react") {
-        console.error(`Unsupported --framework-version for framework: ${framework.id}`);
-        process.exitCode = 1;
-        return;
-    }
+    const framework = resolveFramework(options.framework, packageJson);
+    const testRunner = resolveTestRunner(framework.id, options.testRunner);
     const enabledFeatures = resolveFeatures(options);
     const context = {
         ...options,
+        testRunner,
         projectDir,
         pm,
         framework,
         enabledFeatures,
     };
     console.log(formatStep(1, TOTAL_STEPS, "Resolve plan", options.dryRun));
-    console.log(`${options.dryRun ? "[dry-run] " : ""}Framework=${framework.id}${framework.variant ? `/${framework.variant}` : ""}, features=${Object.entries(enabledFeatures)
+    console.log(`${options.dryRun ? "[dry-run] " : ""}Framework=${framework.id}, features=${Object.entries(enabledFeatures)
         .filter(([, enabled]) => enabled)
         .map(([name]) => name)
-        .join(", ")}, testRunner=${options.testRunner}`);
+        .join(", ")}, 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/package.json

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

package/dist/init-project/frameworks/react/v18/index.js

@@ -1,6 +0,0 @@
-export const reactV18Framework = {
-    id: "react",
-    variant: "v18",
-    testEnvironment: "jsdom",
-    tsRequiredExcludes: ["dist", "coverage", "jest.config.js", "public"],
-};

package/dist/init-project/frameworks/react/v19/index.js

@@ -1,6 +0,0 @@
-export const reactV19Framework = {
-    id: "react",
-    variant: "v19",
-    testEnvironment: "jsdom",
-    tsRequiredExcludes: ["dist", "coverage", "jest.config.js", "public"],
-};