npm - universal-dev-standards - Versions diffs - 3.5.1-beta.1 → 3.5.1-beta.11 - Mend

universal-dev-standards 3.5.1-beta.1 → 3.5.1-beta.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (433) hide show

package/bundled/locales/zh-CN/ai/standards/commit-message.ai.yaml ADDED Viewed

@@ -0,0 +1,175 @@
+# 提交消息标准 - AI 优化版
+# 来源: core/commit-message-guide.md
+id: commit-message
+meta:
+  version: "1.2.3"
+  updated: "2025-12-30"
+  source: core/commit-message-guide.md
+  description: Conventional Commits 格式规范
+  language: zh-CN
+format:
+  template: |
+    <type>(<scope>): <subject>
+    <body>
+    <footer>
+  components:
+    - name: type
+      required: true
+      description: 变更类型
+    - name: scope
+      required: false
+      description: 影響的模組/元件
+    - name: subject
+      required: true
+      description: 簡短描述（最多 72 字元）
+    - name: body
+      required: false
+      description: 详细说明
+    - name: footer
+      required: false
+      description: Issue 參考、破壞性变更
+decision:
+  question: "你的团队組成是什麼？"
+  matrix:
+    - answer: "國际或混合团队"
+      select: english
+    - answer: "本地团队（台灣）"
+      select: traditional-chinese
+    - answer: "混合但以本地为主"
+      select: bilingual
+options:
+  commit_language:
+    default: english
+    choices:
+      - id: english
+        file: options/commit-message/english.ai.yaml
+      - id: traditional-chinese
+        file: options/commit-message/traditional-chinese.ai.yaml
+      - id: bilingual
+        file: options/commit-message/bilingual.ai.yaml
+types:
+  - type: feat
+    description: 新功能
+    bump: minor
+  - type: fix
+    description: 错误修正
+    bump: patch
+  - type: refactor
+    description: 程序码重構
+    bump: none
+  - type: docs
+    description: 文件更新
+    bump: none
+  - type: style
+    description: 格式調整（不影響邏辑）
+    bump: none
+  - type: test
+    description: 测试相关
+    bump: none
+  - type: perf
+    description: 效能改善
+    bump: patch
+  - type: build
+    description: 建置系统
+    bump: none
+  - type: ci
+    description: CI/CD 变更
+    bump: none
+  - type: chore
+    description: 維護任务
+    bump: none
+  - type: revert
+    description: 还原提交
+    bump: patch
+  - type: security
+    description: 安全修正
+    bump: patch
+rules:
+  - id: choose-language
+    trigger: 開始项目时
+    instruction: 选择一种 commit 消息语言并记录在 CONTRIBUTING.md
+    priority: required
+  - id: consistent-language
+    trigger: 撰写 commit 消息时
+    instruction: 在所有 commit 中使用一致的语言
+    priority: required
+  - id: subject-max-length
+    trigger: 撰写 commit 主旨时
+    instruction: 主旨行保持在 72 字元以內
+    validator: "^.{1,72}$"
+    priority: required
+  - id: scope-lowercase
+    trigger: 指定 scope 时
+    instruction: scope 使用小写（auth，而非 Auth）
+    validator: "^[a-z][a-z0-9-]*$"
+    priority: required
+  - id: imperative-mood
+    trigger: 撰写 commit 主旨时
+    instruction: 使用祈使語氣（add、fix，而非 added、fixed）
+    priority: required
+    examples:
+      good:
+        - "feat(auth): add OAuth2 login"
+        - "fix(api): handle null response"
+      bad:
+        - "feat(auth): added OAuth2 login"
+        - "fix(api): handles null response"
+  - id: no-mixed-changes
+    trigger: 提交程序码时
+    instruction: 每个 commit 只包含一个邏辑变更；避免混合不相关的变更
+    priority: required
+  - id: reference-issues
+    trigger: 修復 bug 或实作功能时
+    instruction: 在 footer 中參考 issue 编号
+    priority: recommended
+    examples:
+      good:
+        - "Closes #123"
+        - "Fixes #456"
+        - "Refs #789"
+examples:
+  simple: "feat(auth): Add OAuth2 login support"
+  with_scope: "fix(api): Resolve null pointer in user service"
+  breaking: |
+    feat(api)!: Change response format to JSON
+    BREAKING CHANGE: API 响应格式從 XML 改为 JSON
+    迁移指南：
+    1. 更新 API 客户端移除 .data 包裝
+    2. 使用 created_at 取代 createdAt
+quick_reference:
+  language_selection:
+    columns: [因素, 英文, 繁体中文, 雙語]
+    rows:
+      - [团队組成, 國际/混合, 本地（台灣）, 混合但以本地为主]
+      - [工具相容性, 最佳, 有限, 良好]
+      - [Changelog 自动化, 完整支援, 需自订设置, 支援]
+      - [開源项目, 推荐, 不推荐, 不錯的选择]
+  commit_types:
+    columns: [类型, 用途, 版本影響]
+    rows:
+      - [feat, 新功能, minor]
+      - [fix, 错误修正, patch]
+      - [refactor, 重構, 無]
+      - [docs, 文件, 無]
+      - [test, 测试, 無]
+      - [perf, 效能, patch]
+      - [security, 安全, patch]

package/bundled/locales/zh-CN/ai/standards/documentation-structure.ai.yaml ADDED Viewed

@@ -0,0 +1,124 @@
+# 文件结构标准 - AI 优化版
+# 来源: core/documentation-structure.md
+id: documentation-structure
+meta:
+  version: "1.3.0"
+  updated: "2025-12-30"
+  source: core/documentation-structure.md
+  description: 软体项目的一致文件结构规范
+  language: zh-CN
+options:
+  documentation_style:
+    description: 选择文件编写方式
+    multiSelect: true
+    choices:
+      - id: markdown-docs
+        file: options/documentation/markdown-docs.ai.yaml
+        best_for: 開源项目、开发者导向文件
+      - id: api-docs
+        file: options/documentation/api-docs.ai.yaml
+        best_for: REST/GraphQL API 文件
+      - id: wiki-style
+        file: options/documentation/wiki-style.ai.yaml
+        best_for: 大型团队、內部知識庫
+structure:
+  root:
+    - file: README.md
+      required: true
+      naming: 大写
+      purpose: 项目概覽
+    - file: CONTRIBUTING.md
+      required: false
+      naming: 大写
+      purpose: 貢獻指南
+    - file: CHANGELOG.md
+      required: false
+      naming: 大写
+      purpose: 版本历史
+    - file: LICENSE
+      required: true
+      naming: 大写（無副檔名）
+      purpose: 授权文件
+  docs:
+    naming: 小写短橫线
+    files:
+      - index.md（文件索引）
+      - getting-started.md（快速開始）
+      - architecture.md（系统架構）
+      - api-reference.md（API 文件）
+      - deployment.md（部署指南）
+      - troubleshooting.md（常見問題）
+    subdirectories:
+      - name: flows/
+        purpose: 流程文件
+        index_required: "當 >5 个流程时"
+      - name: ADR/
+        purpose: 架構决策记录
+        naming: "NNN-title.md"
+      - name: diagrams/
+        purpose: 架構图表
+        formats: [".mmd", ".puml", ".drawio"]
+rules:
+  - id: root-uppercase
+    trigger: 建立根目录文件时
+    instruction: 根目录文件使用大写（README、CONTRIBUTING、CHANGELOG）
+    priority: required
+  - id: docs-lowercase-kebab
+    trigger: 建立 docs/ 文件时
+    instruction: docs/ 內所有文件使用小写短橫线
+    validator: "^[a-z][a-z0-9-]*\\.md$"
+    priority: required
+    examples:
+      good:
+        - getting-started.md
+        - api-reference.md
+      bad:
+        - GettingStarted.md
+        - API_Reference.md
+        - "User Guide.md"
+  - id: readme-required
+    trigger: 建立新项目时
+    instruction: 每个项目都必須有 README.md
+    priority: required
+  - id: flow-index
+    trigger: 建立流程文件时
+    instruction: 當流程超過 5 个时，建立 flows/README.md
+    priority: required
+  - id: adr-numbering
+    trigger: 建立 ADR 时
+    instruction: 使用格式 NNN-title.md（例如：001-use-postgres.md）
+    validator: "^\\d{3}-[a-z][a-z0-9-]+\\.md$"
+    priority: required
+quick_reference:
+  root_files:
+    columns: [文件, 命名, 用途]
+    rows:
+      - [README.md, 大写, 项目概覽]
+      - [CONTRIBUTING.md, 大写, 貢獻指南]
+      - [CHANGELOG.md, 大写, 版本历史]
+      - [LICENSE, 大写（無副檔名）, 授权文件]
+      - [SECURITY.md, 大写, 安全公告]
+  docs_structure:
+    columns: [目录, 用途, 命名]
+    rows:
+      - [docs/, 主要文件, 小写短橫线]
+      - [docs/flows/, 流程文件, "{module}-flow.md"]
+      - [docs/ADR/, 架構决策, "NNN-title.md"]
+      - [docs/diagrams/, 架構图表, 描述性名称]

package/bundled/locales/zh-CN/ai/standards/documentation-writing-standards.ai.yaml ADDED Viewed

@@ -0,0 +1,190 @@
+# 文件撰写标准 - AI 优化版
+# 来源: core/documentation-writing-standards.md
+id: documentation-writing-standards
+meta:
+  version: "1.0.1"
+  updated: "2025-12-30"
+  source: core/documentation-writing-standards.md
+  description: 基于项目类型的文件需求
+  language: zh-CN
+project_types:
+  new_project:
+    description: 從零開始建立软体
+    required:
+      - README.md
+      - ARCHITECTURE.md
+      - DEPLOYMENT.md
+      - CHANGELOG.md
+    recommended:
+      - API.md（如有对外 API）
+      - DATABASE.md（如使用数据庫）
+      - ADR/（记录重要决策）
+  refactoring:
+    description: 改善既有系统而不改变外部行为
+    required:
+      - README.md
+      - ARCHITECTURE.md
+      - API.md（如適用）
+      - DATABASE.md（如適用）
+      - DEPLOYMENT.md
+      - MIGRATION.md
+      - ADR/
+      - CHANGELOG.md
+    key_points:
+      - MIGRATION.md 必須包含回滾计画
+      - ADR 必須记录为何重構及为何选择此方法
+  migration:
+    description: 將系统迁移到另一个環境/平台
+    required:
+      - README.md
+      - ARCHITECTURE.md
+      - API.md
+      - DATABASE.md
+      - DEPLOYMENT.md
+      - MIGRATION.md
+      - ADR/
+      - CHANGELOG.md
+    key_points:
+      - MIGRATION.md 是核心文件
+      - 必須包含数据迁移验证
+      - 必須包含回滾计画
+      - 必須包含集成夥伴通知
+  maintenance:
+    description: 日常維護、bug 修正、小幅功能增強
+    required:
+      - README.md
+      - CHANGELOG.md
+    recommended:
+      - 根据变更範圍更新其他文件
+document_categories:
+  architecture:
+    file: ARCHITECTURE.md
+    required_sections:
+      - 系统概覽（目的、範圍、主要功能）
+      - 架構图（Mermaid 或 ASCII）
+      - 模組说明（職責、相依性）
+      - 技術棧（框架、语言、版本）
+      - 数据流（主要业务流程）
+    recommended_sections:
+      - 部署架構
+      - 设计决策（或連結到 ADR）
+  api:
+    file: API.md
+    required_sections:
+      - API 概覽（版本、基礎 URL、认证）
+      - 认证（Token 取得、過期）
+      - 端点列表
+      - 端点規格（请求/响应格式）
+      - 错误码參考
+    recommended_sections:
+      - 程序码範例
+      - 速率限制
+  database:
+    file: DATABASE.md
+    required_sections:
+      - 数据庫概覽（类型、版本、連线）
+      - ER 图
+      - 数据表列表
+      - 数据表規格（欄位定義）
+      - 索引文件
+      - 迁移脚本
+    recommended_sections:
+      - 备份策略
+  deployment:
+    file: DEPLOYMENT.md
+    required_sections:
+      - 環境需求
+      - 安裝步骤
+      - 设置
+      - 验证
+      - 故障排除
+    recommended_sections:
+      - 監控
+      - 擴展指南
+  migration:
+    file: MIGRATION.md
+    required_sections:
+      - 迁移概覽（目標、範圍、时程）
+      - 先决条件
+      - 迁移步骤
+      - 验证清单
+      - 回滾计画
+      - 向後相容性
+    recommended_sections:
+      - 集成夥伴通知
+  adr:
+    directory: docs/ADR/
+    naming: "NNN-kebab-case-title.md"
+    required_sections:
+      - 標題
+      - 状态（proposed/accepted/deprecated/superseded）
+      - 背景
+      - 决策
+      - 影響
+    recommended_sections:
+      - 考慮的替代方案
+rules:
+  - id: project-type-docs
+    trigger: 開始项目时
+    instruction: 識别项目类型并建立必要文件
+    priority: required
+  - id: sync-updates
+    trigger: 变更程序码时
+    instruction: 程序码变更时更新文件
+    priority: required
+  - id: version-marking
+    trigger: 建立文件时
+    instruction: 在頂部標记版本和更新日期
+    priority: required
+  - id: review-inclusion
+    trigger: 提交程序码审查时
+    instruction: 在程序码审查中包含文件变更
+    priority: required
+  - id: periodic-review
+    trigger: 每季
+    instruction: 审查文件是否過时
+    priority: recommended
+quality_standards:
+  format:
+    language: 英文
+    encoding: UTF-8
+    line_length: "≤120 字元"
+    diagrams: 優先使用 Mermaid，其次 ASCII Art
+    links: 內部連結使用相对路徑
+  review_checklist:
+    - 必要區段完整
+    - 無過时或不正确的信息
+    - 所有連結有效
+    - 範例可执行/正确
+    - 格式遵循标准
+quick_reference:
+  requirements_matrix:
+    columns: [文件, 新项目, 重構, 迁移, 維護]
+    rows:
+      - [README.md, 必要, 必要, 必要, 必要]
+      - [ARCHITECTURE.md, 必要, 必要, 必要, 建议]
+      - [API.md, 如適用, 必要, 必要, 建议]
+      - [DATABASE.md, 如適用, 必要, 必要, 建议]
+      - [DEPLOYMENT.md, 必要, 必要, 必要, 建议]
+      - [MIGRATION.md, 不需要, 必要, 必要, 不需要]
+      - [ADR/, 建议, 必要, 必要, 如適用]
+      - [CHANGELOG.md, 必要, 必要, 必要, 必要]

package/bundled/locales/zh-CN/ai/standards/error-codes.ai.yaml ADDED Viewed

@@ -0,0 +1,139 @@
+# 错误码标准 - AI 优化版
+# 来源: core/error-code-standards.md
+id: error-codes
+meta:
+  version: "1.1.0"
+  updated: "2026-01-05"
+  source: core/error-code-standards.md
+  description: 错误码格式、类别与管理
+format:
+  pattern: "<前綴>_<类别>_<编号>"
+  example: "AUTH_VAL_001"
+  components:
+    prefix: "应用程序/服务識别码 (AUTH, PAY, USR)"
+    category: "错误类别 (VAL, SYS, BIZ)"
+    number: "唯一數字識别码 (001, 100, 404)"
+categories:
+  VAL:
+    name: 验证
+    description: 用戶端输入验证失败
+    http_status: 400
+    ranges:
+      001-099: 欄位验证
+      100-199: 格式验证
+      200-299: 限制验证
+  BIZ:
+    name: 业务邏辑
+    description: 业务規則違反
+    http_status: 422
+    ranges:
+      001-099: 状态違反
+      100-199: 規則違反
+      200-299: 限制違反
+  SYS:
+    name: 系统
+    description: 內部系统故障
+    http_status: 500
+    ranges:
+      001-099: 內部错误
+      100-199: 資源错误
+      500-599: HTTP 对应错误
+  NET:
+    name: 网络
+    description: 通訊和連线問題
+    http_status: 502-504
+    ranges:
+      001-099: 連线错误
+      100-199: 協議错误
+      400-599: HTTP 对应错误
+  AUTH:
+    name: 身份验证/授权
+    description: 安全相关错误
+    http_status: 401/403
+    ranges:
+      001-099: 身份验证 (401)
+      100-199: 授权 (403)
+      200-299: 令牌/工作阶段 (401)
+error_structure:
+  required_fields:
+    - code
+    - message
+  recommended_fields:
+    - userMessage
+    - userMessageKey
+    - field
+    - requestId
+    - timestamp
+rules:
+  - id: use-format
+    trigger: 建立错误码
+    instruction: "使用 PREFIX_CATEGORY_NUMBER 格式: AUTH_VAL_001"
+    priority: required
+  - id: category-match
+    trigger: 分类错误
+    instruction: |
+      对应错误到类别：
+      - VAL: 输入验证失败
+      - BIZ: 业务規則違反
+      - SYS: 系统/內部错误
+      - NET: 网络/連线問題
+      - AUTH: 安全相关错误
+    priority: required
+  - id: http-mapping
+    trigger: 回传错误响应
+    instruction: |
+      对应到 HTTP 状态：
+      - VAL → 400
+      - BIZ → 422
+      - AUTH → 401/403
+      - SYS → 500
+      - NET → 502/503/504
+    priority: required
+  - id: unique-codes
+    trigger: 定義新错误
+    instruction: 确保错误码在应用程序中唯一
+    priority: required
+  - id: localize-messages
+    trigger: 定義错误消息
+    instruction: 使用 i18n 金鑰处理面向使用者的消息
+    priority: recommended
+  - id: document-errors
+    trigger: 新增新错误码
+    instruction: 记录原因、解决方案和範例
+    priority: required
+  - id: centralize-registry
+    trigger: 管理错误码
+    instruction: 維護集中式错误码登录
+    priority: recommended
+quick_reference:
+  categories:
+    columns: [代码, 类别, HTTP, 用途]
+    rows:
+      - [VAL, 验证, 400, 输入验证]
+      - [BIZ, 业务, 422, 业务規則]
+      - [AUTH, 验证, 401/403, 安全]
+      - [SYS, 系统, 500, 內部错误]
+      - [NET, 网络, 502/503, 連线]
+  format:
+    columns: [組成, 描述, 範例]
+    rows:
+      - [前綴, 服务識别码, AUTH/PAY/USR]
+      - [类别, 错误类型, VAL/BIZ/SYS]
+      - [编号, 唯一 ID, 001/100/404]

package/bundled/locales/zh-CN/ai/standards/git-workflow.ai.yaml ADDED Viewed

@@ -0,0 +1,95 @@
+# Git 工作流程标准 - AI 优化版
+# 来源: core/git-workflow.md
+id: git-workflow
+meta:
+  version: "1.2.1"
+  updated: "2025-12-26"
+  source: core/git-workflow.md
+  description: Git 分支策略与工作流程
+  language: zh-CN
+decision:
+  question: "您多久部署一次到正式環境？"
+  matrix:
+    - answer: "每天多次"
+      select: trunk-based
+    - answer: "每周或雙周"
+      select: github-flow
+    - answer: "每月或更長"
+      select: gitflow
+options:
+  workflow:
+    default: github-flow
+    choices:
+      - id: gitflow
+        file: options/git-workflow/gitflow.ai.yaml
+      - id: github-flow
+        file: options/git-workflow/github-flow.ai.yaml
+      - id: trunk-based
+        file: options/git-workflow/trunk-based.ai.yaml
+  merge_strategy:
+    default: squash
+    choices:
+      - id: merge-commit
+        file: options/git-workflow/merge-commit.ai.yaml
+      - id: squash
+        file: options/git-workflow/squash-merge.ai.yaml
+      - id: rebase-ff
+        file: options/git-workflow/rebase-ff.ai.yaml
+rules:
+  - id: branch-naming
+    trigger: 建立新分支时
+    instruction: 使用格式 <type>/<description>
+    validator: "^(feature|fix|hotfix|refactor|docs|test|chore|release)/[a-z0-9-]+$"
+    examples:
+      good:
+        - feature/user-authentication
+        - fix/memory-leak
+        - hotfix/security-patch
+      bad:
+        - feature/123
+        - Fix-Bug
+        - myFeature
+  - id: branch-types
+    trigger: 选择分支类型时
+    instruction: 根据变更目的选择合適的类型前綴
+    priority: required
+branch_types:
+  - type: feature
+    purpose: 新功能开发
+    example: feature/oauth-login
+  - type: fix
+    purpose: 非緊急错误修正
+    example: fix/null-pointer
+  - type: hotfix
+    purpose: 緊急正式環境修正
+    example: hotfix/security-patch
+  - type: refactor
+    purpose: 程序码重構
+    example: refactor/extract-service
+  - type: docs
+    purpose: 文件变更
+    example: docs/api-reference
+  - type: test
+    purpose: 新增或修改测试
+    example: test/integration-tests
+  - type: chore
+    purpose: 維護任务
+    example: chore/update-deps
+  - type: release
+    purpose: 發布准备
+    example: release/v1.2.0
+quick_reference:
+  strategy_selection:
+    columns: [部署頻率, 建议策略]
+    rows:
+      - [每天多次, Trunk-Based]
+      - [每周到雙周, GitHub Flow]
+      - [每月或更長, GitFlow]