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-TW/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-TW
+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-TW/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-TW
+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-TW/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-TW
+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-TW/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-TW/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-TW
+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]