@tyyyho/treg 0.1.11 → 0.1.12

package/README.md

@@ -35,7 +35,7 @@ npx @tyyyho/treg <command> [options]
 - `--force`: Overwrite existing config files
 - `--dry-run`: Print full plan without writing files
 - `--skip-husky-install`: Skip husky install command
-- `--skills`: Update existing `AGENTS.md`/`CLAUDE.md` with skill guidance (enabled by default)
+- `--skills`: Update existing `CLAUDE.md`/`AGENTS.md`/`GEMINI.md` with skill guidance (enabled by default)
 - `--no-skills`: Disable skill guidance updates
 - `--help`: Show help
 

package/README.zh-hant.md

@@ -35,7 +35,7 @@ npx @tyyyho/treg <command> [options]
 - `--force`：覆寫既有設定檔
 - `--dry-run`：輸出完整執行計畫，但不寫入檔案
 - `--skip-husky-install`：略過 `husky install`
-- `--skills`：更新既有 `AGENTS.md`/`CLAUDE.md` 的 skill 指引（預設啟用）
+- `--skills`：更新既有 `CLAUDE.md`/`AGENTS.md`/`GEMINI.md` 的 skill 指引（預設啟用）
 - `--no-skills`：停用 skill 指引更新
 - `--help`：顯示說明
 

package/dist/init-project/cli.js

@@ -39,8 +39,8 @@ Options:
   --force                             Overwrite existing config files
   --dry-run                           Print planned changes without writing files
   --skip-husky-install                Do not run husky install
-  --skills                            Update AGENTS.md/CLAUDE.md with feature skill guidance (default: enabled)
-  --no-skills                         Disable AGENTS.md/CLAUDE.md skill guidance updates
+  --skills                            Update CLAUDE.md/AGENTS.md/GEMINI.md with feature skill guidance (default: enabled)
+  --no-skills                         Disable CLAUDE.md/AGENTS.md/GEMINI.md skill guidance updates
   -h, --help                          Show help
 `;
 function includes(allowed, value) {

package/dist/init-project/mrm-rules/ai-skills.js

@@ -3,68 +3,70 @@ import { promises as fs } from "node:fs";
 import path from "node:path";
 const START_MARKER = "<!-- treg:skills:start -->";
 const END_MARKER = "<!-- treg:skills:end -->";
+const SKILL_SECTION_HEADING = "## treg AI Skills";
 const SKILLS_BASE_DIR = "skills";
+const SKILLS_DOC_CANDIDATES = ["CLAUDE.md", "AGENTS.md", "GEMINI.md"];
 const FEATURE_SKILLS = {
     format: {
         name: "treg/format",
         description: "Run and verify formatting rules.",
-        when: "在提交前或大範圍改動後，統一格式化程式碼。",
-        checklist: ["執行 format", "執行 format:check", "確認未變動非目標檔案"],
+        when: "Before committing or after broad edits, normalize formatting across the codebase.",
+        checklist: [
+            "Run `format`.",
+            "Run `format:check`.",
+            "Confirm only intended files were changed.",
+        ],
     },
     husky: {
         name: "treg/husky",
         description: "Verify and maintain git hook automation.",
-        when: "需要保證 pre-commit / pre-push 自動檢查時。",
+        when: "When pre-commit and pre-push checks must stay enforced and consistent.",
         checklist: [
-            "確認 hooks 可執行",
-            "確認含 format:check 與 lint:check",
-            "若啟用型別/測試，也要納入 hooks",
+            "Ensure hooks are executable.",
+            "Ensure hooks include `format:check` and `lint:check`.",
+            "If type-checking or tests are enabled, ensure those checks are included.",
         ],
     },
     lint: {
         name: "treg/lint",
         description: "Run and validate lint rules.",
-        when: "新增規則或調整工具鏈後，驗證 lint 一致性。",
-        checklist: ["執行 lint", "執行 lint:check", "修正 max-warnings 問題"],
+        when: "After adding rules or changing tooling, verify lint consistency.",
+        checklist: [
+            "Run `lint`.",
+            "Run `lint:check`.",
+            "Fix max-warnings and remaining lint violations.",
+        ],
     },
     test: {
         name: "treg/test",
         description: "Validate test runner setup and execution.",
-        when: "新增測試規則或調整測試設定時。",
+        when: "When test rules are added or test configuration changes.",
         checklist: [
-            "確認 test runner 與專案一致",
-            "執行 test",
-            "視需要執行 test:coverage",
+            "Confirm the selected test runner matches the project setup.",
+            "Run `test`.",
+            "Run `test:coverage` when coverage validation is needed.",
         ],
     },
     typescript: {
         name: "treg/typescript",
         description: "Validate TypeScript strictness and config.",
-        when: "調整 tsconfig 或型別嚴格度規則時。",
+        when: "When tsconfig or strict typing rules are changed.",
         checklist: [
-            "執行 type-check",
-            "確認 strict 相關選項仍生效",
-            "檢查 exclude 不含產品邏輯路徑",
+            "Run `type:check`.",
+            "Confirm strict compiler options remain enabled.",
+            "Ensure `exclude` does not hide product-logic paths.",
         ],
     },
 };
 const FEATURE_STEP_LABELS = {
-    format: "格式處理",
-    husky: "Git hook 維護",
-    lint: "Lint 規則檢查",
-    test: "測試規則調整",
-    typescript: "TypeScript 型別與設定",
+    format: "Formatting",
+    husky: "Git Hook Maintenance",
+    lint: "Lint Validation",
+    test: "Test Configuration",
+    typescript: "TypeScript Settings",
 };
-function resolveSkillsDoc(projectDir) {
-    const agentsPath = path.join(projectDir, "AGENTS.md");
-    if (existsSync(agentsPath)) {
-        return agentsPath;
-    }
-    const claudePath = path.join(projectDir, "CLAUDE.md");
-    if (existsSync(claudePath)) {
-        return claudePath;
-    }
-    return null;
+function resolveSkillsDocs(projectDir) {
+    return SKILLS_DOC_CANDIDATES.map(fileName => path.join(projectDir, fileName)).filter(existsSync);
 }
 function getEnabledFeatures(enabledFeatures) {
     return Object.entries(enabledFeatures)
@@ -121,17 +123,9 @@ async function ensureSkillFiles(projectDir, enabled, testRunner, dryRun) {
 function buildSkillSection(context) {
     const { enabledFeatures, testRunner } = context;
     const enabled = getEnabledFeatures(enabledFeatures);
-    const lines = [
-        START_MARKER,
-        "## treg AI Skills",
-        "",
-        "### 執行步驟與 Skill 對應",
-        "",
-    ];
+    const lines = [SKILL_SECTION_HEADING, "", "### Steps and Skill Mapping", ""];
     if (enabled.length === 0) {
-        lines.push("1. 本次未啟用任何 feature，無需呼叫 skill。");
-        lines.push("");
-        lines.push(END_MARKER);
+        lines.push("1. No features are enabled in this run, so no skill call is required.");
         lines.push("");
         return lines.join("\n");
     }
@@ -141,25 +135,32 @@ function buildSkillSection(context) {
             return;
         const skillRelativePath = getSkillRelativePath(feature);
         const stepLabel = FEATURE_STEP_LABELS[feature] ?? feature;
-        lines.push(`${index + 1}. ${stepLabel}：呼叫 [${skill.name}](${skillRelativePath})`);
+        lines.push(`${index + 1}. ${stepLabel}: use [${skill.name}](${skillRelativePath})`);
         if (feature === "test") {
-            lines.push(`   - 目前測試工具：\`${testRunner}\``);
+            lines.push(`   - Current test runner: \`${testRunner}\``);
         }
     });
     lines.push("");
-    lines.push(END_MARKER);
-    lines.push("");
     return lines.join("\n");
 }
 function upsertSkillSection(content, nextSection) {
+    const replaceSection = (start, end) => {
+        const before = content.slice(0, start).trimEnd();
+        const after = content.slice(end).trimStart();
+        const rebuilt = `${before}\n\n${nextSection.trim()}\n`;
+        return after ? `${rebuilt}\n${after}\n` : `${rebuilt}`;
+    };
     const start = content.indexOf(START_MARKER);
     const end = content.indexOf(END_MARKER);
     if (start !== -1 && end !== -1 && end > start) {
         const suffixStart = end + END_MARKER.length;
-        const before = content.slice(0, start).trimEnd();
-        const after = content.slice(suffixStart).trimStart();
-        const rebuilt = `${before}\n\n${nextSection.trim()}\n`;
-        return after ? `${rebuilt}\n${after}\n` : `${rebuilt}`;
+        return replaceSection(start, suffixStart);
+    }
+    const headingStart = content.indexOf(SKILL_SECTION_HEADING);
+    if (headingStart !== -1) {
+        const nextHeading = content.indexOf("\n## ", headingStart + 1);
+        const sectionEnd = nextHeading === -1 ? content.length : nextHeading + 1;
+        return replaceSection(headingStart, sectionEnd);
     }
     if (!content.trim()) {
         return `${nextSection.trim()}\n`;
@@ -168,26 +169,28 @@ function upsertSkillSection(content, nextSection) {
 }
 export async function runAiSkillsRule(context) {
     const { projectDir, dryRun } = context;
-    const targetFile = resolveSkillsDoc(projectDir);
-    if (!targetFile) {
-        console.log("Skip ai-skills (AGENTS.md/CLAUDE.md not found)");
+    const targetFiles = resolveSkillsDocs(projectDir);
+    if (targetFiles.length === 0) {
+        console.log("Skip ai-skills (CLAUDE.md/AGENTS.md/GEMINI.md not found)");
         return;
     }
     const enabled = getEnabledFeatures(context.enabledFeatures);
     await ensureSkillFiles(projectDir, enabled, context.testRunner, dryRun);
     const section = buildSkillSection(context);
-    const current = await fs.readFile(targetFile, "utf8");
-    const updated = upsertSkillSection(current, section);
-    if (dryRun) {
-        console.log(`[dry-run] Would update ${path.basename(targetFile)} with AI skill guidance`);
-        return;
-    }
-    if (updated !== current) {
-        await fs.writeFile(targetFile, updated, "utf8");
-        console.log(`Updated ${path.basename(targetFile)} with AI skill guidance`);
-        return;
+    for (const targetFile of targetFiles) {
+        if (dryRun) {
+            console.log(`[dry-run] Would update ${path.basename(targetFile)} with AI skill guidance`);
+            continue;
+        }
+        const current = await fs.readFile(targetFile, "utf8");
+        const updated = upsertSkillSection(current, section);
+        if (updated !== current) {
+            await fs.writeFile(targetFile, updated, "utf8");
+            console.log(`Updated ${path.basename(targetFile)} with AI skill guidance`);
+            continue;
+        }
+        console.log(`${path.basename(targetFile)} already contains latest AI skill guidance`);
     }
-    console.log(`${path.basename(targetFile)} already contains latest AI skill guidance`);
 }
 export const __testables__ = {
     buildSkillSection,
@@ -195,6 +198,6 @@ export const __testables__ = {
     ensureSkillFiles,
     getEnabledFeatures,
     getSkillRelativePath,
-    resolveSkillsDoc,
+    resolveSkillsDocs,
     upsertSkillSection,
 };

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

@@ -10,7 +10,7 @@ function buildHookCommands(runner, enabledFeatures) {
         `${runner} lint:check || exit 1`,
     ];
     if (enabledFeatures.typescript) {
-        preCommit.push(`${runner} type-check || exit 1`);
+        preCommit.push(`${runner} type:check || exit 1`);
     }
     const prePush = [...preCommit];
     if (enabledFeatures.test) {

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

@@ -16,7 +16,7 @@ export async function runTypescriptRule(context) {
     withProjectCwd(projectDir, () => {
         if (dryRun) {
             console.log("[dry-run] Would update tsconfig.json");
-            console.log("[dry-run] Would set package script: type-check");
+            console.log("[dry-run] Would set package script: type:check");
             return;
         }
         const tsconfig = json("tsconfig.json", {
@@ -35,6 +35,6 @@ export async function runTypescriptRule(context) {
             .set("compilerOptions", mergedCompilerOptions)
             .set("exclude", Array.from(exclude))
             .save();
-        packageJson().setScript("type-check", "tsc --noEmit").save();
+        packageJson().setScript("type:check", "tsc --noEmit").save();
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tyyyho/treg",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "CLI tool for initializing development conventions in existing projects.",
   "license": "MIT",
   "repository": {
@@ -27,11 +27,11 @@
     "lint:check": "eslint . --max-warnings 0",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "type-check": "tsc --noEmit",
+    "type:check": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json && node scripts/write-dist-package-json.mjs",
     "release": "node scripts/release.mjs",
     "prepare": "husky",
-    "prepublishOnly": "pnpm format:check && pnpm lint:check && pnpm type-check && pnpm test && pnpm build"
+    "prepublishOnly": "pnpm format:check && pnpm lint:check && pnpm type:check && pnpm test && pnpm build"
   },
   "dependencies": {
     "mrm-core": "^7.1.22"