architext 0.0.5 → 0.0.6

package/dist/templates/en/rules/03_data_governance.md

@@ -1,106 +0,0 @@
----
-description: AI collaboration governance rules for JSON data files. Defines read/write specs, update timing & format constraints for global data files.
-globs: "**/*.json"
-applyTo: "**/*.json"
-alwaysApply: true
----
-
-# Data Governance Protocol
-
-> **Role**: Data Steward. Ensure consistency, integrity & traceability of global JSON data files.
-
-## 1. Data File Registry
-
-| File | Read When | Write When |
-|:---|:---|:---|
-| `roadmap.json` | plan/code start | start creates; AI edit or `npx archi task` updates |
-| `map.json` | When touching code (via context_glue) | plan Step 3; inherit Step 3.6; /archi.map |
-| `dictionary.json` | When generating variable names | plan Step 3; code/fix step_5 auto-appends |
-| `design_tokens.json` [?UI] | When generating UI code | start creates; update on design changes |
-| `data_snapshot.json` [?Data] | plan design / code implementation | Plan designs Schema; Code syncs changes |
-| `error_codes.json` | When writing error handling | plan Step 3; code/fix step_5 auto-appends |
-| `api_snapshot.json` [?API] | When implementing endpoints | plan Step 3 registers; Code syncs |
-| `env_registry.json` [?API] | When introducing config items | Code appends immediately on new env var |
-| `command_api.json` [?CLI] | When implementing commands | plan Step 3 registers; Code syncs |
-| `public_api.json` [?Lib] | When adding/modifying exports | plan Step 3 registers; Code syncs |
-
----
-
-## 2. General Rules
-
-### 2.1 Format Constraints
-
-- **JSON Only**: `.json` is the single source of truth. `.md` views are auto-generated by `npx archi render`; forbidden to edit directly.
-- **Schema Stability**:
-  - **Tier 1 (Strict)**: `roadmap.json`, `plan.json` — CLI depends on these; Zod Schema validated; forbidden to change arbitrarily.
-  - **Tier 2 (Flexible)**: All other files only validate top-level keys. **All Tier 2 files may freely extend fields (new keys / new array item properties) without CLI changes.**
-- **Valid JSON**: No trailing commas, no comments.
-
-### 2.2 Read/Write Discipline
-
-| Scenario | Rule |
-|:---|:---|
-| Consult data | Read `.json`; forbidden to read `.md` view (may be stale) |
-| Update Roadmap status | Prefer `npx archi task <ID> --status <s>`; batch may edit JSON directly |
-| Update other data | AI directly edits `.json` |
-| After updates | Run `npx archi render` to regenerate `.md` views |
-
----
-
-## 3. File-Specific Rules
-
-### `roadmap.json`
-
-- **Structure**: `phases[] → tasks[]`, each task must have `id`, `title`, `status`, `deps`.
-- **Status values**: `pending` | `active` | `done` | `blocked`.
-- **Dependency integrity**: IDs in `deps` must exist in tasks.
-- **Slug rule**: `slug` used for tasks folder naming, format `Snake_Case`.
-
-### `map.json`
-
-- **Directory Mapping**: Must reflect real physical file tree.
-- **Logical Topology**: Must register each Task Module's responsibility.
-- **Feature Relations**: `featureRelations` records aggregator-source linkages, written by AI during plan/inherit.
-- **Self-Correction**: Code references violating topology hierarchy must report error and stop.
-
-### `dictionary.json`
-
-- **Naming Authority**: `entities[].codeName` is the supreme law; forbidden to use `forbiddenSynonyms`.
-- **Boundary**: Only register project business domain; Architext framework concepts forbidden.
-- verbs maintain project-wide verb consistency; utilities must be registered and used instead of raw APIs.
-- [?UI]: components — search existing before creating new ones.
-
-### `design_tokens.json` [?UI]
-
-- **Token Only**: Styles must use Tokens; forbidden to hardcode Hex/px/rem.
-- **Dark Mode**: Must define both `light` and `dark` values.
-
-### `data_snapshot.json` [?Data]
-
-- **Structure**: `models[]` (name/fields/types/constraints) + `relationships[]` (1:1/1:N/M:N/self-ref).
-- **Design First**: Plan must define model structure, precise to field names and types; forbidden to write "TBD".
-- **Sync Back**: After Code phase, must sync actual changes back.
-
-### `error_codes.json`
-
-- **Boundary**: Only register project business domain errors; framework infrastructure errors forbidden.
-- **Code Format**: `ERR_[MODULE]_[REASON]`.
-- **Design Before Code**: Must register error codes before writing error handling, including `message` and `recovery`.
-
-### Conditional File Rules
-
-| File | Core Rules |
-|:---|:---|
-| `api_snapshot.json` [?API] | endpoints[] registry; Register First — forbidden to implement unregistered endpoints; owner marks Task ID |
-| `env_registry.json` [?API] | Register on introduce; required/example mandatory |
-| `command_api.json` [?CLI] | Sync on modify; owner marks Task ID |
-| `public_api.json` [?Lib] | stable changes require /archi.edit; full TS signature; owner marks Task ID |
-
----
-
-## 4. Plan JSON (`plan.json`)
-
-- **Location**: `tasks/<ID>_<Slug>/plan.json`
-- **Checkbox Updates**: AI sets `done` to `true` directly after completing steps during `/archi.code`.
-- **Append Rule**: `/archi.edit` appends new Phases while preserving completed history.
-- **Verification**: Run `npx archi plan <ID>` to verify completion.

package/dist/templates/en/rules/99_context_glue.md

@@ -1,53 +0,0 @@
----
-description: Context Navigation & Document Indexing. Bridges source code to documentation using the Map registry. Essential for locating specs and plans.
-globs: **/*
-applyTo: **/*
-alwaysApply: true
----
-
-# Context Glue Protocol
-
-> **Role**: Context Navigator. Prevent AI amnesia, use Map Look-up to determine the business document corresponding to the current code.
-
-## 1. Context Discovery
-
-When reading or editing code files, must execute the following addressing steps:
-
-**Step 1: Check Global Map**
-- Read `[[__DOCS_DIR__]]/global/map.json`.
-- Find the module the current file belongs to in `directoryMapping` / `logicalTopology`.
-- Load the Docs Link (Spec/UI/Plan) registered for that module.
-
-**Step 2: Check Explicit Context**
-- Scenario: Newly created file or Map not yet updated.
-- Check if user Prompt explicitly specified a document path, if so must load it.
-
-**Step 3: Fallback**
-- Not registered in Map and user did not specify → **STOP & ASK**.
-- Prompt: "Spec document for current code not found. Please provide the path, or run `/archi.map` to update the architecture map."
-
----
-
-## 2. Mandatory Loading Rules
-
-| Code Type | Required Context | Source of Truth |
-|:---|:---|:---|
-| **Business Logic** (Tasks/Entities) | Spec Document | `[[__DOCS_DIR__]]/global/map.json` → Module Entry |
-| **UI Components** (Pages/Widgets) [?UI] | UI Document + `[[__DOCS_DIR__]]/global/design_tokens.json` | `[[__DOCS_DIR__]]/global/map.json` + Global Rules |
-| **Data Schema** (ORM/SQL/Models) [?Data] | Data Snapshot | `[[__DOCS_DIR__]]/global/data_snapshot.json` |
-| **Config / Infra** (Package.json...) | Tech Stack | `02_tech_stack.md` |
-
----
-
-## 3. Anti-Hallucination
-
-- Code is the downstream artifact of documentation.
-- Forbidden to guess business logic based on variable names without reading Spec.
-- When code is found inconsistent with documentation: do not arbitrarily fix either, must pause and report the inconsistency.
-
----
-
-## 4. Maintenance Hook
-
-- **Trigger**: When creating a new file or new module.
-- **Action**: Must automatically update `map.json` to establish mapping between code path and document path; only ask user when the mapping relationship is unclear.

package/dist/templates/zh/rules/01_workflow.md

@@ -1,95 +0,0 @@
----
-description: Command Dispatcher & Workflow Controller. Handles /archi.* routing and mode transitions.
-globs: **/*
-applyTo: **/*
-alwaysApply: true
----
-
-# Workflow Dispatcher
-
-> **Role**: 模式切换器。默认"通用架构师"模式，仅检测到显式指令时加载特定协议。
-
-> ⛔ **STOP CHECK** — 每轮回复前自检:
-> | 违规行为 | 正确处理 |
-> |:---|:---|
-> | 收到 `/archi.*` 却未读协议文件就执行 | 停止 → 先读取协议文件 |
-> | 用户请求涉及行为变更却直接改代码 | 停止 → 加载对应协议执行 |
-> | 执行 `npx archi` 前未确认工作目录 | 停止 → 先通过 Working Directory Gate（见 `04_cli_tools.md`） |
-
-## 1. Explicit Command Routing
-
-**Trigger**: 用户输入以 `/archi.` 开头时，立即加载对应协议。
-
-| Command | Target Template |
-|:---|:---|
-| `/archi.start` | `[[__PROMPTS_PATH__]]/archi.start.md` |
-| `/archi.inherit` | `[[__PROMPTS_PATH__]]/archi.inherit.md` |
-| `/archi.scope` | `[[__PROMPTS_PATH__]]/archi.scope.md` |
-| `/archi.plan` | `[[__PROMPTS_PATH__]]/archi.plan.md` |
-| `/archi.edit` | `[[__PROMPTS_PATH__]]/archi.edit.md` |
-| `/archi.revise` | `[[__PROMPTS_PATH__]]/archi.revise.md` |
-| `/archi.code` | `[[__PROMPTS_PATH__]]/archi.code.md` |
-| `/archi.audit` | `[[__PROMPTS_PATH__]]/archi.audit.md` |
-| `/archi.fix` | `[[__PROMPTS_PATH__]]/archi.fix.md` |
-| `/archi.map` | `[[__PROMPTS_PATH__]]/archi.map.md` |
-| `/archi.remove` | `[[__PROMPTS_PATH__]]/archi.remove.md` |
-| `/archi.ref` | `[[__PROMPTS_PATH__]]/archi.ref.md` |
-| `/archi.recover` | `[[__PROMPTS_PATH__]]/archi.recover.md` |
-| `/archi.help` | `[[__PROMPTS_PATH__]]/archi.help.md` |
-
-> **Protocol Load Gate** (禁跳过，按序完成):
-> 1. **Read** 目标 `.md` 全文 → 文件不存在时停止: `协议文件未找到，中止执行`
-> 2. **Override** — 可覆盖: `<system_role>`, `<thinking_process>`, `<communication_style>`。不可覆盖: `<core_philosophy>`, `<critical_protocols>`。
-> 3. **Execute** `<step_1>` — 禁在步骤 1 完成前执行任何协议内容
-
----
-
-## 2. Natural Language Dispatch
-
-**Trigger**: 用户输入非 `/archi.` 指令且涉及业务变更。
-
-### §2.0 不触发协议的场景（直接回答）
-
-| 意图类型 | 处理 |
-|:---|:---|
-| 纯对话 / 代码阅读 / 架构讨论 | ✅ 直接回答 |
-| 琐碎修改（typo/注释/格式/日志） | ✅ 直接执行 |
-
-### §2.1 Pre-flight（涉及业务变更时触发）
-
-1. 扫描 `roadmap.json` + `tasks/<ID>_*/` 目录，匹配用户意图对应的任务。
-2. 按下表确定应加载的协议：
-
-| 检查结果 | 加载协议 | 确认方式 |
-|:---|:---|:---|
-| roadmap 无匹配任务 | `scope.md` | 告知"我来帮你梳理需求"后直接开始 |
-| 有任务·无 spec.md | `plan.md` | 告知"该任务还没规划，我来做"后直接开始 |
-| 有 spec+plan·status=active | `code.md` | 直接开始（IDE 原生 plan mode 接管节奏） |
-| status=done·用户要修改 | `edit.md` | 告知"我先更新文档再改代码"后开始 |
-| 用户描述了异常行为 | `fix.md` | 直接开始诊断 |
-| 影响 >1 个任务或全局资产 | `revise.md` | 先输出影响评估，等确认 |
-
-3. 加载协议后按 §1 的 **Protocol Load Gate** 执行（读全文 → override → step_1）。
-
-### §2.2 链条衔接
-
-各协议 Signoff 的 Next Steps 已指向下一个协议。AI 须：
-- 主动提示下一步（"spec 写好了，要开始实现吗？"）
-- 用户确认后，直接加载下一个协议继续
-
-| 衔接 | 串联方式 |
-|:---|:---|
-| scope → plan | 可连续执行（scope 完成后主动询问"要 plan 第一个任务吗？"） |
-| plan → code | **须等用户确认**（spec 是最重要的 checkpoint） |
-| code → audit | 协议内置（code.md step_5 已有 silent audit） |
-
-> ⛔ **禁**: 在用户未确认时自动从 plan 串联到 code。
-
-### §2.3 IDE 协作
-
-利用 IDE 原生能力（plan mode / agent mode / checkpoint）驱动执行节奏。
-协议定义"做什么、检查什么"，不对抗 IDE 的规划/执行能力。
-
-### §2.4 未纳管代码
-
-修改对象未在 `map.json` 中注册、无对应 Task → **STOP & ASK**，提示用户通过 `/archi.inherit` 或 `/archi.scope` 纳管。

package/dist/templates/zh/rules/03_data_governance.md

@@ -1,106 +0,0 @@
----
-description: JSON 数据文件的 AI 协作治理规则。定义全局数据文件的读写规范、更新时机与格式约束。
-globs: "**/*.json"
-applyTo: "**/*.json"
-alwaysApply: true
----
-
-# Data Governance Protocol
-
-> **Role**: 数据管家。确保全局 JSON 数据文件的一致性、完整性与可追溯性。
-
-## 1. 数据文件清单
-
-| 文件 | 读取时机 | 写入时机 |
-|:---|:---|:---|
-| `roadmap.json` | plan/code 开始时 | start 创建; AI 编辑或 `npx archi task` 更新 |
-| `map.json` | 触碰代码时 (via context_glue) | plan Step 3; inherit Step 3.6; /archi.map |
-| `dictionary.json` | 生成变量名/命名时 | plan Step 3; code/fix 后 step_5 自动追加 |
-| `design_tokens.json`（仅ui） | 生成 UI 代码时 | start 创建; 设计变更时更新 |
-| `data_snapshot.json`（仅data） | plan 设计/code 实现时 | Plan 设计 Schema; Code 同步变更 |
-| `error_codes.json` | 编写错误处理时 | plan Step 3; code/fix 后 step_5 自动追加 |
-| `api_snapshot.json`（仅api） | 实现/对接端点时 | plan Step 3 注册; Code 同步 |
-| `env_registry.json`（仅api） | 引入新配置项时 | Code 引入新 env var 后立即追加 |
-| `command_api.json`（仅cli） | 实现/修改命令时 | plan Step 3 注册; Code 同步 |
-| `public_api.json`（仅lib） | 新增/修改导出时 | plan Step 3 注册; Code 同步 |
-
----
-
-## 2. 通用规则
-
-### 2.1 格式约束
-
-- **JSON Only**: `.json` 是唯一真理源。`.md` 视图由 `npx archi render` 生成，禁直接编辑。
-- **Schema Stability**:
-  - **Tier 1 (严格)**: `roadmap.json`, `plan.json` — CLI 直接依赖，Zod Schema 校验，禁随意变更。
-  - **Tier 2 (宽松)**: 其余文件仅校验顶层 key。**所有 Tier 2 文件均可自行扩展字段（新 key / 新数组属性），无需改 CLI。**
-- **Valid JSON**: 无尾逗号、无注释。
-
-### 2.2 读写纪律
-
-| 场景 | 规则 |
-|:---|:---|
-| 查阅数据 | 读 `.json`，禁读 `.md` 视图（可能过期） |
-| 更新 Roadmap 状态 | 优先 `npx archi task <ID> --status <s>`; 批量时可直接编辑 JSON |
-| 更新其他数据 | AI 直接编辑 `.json` |
-| 更新后 | 运行 `npx archi render` 重新生成 `.md` 视图 |
-
----
-
-## 3. 文件专项规则
-
-### `roadmap.json`
-
-- **结构**: `phases[] → tasks[]`，每个 task 须有 `id`, `title`, `status`, `deps`。
-- **Status 值**: `pending` | `active` | `done` | `blocked`。
-- **依赖完整性**: `deps` 中引用的 ID 须存在于 tasks 中。
-- **Slug 规则**: `slug` 用于 tasks 文件夹命名，格式为 `Snake_Case`。
-
-### `map.json`
-
-- **Directory Mapping**: 须反映真实物理文件树。
-- **Logical Topology**: 须注册每个 Task Module 的职责。
-- **Feature Relations**: `featureRelations` 记录聚合型 Task 与来源的联动关系，由 AI 在 plan/inherit 时写入。
-- **自我校正**: 代码引用违反拓扑层级关系时，须报错并停止。
-
-### `dictionary.json`
-
-- **命名权威**: `entities[].codeName` 是最高法律；禁用 `forbiddenSynonyms` 中的词。
-- **Boundary**: 仅注册项目业务域；Architext 框架概念禁注册。
-- verbs 保持全项目动词一致；utilities 须注册并用已注册工具替代原始 API。
-- 仅ui项目: components 创建前须搜索复用。
-
-### `design_tokens.json`（仅ui项目）
-
-- **Token Only**: 样式严格使用 Token；禁硬编码 Hex/px/rem。
-- **Dark Mode**: 须同时定义 `light` 和 `dark` 值。
-
-### `data_snapshot.json`（仅data项目）
-
-- **结构**: `models[]`（名称/字段/类型/约束）+ `relationships[]`（1:1/1:N/M:N/self-ref）。
-- **Design First**: Plan 须定义模型结构，精确到字段名与类型，禁写 "TBD"。
-- **Sync Back**: Code 完成后须将实际变更同步回此文件。
-
-### `error_codes.json`
-
-- **Boundary**: 仅注册项目业务域错误；框架基础设施错误禁注册。
-- **Code Format**: `ERR_[MODULE]_[REASON]`。
-- **Design Before Code**: 编写错误处理前须先注册，含 `message` 和 `recovery`。
-
-### 条件性文件专项
-
-| 文件 | 核心规则 |
-|:---|:---|
-| `api_snapshot.json`（仅api） | endpoints[] 注册; Register First 禁实现未登记端点; owner 标注 Task ID |
-| `env_registry.json`（仅api） | 引入即注册; required/example 必填 |
-| `command_api.json`（仅cli） | 修改即同步; owner 标注 Task ID |
-| `public_api.json`（仅lib） | stable 变更须走 /archi.edit; 完整 TS 签名; owner 标注 Task ID |
-
----
-
-## 4. Plan JSON (`plan.json`)
-
-- **位置**: `tasks/<ID>_<Slug>/plan.json`
-- **Checkbox 更新**: AI 在 `/archi.code` 中完成步骤后直接将 `done` 设为 `true`。
-- **追加规则**: `/archi.edit` 追加新 Phase 时保留已完成历史。
-- **验证**: 完成后运行 `npx archi plan <ID>` 验证完成度。

package/dist/templates/zh/rules/99_context_glue.md

@@ -1,53 +0,0 @@
----
-description: Context Navigation & Document Indexing. Bridges source code to documentation using the Map registry. Essential for locating specs and plans.
-globs: **/*
-applyTo: **/*
-alwaysApply: true
----
-
-# Context Glue Protocol
-
-> **Role**: 上下文导航仪。防止 AI 失忆，通过查阅地图 (Map Look-up) 确定代码对应的业务文档。
-
-## 1. Context Discovery
-
-读取或编辑代码文件时，须执行以下寻址步骤:
-
-**Step 1: Check Global Map**
-- 读取 `[[__DOCS_DIR__]]/global/map.json`。
-- 在 `directoryMapping` / `logicalTopology` 中查找当前文件所属模块。
-- 加载该模块注册的 Docs Link (Spec/UI/Plan)。
-
-**Step 2: Check Explicit Context**
-- 场景: 新创建的文件或 Map 尚未更新。
-- 检查用户 Prompt 中是否显式指定了文档路径，如有则须加载。
-
-**Step 3: Fallback**
-- Map 中未注册且用户未指定 → **STOP & ASK**。
-- 提示: "未找到当前代码对应的 Spec 文档。请告知路径，或运行 `/archi.map` 更新架构地图。"
-
----
-
-## 2. Mandatory Loading Rules
-
-| 代码类型 | 必读上下文 | 真理来源 |
-|:---|:---|:---|
-| **Business Logic** (Tasks/Entities) | Spec Document | `[[__DOCS_DIR__]]/global/map.json` → Module Entry |
-| **UI Components** (Pages/Widgets)（仅ui项目） | UI Document + `[[__DOCS_DIR__]]/global/design_tokens.json` | `[[__DOCS_DIR__]]/global/map.json` + Global Rules |
-| **Data Schema** (ORM/SQL/Models)（仅data项目） | Data Snapshot | `[[__DOCS_DIR__]]/global/data_snapshot.json` |
-| **Config / Infra** (Package.json...) | Tech Stack | `02_tech_stack.md` |
-
----
-
-## 3. Anti-Hallucination
-
-- 代码是文档的下游产物。
-- 禁在未读取 Spec 的情况下凭变量名猜测业务逻辑。
-- 发现代码与文档不符时: 不擅自修复文档或代码，须暂停并报告不一致性。
-
----
-
-## 4. Maintenance Hook
-
-- **Trigger**: 创建新文件或新模块时。
-- **Action**: 须自动更新 `map.json`，建立代码路径与文档路径的映射；映射关系不明确时才询问用户确认。