moai-adk 0.9.0__py3-none-any.whl → 0.15.1__py3-none-any.whl
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.
Potentially problematic release.
This version of moai-adk might be problematic. Click here for more details.
- moai_adk/cli/commands/init.py +14 -2
- moai_adk/cli/commands/update.py +214 -56
- moai_adk/core/issue_creator.py +2 -2
- moai_adk/core/project/detector.py +201 -12
- moai_adk/core/project/initializer.py +62 -1
- moai_adk/core/project/phase_executor.py +48 -6
- moai_adk/core/tags/ci_validator.py +34 -4
- moai_adk/core/tags/pre_commit_validator.py +40 -2
- moai_adk/core/tags/reporter.py +2 -3
- moai_adk/core/tags/validator.py +1 -1
- moai_adk/core/template_engine.py +20 -5
- moai_adk/templates/.claude/agents/alfred/backend-expert.md +319 -0
- moai_adk/templates/.claude/agents/alfred/devops-expert.md +464 -0
- moai_adk/templates/.claude/agents/alfred/doc-syncer.md +1 -1
- moai_adk/templates/.claude/agents/alfred/frontend-expert.md +357 -0
- moai_adk/templates/.claude/agents/alfred/git-manager.md +2 -2
- moai_adk/templates/.claude/agents/alfred/implementation-planner.md +76 -3
- moai_adk/templates/.claude/agents/alfred/project-manager.md +49 -10
- moai_adk/templates/.claude/agents/alfred/quality-gate.md +3 -3
- moai_adk/templates/.claude/agents/alfred/spec-builder.md +180 -41
- moai_adk/templates/.claude/agents/alfred/tag-agent.md +74 -0
- moai_adk/templates/.claude/agents/alfred/tdd-implementer.md +107 -5
- moai_adk/templates/.claude/agents/alfred/trust-checker.md +2 -2
- moai_adk/templates/.claude/agents/alfred/ui-ux-expert.md +571 -0
- moai_adk/templates/.claude/commands/alfred/0-project.md +928 -263
- moai_adk/templates/.claude/commands/alfred/1-plan.md +220 -68
- moai_adk/templates/.claude/commands/alfred/2-run.md +299 -51
- moai_adk/templates/.claude/commands/alfred/3-sync.md +452 -51
- moai_adk/templates/.claude/commands/alfred/9-feedback.md +1 -1
- moai_adk/templates/.claude/hooks/alfred/core/project.py +25 -27
- moai_adk/templates/.claude/hooks/alfred/core/timeout.py +136 -0
- moai_adk/templates/.claude/hooks/alfred/core/ttl_cache.py +108 -0
- moai_adk/templates/.claude/hooks/alfred/core/version_cache.py +4 -4
- moai_adk/templates/.claude/hooks/alfred/handlers/__init__.py +29 -0
- moai_adk/templates/.claude/hooks/alfred/post_tool__log_changes.py +11 -19
- moai_adk/templates/.claude/hooks/alfred/pre_tool__auto_checkpoint.py +11 -19
- moai_adk/templates/.claude/hooks/alfred/session_end__cleanup.py +11 -19
- moai_adk/templates/.claude/hooks/alfred/session_start__show_project_info.py +10 -18
- moai_adk/templates/.claude/hooks/alfred/shared/core/__init__.py +2 -2
- moai_adk/templates/.claude/hooks/alfred/shared/core/checkpoint.py +3 -3
- moai_adk/templates/.claude/hooks/alfred/shared/core/context.py +5 -5
- moai_adk/templates/.claude/hooks/alfred/shared/core/project.py +40 -41
- moai_adk/templates/.claude/hooks/alfred/shared/core/tags.py +55 -23
- moai_adk/templates/.claude/hooks/alfred/shared/core/version_cache.py +4 -4
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/notification.py +132 -3
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/session.py +9 -10
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/tool.py +3 -6
- moai_adk/templates/.claude/hooks/alfred/shared/handlers/user.py +19 -0
- moai_adk/templates/.claude/hooks/alfred/user_prompt__jit_load_docs.py +14 -22
- moai_adk/templates/.claude/hooks/alfred/utils/__init__.py +1 -0
- moai_adk/templates/.claude/hooks/alfred/utils/timeout.py +161 -0
- moai_adk/templates/.claude/settings.json +5 -5
- moai_adk/templates/.claude/skills/moai-alfred-agent-guide/SKILL.md +70 -0
- moai_adk/templates/.claude/skills/moai-alfred-agent-guide/examples.md +62 -0
- moai_adk/templates/{.moai/memory/CLAUDE-AGENTS-GUIDE.md → .claude/skills/moai-alfred-agent-guide/reference.md} +34 -0
- moai_adk/templates/.claude/skills/moai-alfred-config-schema/SKILL.md +56 -0
- moai_adk/templates/.claude/skills/moai-alfred-config-schema/examples.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-config-schema/reference.md +444 -0
- moai_adk/templates/.claude/skills/moai-alfred-context-budget/SKILL.md +62 -0
- moai_adk/templates/.claude/skills/moai-alfred-context-budget/examples.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-context-budget/reference.md +405 -0
- moai_adk/templates/.claude/skills/moai-alfred-dev-guide/SKILL.md +51 -0
- moai_adk/templates/.claude/skills/moai-alfred-dev-guide/examples.md +355 -0
- moai_adk/templates/.claude/skills/moai-alfred-dev-guide/reference.md +239 -0
- moai_adk/templates/.claude/skills/moai-alfred-expertise-detection/SKILL.md +323 -0
- moai_adk/templates/.claude/skills/moai-alfred-expertise-detection/examples.md +286 -0
- moai_adk/templates/.claude/skills/moai-alfred-expertise-detection/reference.md +126 -0
- moai_adk/templates/.claude/skills/moai-alfred-gitflow-policy/SKILL.md +74 -0
- moai_adk/templates/.claude/skills/moai-alfred-gitflow-policy/examples.md +4 -0
- moai_adk/templates/.claude/skills/moai-alfred-gitflow-policy/reference.md +269 -0
- moai_adk/templates/.claude/skills/moai-alfred-issue-labels/SKILL.md +19 -0
- moai_adk/templates/.claude/skills/moai-alfred-issue-labels/examples.md +4 -0
- moai_adk/templates/.claude/skills/moai-alfred-persona-roles/SKILL.md +198 -0
- moai_adk/templates/.claude/skills/moai-alfred-persona-roles/examples.md +431 -0
- moai_adk/templates/.claude/skills/moai-alfred-persona-roles/reference.md +141 -0
- moai_adk/templates/.claude/skills/moai-alfred-practices/SKILL.md +89 -0
- moai_adk/templates/.claude/skills/moai-alfred-practices/examples.md +122 -0
- moai_adk/templates/.claude/skills/moai-alfred-proactive-suggestions/SKILL.md +508 -0
- moai_adk/templates/.claude/skills/moai-alfred-proactive-suggestions/examples.md +481 -0
- moai_adk/templates/.claude/skills/moai-alfred-proactive-suggestions/reference.md +100 -0
- moai_adk/templates/.claude/skills/moai-alfred-reporting/SKILL.md +273 -0
- moai_adk/templates/.claude/skills/moai-alfred-rules/SKILL.md +77 -0
- moai_adk/templates/.claude/skills/moai-alfred-rules/examples.md +265 -0
- moai_adk/templates/.claude/skills/moai-alfred-session-state/SKILL.md +19 -0
- moai_adk/templates/.claude/skills/moai-alfred-session-state/examples.md +4 -0
- moai_adk/templates/.claude/skills/moai-alfred-session-state/reference.md +84 -0
- moai_adk/templates/.claude/skills/{moai-spec-authoring → moai-alfred-spec-authoring}/SKILL.md +5 -5
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-extended/SKILL.md +115 -0
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-extended/examples.md +4 -0
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-extended/reference.md +348 -0
- moai_adk/templates/.claude/skills/moai-alfred-todowrite-pattern/SKILL.md +19 -0
- moai_adk/templates/.claude/skills/moai-alfred-todowrite-pattern/examples.md +4 -0
- moai_adk/templates/.claude/skills/moai-alfred-todowrite-pattern/reference.md +211 -0
- moai_adk/templates/.claude/skills/moai-alfred-workflow/SKILL.md +288 -0
- moai_adk/templates/.claude/skills/moai-cc-skill-descriptions/SKILL.md +19 -0
- moai_adk/templates/.claude/skills/moai-cc-skill-descriptions/examples.md +4 -0
- moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/SKILL.md +3 -3
- moai_adk/templates/.claude/skills/moai-design-systems/SKILL.md +802 -0
- moai_adk/templates/.claude/skills/moai-design-systems/examples.md +1238 -0
- moai_adk/templates/.claude/skills/moai-design-systems/reference.md +673 -0
- moai_adk/templates/.claude/skills/moai-domain-frontend/SKILL.md +17 -13
- moai_adk/templates/.claude/skills/moai-lang-go/SKILL.md +15 -12
- moai_adk/templates/.claude/skills/moai-lang-java/SKILL.md +14 -12
- moai_adk/templates/.claude/skills/moai-lang-php/SKILL.md +14 -11
- moai_adk/templates/.claude/skills/moai-lang-python/SKILL.md +10 -8
- moai_adk/templates/.claude/skills/moai-lang-rust/SKILL.md +15 -12
- moai_adk/templates/.claude/skills/moai-lang-scala/SKILL.md +13 -11
- moai_adk/templates/.claude/skills/moai-lang-typescript/SKILL.md +16 -10
- moai_adk/templates/.claude/skills/moai-project-documentation.md +622 -0
- moai_adk/templates/.git-hooks/pre-push +143 -0
- moai_adk/templates/.github/workflows/c-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/cpp-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/csharp-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/dart-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/go-tag-validation.yml +130 -0
- moai_adk/templates/.github/workflows/java-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/javascript-tag-validation.yml +135 -0
- moai_adk/templates/.github/workflows/kotlin-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/moai-gitflow.yml +182 -25
- moai_adk/templates/.github/workflows/moai-release-pipeline.yml +35 -29
- moai_adk/templates/.github/workflows/php-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/python-tag-validation.yml +118 -0
- moai_adk/templates/.github/workflows/release.yml +76 -7
- moai_adk/templates/.github/workflows/ruby-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/rust-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/shell-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/spec-issue-sync.yml +208 -41
- moai_adk/templates/.github/workflows/swift-tag-validation.yml +11 -0
- moai_adk/templates/.github/workflows/tag-report.yml +269 -0
- moai_adk/templates/.github/workflows/tag-validation.yml +186 -0
- moai_adk/templates/.github/workflows/typescript-tag-validation.yml +154 -0
- moai_adk/templates/.moai/config.json +3 -1
- moai_adk/templates/CLAUDE.md +940 -45
- moai_adk/templates/workflows/go-tag-validation.yml +30 -0
- moai_adk/templates/workflows/javascript-tag-validation.yml +41 -0
- moai_adk/templates/workflows/python-tag-validation.yml +42 -0
- moai_adk/templates/workflows/typescript-tag-validation.yml +31 -0
- moai_adk/utils/banner.py +5 -5
- {moai_adk-0.9.0.dist-info → moai_adk-0.15.1.dist-info}/METADATA +1253 -527
- {moai_adk-0.9.0.dist-info → moai_adk-0.15.1.dist-info}/RECORD +169 -109
- moai_adk/templates/.claude/hooks/alfred/alfred_hooks.py +0 -209
- moai_adk/templates/.claude/hooks/alfred/notification__handle_events.py +0 -102
- moai_adk/templates/.claude/hooks/alfred/stop__handle_interrupt.py +0 -102
- moai_adk/templates/.claude/hooks/alfred/subagent_stop__handle_subagent_end.py +0 -102
- moai_adk/templates/.claude/output-styles/alfred/agentic-coding.md +0 -640
- moai_adk/templates/.claude/output-styles/alfred/moai-adk-learning.md +0 -696
- moai_adk/templates/.claude/output-styles/alfred/study-with-alfred.md +0 -474
- moai_adk/templates/.github/ISSUE_TEMPLATE/spec.yml +0 -176
- moai_adk/templates/.github/PULL_REQUEST_TEMPLATE.md +0 -69
- moai_adk/templates/.moai/memory/DEVELOPMENT-GUIDE.md +0 -344
- moai_adk/templates/.moai/memory/SPEC-METADATA.md +0 -356
- moai_adk/templates/.moai/memory/gitflow-protection-policy.md +0 -330
- moai_adk/templates/.moai/project/product.md +0 -161
- moai_adk/templates/.moai/project/structure.md +0 -156
- moai_adk/templates/.moai/project/tech.md +0 -227
- moai_adk/templates/README.md +0 -256
- moai_adk/templates/__init__.py +0 -2
- /moai_adk/templates/{.moai/memory/ISSUE-LABEL-MAPPING.md → .claude/skills/moai-alfred-issue-labels/reference.md} +0 -0
- /moai_adk/templates/{.moai/memory/CLAUDE-PRACTICES.md → .claude/skills/moai-alfred-practices/reference.md} +0 -0
- /moai_adk/templates/{.moai/memory/CLAUDE-RULES.md → .claude/skills/moai-alfred-rules/reference.md} +0 -0
- /moai_adk/templates/.claude/skills/{moai-spec-authoring → moai-alfred-spec-authoring}/README.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-spec-authoring → moai-alfred-spec-authoring}/examples/validate-spec.sh +0 -0
- /moai_adk/templates/.claude/skills/{moai-spec-authoring → moai-alfred-spec-authoring}/examples.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-spec-authoring → moai-alfred-spec-authoring}/reference.md +0 -0
- /moai_adk/templates/{.moai/memory/SKILLS-DESCRIPTION-POLICY.md → .claude/skills/moai-cc-skill-descriptions/reference.md} +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/CHECKLIST.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/EXAMPLES.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/INTERACTIVE-DISCOVERY.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/METADATA.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/PARALLEL-ANALYSIS-REPORT.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/PYTHON-VERSION-MATRIX.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/SKILL-FACTORY-WORKFLOW.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/SKILL-UPDATE-ADVISOR.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/STEP-BY-STEP-GUIDE.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/STRUCTURE.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/WEB-RESEARCH.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/reference.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/scripts/generate-structure.sh +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/scripts/validate-skill.sh +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/templates/SKILL_TEMPLATE.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/templates/examples-template.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/templates/reference-template.md +0 -0
- /moai_adk/templates/.claude/skills/{moai-skill-factory → moai-cc-skill-factory}/templates/scripts-template.sh +0 -0
- {moai_adk-0.9.0.dist-info → moai_adk-0.15.1.dist-info}/WHEEL +0 -0
- {moai_adk-0.9.0.dist-info → moai_adk-0.15.1.dist-info}/entry_points.txt +0 -0
- {moai_adk-0.9.0.dist-info → moai_adk-0.15.1.dist-info}/licenses/LICENSE +0 -0
|
@@ -1,344 +0,0 @@
|
|
|
1
|
-
# {{PROJECT_NAME}} Development Guide
|
|
2
|
-
|
|
3
|
-
> "No spec, no code. No tests, no implementation."
|
|
4
|
-
|
|
5
|
-
This unified guardrail applies to every agent and developer who uses the MoAI-ADK universal development toolkit. The Python-based toolkit supports all major programming languages and enforces a SPEC-first TDD methodology with @TAG traceability. English is the default working language.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## SPEC-First TDD Workflow
|
|
10
|
-
|
|
11
|
-
### Core Development Loop (3 Steps)
|
|
12
|
-
|
|
13
|
-
1. **Write the SPEC** (`/alfred:1-plan`) → no code without a spec
|
|
14
|
-
2. **Implement with TDD** (`/alfred:2-run`) → no implementation without tests
|
|
15
|
-
3. **Sync Documentation** (`/alfred:3-sync`) → no completion without traceability
|
|
16
|
-
|
|
17
|
-
### On-Demand Support
|
|
18
|
-
|
|
19
|
-
- **Debugging**: summon `@agent-debug-helper` when failures occur
|
|
20
|
-
- **CLI Commands**: init, doctor, status, update, restore, help, version
|
|
21
|
-
- **System Diagnostics**: auto-detect language tooling and verify prerequisites
|
|
22
|
-
|
|
23
|
-
Every change must comply with the @TAG system, SPEC-derived requirements, and language-specific TDD practices.
|
|
24
|
-
|
|
25
|
-
### EARS Requirement Authoring
|
|
26
|
-
|
|
27
|
-
**EARS (Easy Approach to Requirements Syntax)** provides a disciplined method for writing requirements.
|
|
28
|
-
|
|
29
|
-
#### Five EARS Patterns
|
|
30
|
-
1. **Ubiquitous Requirements**: The system shall provide [capability].
|
|
31
|
-
2. **Event-driven Requirements**: WHEN [condition], the system shall [behaviour].
|
|
32
|
-
3. **State-driven Requirements**: WHILE [state], the system shall [behaviour].
|
|
33
|
-
4. **Optional Features**: WHERE [condition], the system may [behaviour].
|
|
34
|
-
5. **Constraints**: IF [condition], the system shall enforce [constraint].
|
|
35
|
-
|
|
36
|
-
#### Practical Example
|
|
37
|
-
```markdown
|
|
38
|
-
### Ubiquitous Requirements (Baseline)
|
|
39
|
-
- The system shall provide user authentication.
|
|
40
|
-
|
|
41
|
-
### Event-driven Requirements
|
|
42
|
-
- WHEN a user logs in with valid credentials, the system shall issue a JWT token.
|
|
43
|
-
- WHEN a token expires, the system shall return a 401 error.
|
|
44
|
-
|
|
45
|
-
### State-driven Requirements
|
|
46
|
-
- WHILE the user remains authenticated, the system shall allow access to protected resources.
|
|
47
|
-
|
|
48
|
-
### Optional Features
|
|
49
|
-
- WHERE a refresh token is present, the system may issue a new access token.
|
|
50
|
-
|
|
51
|
-
### Constraints
|
|
52
|
-
- IF an invalid token is supplied, the system shall deny access.
|
|
53
|
-
- Access tokens shall not exceed a 15-minute lifetime.
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## Context Engineering
|
|
59
|
-
|
|
60
|
-
MoAI-ADK follows Anthropic's principles from “Effective Context Engineering for AI Agents” to keep context lean and relevant.
|
|
61
|
-
|
|
62
|
-
### 1. JIT (Just-in-Time) Retrieval
|
|
63
|
-
|
|
64
|
-
**Principle**: Load documents only when needed to minimize initial context load.
|
|
65
|
-
|
|
66
|
-
**Alfred’s JIT Strategy**:
|
|
67
|
-
|
|
68
|
-
| Command | Required Load | Optional Load | Timing |
|
|
69
|
-
| ---------------- | ---------------- | -------------------------------- | ---------------------------------- |
|
|
70
|
-
| `/alfred:1-plan` | product.md | structure.md, tech.md | While discovering SPEC candidates |
|
|
71
|
-
| `/alfred:2-run` | SPEC-XXX/spec.md | development-guide.md | At the start of TDD implementation |
|
|
72
|
-
| `/alfred:3-sync` | sync-report.md | TAG chain validation (`rg` scan) | During documentation sync |
|
|
73
|
-
|
|
74
|
-
**Implementation Notes**:
|
|
75
|
-
- Alfred uses the `Read` tool to load only the necessary documents at command time.
|
|
76
|
-
- Agents request only the documents relevant to their current task.
|
|
77
|
-
- The five documents listed in CLAUDE.md “Memory Strategy” are always loaded.
|
|
78
|
-
|
|
79
|
-
### Context Engineering Checklist
|
|
80
|
-
|
|
81
|
-
**When designing commands**:
|
|
82
|
-
- [ ] JIT: Do we load only the required documents?
|
|
83
|
-
- [ ] Optional Load: Do we load documents conditionally?
|
|
84
|
-
|
|
85
|
-
**When designing agents**:
|
|
86
|
-
- [ ] Minimum tools: Does the YAML frontmatter declare only the needed tools?
|
|
87
|
-
- [ ] Clear roles: Does each agent maintain a single responsibility?
|
|
88
|
-
|
|
89
|
-
---
|
|
90
|
-
|
|
91
|
-
## TRUST Principles (5 Pillars)
|
|
92
|
-
|
|
93
|
-
### T – Test-Driven Development (SPEC-Aligned)
|
|
94
|
-
|
|
95
|
-
**SPEC → Test → Code Cycle**:
|
|
96
|
-
|
|
97
|
-
- **SPEC**: Author detailed specifications first with `@SPEC:ID` tags (EARS format).
|
|
98
|
-
- **RED**: `@TEST:ID` – write failing tests tied to SPEC requirements and confirm failure.
|
|
99
|
-
- **GREEN**: `@CODE:ID` – implement the minimal code that passes the tests and satisfies the SPEC.
|
|
100
|
-
- **REFACTOR**: `@CODE:ID` – improve the code while preserving SPEC compliance, then document with `@DOC:ID`.
|
|
101
|
-
|
|
102
|
-
**Language-Specific TDD Tooling**:
|
|
103
|
-
|
|
104
|
-
- **Python**: pytest + SPEC-based test cases (with mypy type hints)
|
|
105
|
-
- **TypeScript**: Vitest + SPEC-driven suites (strict typing)
|
|
106
|
-
- **Java**: JUnit + SPEC annotations (behaviour-driven tests)
|
|
107
|
-
- **Go**: go test + SPEC table-driven tests (interface adherence)
|
|
108
|
-
- **Rust**: cargo test + SPEC doc tests (trait validation)
|
|
109
|
-
- **Ruby**: RSpec + SPEC-based BDD scenarios
|
|
110
|
-
|
|
111
|
-
Each test links SPEC requirements to implementations via `@TEST:ID → @CODE:ID`.
|
|
112
|
-
|
|
113
|
-
### R – Requirement-Driven Readability
|
|
114
|
-
|
|
115
|
-
**SPEC-Aligned Clean Code**:
|
|
116
|
-
|
|
117
|
-
- Functions implement SPEC requirements directly (≤ 50 LOC per function).
|
|
118
|
-
- Names mirror SPEC terminology and domain language.
|
|
119
|
-
- Code structure reflects SPEC design decisions.
|
|
120
|
-
- Comments are limited to SPEC clarifications and @TAG references.
|
|
121
|
-
|
|
122
|
-
**Language-Specific SPEC Implementation**:
|
|
123
|
-
|
|
124
|
-
- **Python**: Type hints mirroring SPEC interfaces + mypy validation
|
|
125
|
-
- **TypeScript**: Strict interfaces that match SPEC contracts
|
|
126
|
-
- **Java**: Classes implementing SPEC components with strong typing
|
|
127
|
-
- **Go**: Interfaces that satisfy SPEC requirements + gofmt
|
|
128
|
-
- **Rust**: Types enforcing SPEC safety requirements + rustfmt
|
|
129
|
-
- **Ruby**: Behaviour reflecting SPEC narratives + RuboCop validation
|
|
130
|
-
|
|
131
|
-
Every code element must remain traceable back to the SPEC via @TAG comments.
|
|
132
|
-
|
|
133
|
-
### U – Unified SPEC Architecture
|
|
134
|
-
|
|
135
|
-
- **SPEC-Driven Complexity**: Each SPEC defines its complexity threshold. Exceeding it requires a new SPEC or a documented exception.
|
|
136
|
-
- **SPEC vs. Implementation**: Keep authoring and implementation separate; never edit the SPEC mid-TDD cycle.
|
|
137
|
-
- **Language Boundaries**: SPECs define boundaries across languages (Python modules, TypeScript interfaces, Java packages, Go packages, Rust crates, etc.).
|
|
138
|
-
- **SPEC-Guided Architecture**: Domain boundaries follow the SPEC, not language conventions, with the @TAG system ensuring cross-language traceability.
|
|
139
|
-
|
|
140
|
-
### S – SPEC-Compliant Security
|
|
141
|
-
|
|
142
|
-
- **Security Requirements**: Every SPEC explicitly defines security needs, data sensitivity, and access control.
|
|
143
|
-
- **Security by Design**: Implement security controls during the TDD cycle, not after completion.
|
|
144
|
-
- **Language-Agnostic Security Patterns**:
|
|
145
|
-
- Input validation based on SPEC interface definitions
|
|
146
|
-
- Audit logging for SPEC-defined critical operations
|
|
147
|
-
- Access controls aligned with the SPEC permission model
|
|
148
|
-
- Secret management tailored to SPEC environment requirements
|
|
149
|
-
|
|
150
|
-
### T – SPEC Traceability
|
|
151
|
-
|
|
152
|
-
- **Spec-to-Code Traceability**: Every code change references SPEC IDs and requirements through the @TAG system.
|
|
153
|
-
- **Three-Stage Workflow Trace**:
|
|
154
|
-
- `/alfred:1-plan`: Write SPECs with `@SPEC:ID` tags (`.moai/specs/`)
|
|
155
|
-
- `/alfred:2-run`: Implement via TDD with `@TEST:ID` (tests/) → `@CODE:ID` (src/)
|
|
156
|
-
- `/alfred:3-sync`: Sync documentation using `@DOC:ID` (docs/) and validate TAG coverage
|
|
157
|
-
- **Code Scan Verification**: Guarantee TAG traceability by scanning the codebase directly with `rg '@(SPEC|TEST|CODE|DOC):' -n`, without intermediate caches.
|
|
158
|
-
|
|
159
|
-
---
|
|
160
|
-
|
|
161
|
-
## SPEC-First Mindset
|
|
162
|
-
|
|
163
|
-
1. **SPEC-Led Decisions**: Reference an existing SPEC or author a new one before making any technical decision. Never implement without clear requirements.
|
|
164
|
-
2. **SPEC Context Review**: Read the relevant SPEC documents before changing code, understand the @TAG relationships, and confirm compliance.
|
|
165
|
-
3. **SPEC Communication**: Default to English for collaboration. SPEC documents should use precise technical terminology and plain, unambiguous explanations.
|
|
166
|
-
|
|
167
|
-
## SPEC-TDD Workflow
|
|
168
|
-
|
|
169
|
-
1. **Start with the SPEC**: Author or reference a SPEC before writing code. Use `/alfred:1-plan` to clarify requirements, design, and tasks.
|
|
170
|
-
2. **Implement with TDD**: Follow the Red–Green–Refactor loop rigorously using `/alfred:2-run` with language-appropriate testing frameworks.
|
|
171
|
-
3. **Maintain Traceability**: Run `/alfred:3-sync` to update documentation and preserve @TAG relationships between SPECs and code.
|
|
172
|
-
|
|
173
|
-
## @TAG System
|
|
174
|
-
|
|
175
|
-
### Core Chain
|
|
176
|
-
|
|
177
|
-
```text
|
|
178
|
-
@SPEC:ID → @TEST:ID → @CODE:ID → @DOC:ID
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
**Perfect TDD Alignment**:
|
|
182
|
-
- `@SPEC:ID` (Preparation) – requirements authored with the EARS pattern
|
|
183
|
-
- `@TEST:ID` (RED) – failing tests derived from the SPEC
|
|
184
|
-
- `@CODE:ID` (GREEN + REFACTOR) – implementation and refactoring
|
|
185
|
-
- `@DOC:ID` (Documentation) – live documents that capture the outcome
|
|
186
|
-
|
|
187
|
-
### TAG Block Template
|
|
188
|
-
|
|
189
|
-
> **📋 SPEC Metadata Standard (SSOT)**: see `SPEC-METADATA.md`
|
|
190
|
-
|
|
191
|
-
**Every SPEC document must include YAML front matter and a HISTORY section**:
|
|
192
|
-
- **Required Fields (7)**: id, version, status, created, updated, author, priority
|
|
193
|
-
- **Optional Fields (9)**: category, labels, depends_on, blocks, related_specs, related_issue, scope
|
|
194
|
-
- **HISTORY Section**: log every version change (mandatory)
|
|
195
|
-
|
|
196
|
-
Find the complete template, field descriptions, and validation commands in `SPEC-METADATA.md`.
|
|
197
|
-
|
|
198
|
-
**Quick Reference Example**:
|
|
199
|
-
```yaml
|
|
200
|
-
---
|
|
201
|
-
id: AUTH-001
|
|
202
|
-
version: 0.0.1
|
|
203
|
-
status: draft
|
|
204
|
-
created: 2025-09-15
|
|
205
|
-
updated: 2025-09-15
|
|
206
|
-
author: @Goos
|
|
207
|
-
priority: high
|
|
208
|
-
---
|
|
209
|
-
|
|
210
|
-
# @SPEC:AUTH-001: JWT Authentication System
|
|
211
|
-
|
|
212
|
-
## HISTORY
|
|
213
|
-
### v0.0.1 (2025-09-15)
|
|
214
|
-
- **INITIAL**: Authored the JWT authentication system SPEC
|
|
215
|
-
...
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
**Source Code (`src/`)**:
|
|
219
|
-
```text
|
|
220
|
-
# @CODE:AUTH-001 | SPEC: SPEC-AUTH-001.md | TEST: tests/auth/service.test.ts
|
|
221
|
-
```
|
|
222
|
-
|
|
223
|
-
**Test Code (`tests/`)**:
|
|
224
|
-
```text
|
|
225
|
-
# @TEST:AUTH-001 | SPEC: SPEC-AUTH-001.md
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
### @CODE Subcategories (Comment Level)
|
|
229
|
-
|
|
230
|
-
Document implementation details inside `@CODE:ID` blocks:
|
|
231
|
-
- `@CODE:ID:API` – REST APIs, GraphQL endpoints
|
|
232
|
-
- `@CODE:ID:UI` – UI components, views, screens
|
|
233
|
-
- `@CODE:ID:DATA` – data models, schemas, types
|
|
234
|
-
- `@CODE:ID:DOMAIN` – business logic, domain rules
|
|
235
|
-
- `@CODE:ID:INFRA` – infrastructure, databases, integrations
|
|
236
|
-
|
|
237
|
-
### TAG Usage Rules
|
|
238
|
-
|
|
239
|
-
- **TAG ID Format**: `<DOMAIN>-<3 digits>` (e.g., `AUTH-003`) – immutable once created.
|
|
240
|
-
- **Directory Naming**: `.moai/specs/SPEC-{ID}/` (required)
|
|
241
|
-
- ✅ Valid: `SPEC-AUTH-001/`, `SPEC-REFACTOR-001/`, `SPEC-UPDATE-REFACTOR-001/`
|
|
242
|
-
- ❌ Invalid: `AUTH-001/`, `SPEC-001-auth/`, `SPEC-AUTH-001-jwt/`
|
|
243
|
-
- **Composite Domains**: hyphenated combinations allowed (e.g., `UPDATE-REFACTOR-001`)
|
|
244
|
-
- **Guideline**: Prefer fewer than three hyphen segments for clarity
|
|
245
|
-
- **TAG Contents**: May evolve freely; always record the rationale in HISTORY.
|
|
246
|
-
- **Versioning**: Semantic Versioning (v0.0.1 → v0.1.0 → v1.0.0)
|
|
247
|
-
- See `SPEC-METADATA.md#versioning` for details.
|
|
248
|
-
- **Duplicate Check**: Run `rg "@SPEC:{ID}" -n .moai/specs/` before creating a new TAG.
|
|
249
|
-
- **TAG Validation**: `rg '@(SPEC|TEST|CODE|DOC):' -n .moai/specs/ tests/ src/ docs/`
|
|
250
|
-
- **Version Alignment**: `rg "SPEC-{ID}.md v" -n`
|
|
251
|
-
- **Code-First Principle**: The source of truth for TAGs lives in the codebase.
|
|
252
|
-
|
|
253
|
-
### HISTORY Authoring Guide
|
|
254
|
-
|
|
255
|
-
**Change Type Tags**:
|
|
256
|
-
- `INITIAL`: First release (v1.0.0)
|
|
257
|
-
- `ADDED`: New requirement or capability → increment MINOR
|
|
258
|
-
- `CHANGED`: Adjusted behaviour → increment PATCH
|
|
259
|
-
- `FIXED`: Bug or defect fix → increment PATCH
|
|
260
|
-
- `REMOVED`: Removed capability → increment MAJOR
|
|
261
|
-
- `BREAKING`: Backward-incompatible change → increment MAJOR
|
|
262
|
-
- `DEPRECATED`: Marked for future removal
|
|
263
|
-
|
|
264
|
-
**Required Metadata**:
|
|
265
|
-
- `AUTHOR`: Contributor (GitHub ID)
|
|
266
|
-
- `REVIEW`: Reviewer and approval status
|
|
267
|
-
- `REASON`: Why the change was made (optional but recommended for significant updates)
|
|
268
|
-
- `RELATED`: Linked issues/PRs (optional)
|
|
269
|
-
|
|
270
|
-
**HISTORY Search Examples**:
|
|
271
|
-
```bash
|
|
272
|
-
# View the full change log for a TAG
|
|
273
|
-
rg -A 20 "# @SPEC:AUTH-001" .moai/specs/SPEC-AUTH-001.md
|
|
274
|
-
|
|
275
|
-
# Extract only the HISTORY section
|
|
276
|
-
rg -A 50 "## HISTORY" .moai/specs/SPEC-AUTH-001.md
|
|
277
|
-
|
|
278
|
-
# Check the latest entries
|
|
279
|
-
rg "### v[0-9]" .moai/specs/SPEC-AUTH-001.md | head -3
|
|
280
|
-
```
|
|
281
|
-
|
|
282
|
-
---
|
|
283
|
-
|
|
284
|
-
## Development Principles
|
|
285
|
-
|
|
286
|
-
### Code Constraints
|
|
287
|
-
|
|
288
|
-
- ≤ 300 LOC per file
|
|
289
|
-
- ≤ 50 LOC per function
|
|
290
|
-
- ≤ 5 parameters per function
|
|
291
|
-
- Cyclomatic complexity ≤ 10
|
|
292
|
-
|
|
293
|
-
### Quality Benchmarks
|
|
294
|
-
|
|
295
|
-
- ≥ 85% test coverage
|
|
296
|
-
- Use intention-revealing names
|
|
297
|
-
- Prefer guard clauses
|
|
298
|
-
- Leverage language-standard tooling
|
|
299
|
-
|
|
300
|
-
### Refactoring Rules
|
|
301
|
-
|
|
302
|
-
- **Rule of Three**: Plan refactoring when the same pattern appears a third time.
|
|
303
|
-
- **Preparatory Refactoring**: Shape the code for easy change before applying the change.
|
|
304
|
-
- **Tidy as You Go**: Fix small issues immediately; when scope expands, split into a dedicated effort.
|
|
305
|
-
|
|
306
|
-
## Exception Handling
|
|
307
|
-
|
|
308
|
-
When deviating from recommendations, document a waiver and attach it to the relevant PR, issue, or ADR.
|
|
309
|
-
|
|
310
|
-
**Waiver Checklist**:
|
|
311
|
-
|
|
312
|
-
- Justification and evaluated alternatives
|
|
313
|
-
- Risks and mitigation plan
|
|
314
|
-
- Temporary vs. permanent status
|
|
315
|
-
- Expiry conditions and approver
|
|
316
|
-
|
|
317
|
-
## Language Tooling Map
|
|
318
|
-
|
|
319
|
-
- **Python**: pytest (tests), mypy (type checks), black (formatting)
|
|
320
|
-
- **TypeScript**: Vitest (tests), Biome (lint + format)
|
|
321
|
-
- **Java**: JUnit (tests), Maven/Gradle (build)
|
|
322
|
-
- **Go**: go test (tests), gofmt (format)
|
|
323
|
-
- **Rust**: cargo test (tests), rustfmt (format)
|
|
324
|
-
- **Ruby**: RSpec (tests), RuboCop (lint + format), Bundler (packages)
|
|
325
|
-
|
|
326
|
-
## Variable Role Reference
|
|
327
|
-
|
|
328
|
-
| Role | Description | Example |
|
|
329
|
-
| ------------------ | ---------------------------------- | ------------------------------------ |
|
|
330
|
-
| Fixed Value | Constant after initialization | `const MAX_SIZE = 100` |
|
|
331
|
-
| Stepper | Changes sequentially | `for (let i = 0; i < n; i++)` |
|
|
332
|
-
| Flag | Boolean state indicator | `let isValid = true` |
|
|
333
|
-
| Walker | Traverses a data structure | `while (node) { node = node.next; }` |
|
|
334
|
-
| Most Recent Holder | Holds the most recent value | `let lastError` |
|
|
335
|
-
| Most Wanted Holder | Holds optimal/maximum value | `let bestScore = -Infinity` |
|
|
336
|
-
| Gatherer | Accumulator | `sum += value` |
|
|
337
|
-
| Container | Stores multiple values | `const list = []` |
|
|
338
|
-
| Follower | Previous value of another variable | `prev = curr; curr = next;` |
|
|
339
|
-
| Organizer | Reorganizes data | `const sorted = array.sort()` |
|
|
340
|
-
| Temporary | Temporary storage | `const temp = a; a = b; b = temp;` |
|
|
341
|
-
|
|
342
|
-
---
|
|
343
|
-
|
|
344
|
-
This guide defines the standards for executing the three-stage MoAI-ADK pipeline.
|
|
@@ -1,356 +0,0 @@
|
|
|
1
|
-
# SPEC Metadata Structure Guide
|
|
2
|
-
|
|
3
|
-
> **MoAI-ADK SPEC Metadata Standard**
|
|
4
|
-
>
|
|
5
|
-
> Every SPEC document must follow this structure.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 📋 Metadata Overview
|
|
10
|
-
|
|
11
|
-
SPEC metadata contains **7 required fields** and **9 optional fields**.
|
|
12
|
-
|
|
13
|
-
### Full Example
|
|
14
|
-
|
|
15
|
-
```yaml
|
|
16
|
-
---
|
|
17
|
-
# Required Fields (7)
|
|
18
|
-
id: AUTH-001 # Unique SPEC ID
|
|
19
|
-
version: 0.0.1 # Semantic version (v0.0.1 = INITIAL, draft start)
|
|
20
|
-
status: draft # draft|active|completed|deprecated
|
|
21
|
-
created: 2025-09-15 # Creation date (YYYY-MM-DD)
|
|
22
|
-
updated: 2025-09-15 # Last updated (YYYY-MM-DD; initially same as created)
|
|
23
|
-
author: @Goos # Author (single GitHub handle)
|
|
24
|
-
priority: high # low|medium|high|critical
|
|
25
|
-
|
|
26
|
-
# Optional Fields – Classification/Meta
|
|
27
|
-
category: security # feature|bugfix|refactor|security|docs|perf
|
|
28
|
-
labels: # Tags for search and grouping
|
|
29
|
-
- authentication
|
|
30
|
-
- jwt
|
|
31
|
-
|
|
32
|
-
# Optional Fields – Relationships (Dependency Graph)
|
|
33
|
-
depends_on: # SPECs this one depends on (optional)
|
|
34
|
-
- USER-001
|
|
35
|
-
blocks: # SPECs blocked by this one (optional)
|
|
36
|
-
- AUTH-002
|
|
37
|
-
related_specs: # Related SPECs (optional)
|
|
38
|
-
- TOKEN-002
|
|
39
|
-
related_issue: "https://github.com/modu-ai/moai-adk/issues/123"
|
|
40
|
-
|
|
41
|
-
# Optional Fields – Scope/Impact
|
|
42
|
-
scope:
|
|
43
|
-
packages: # Impacted packages
|
|
44
|
-
- src/core/auth
|
|
45
|
-
files: # Key files (optional)
|
|
46
|
-
- auth-service.ts
|
|
47
|
-
- jwt-manager.ts
|
|
48
|
-
---
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
## Required Fields
|
|
54
|
-
|
|
55
|
-
### 1. `id` – Unique SPEC Identifier
|
|
56
|
-
- **Type**: string
|
|
57
|
-
- **Format**: `<DOMAIN>-<NUMBER>`
|
|
58
|
-
- **Examples**: `AUTH-001`, `INSTALLER-SEC-001`
|
|
59
|
-
- **Rules**:
|
|
60
|
-
- Immutable once assigned
|
|
61
|
-
- Use three digits (001–999)
|
|
62
|
-
- Domain in uppercase; hyphens allowed
|
|
63
|
-
- Directory name: `.moai/specs/SPEC-{ID}/` (e.g., `.moai/specs/SPEC-AUTH-001/`)
|
|
64
|
-
|
|
65
|
-
### 2. `version` – Semantic Version
|
|
66
|
-
- **Type**: string (`MAJOR.MINOR.PATCH`)
|
|
67
|
-
- **Default**: `0.0.1` (all SPECs start here, status: draft)
|
|
68
|
-
- **Version Lifecycle**:
|
|
69
|
-
- **v0.0.1**: INITIAL – SPEC first draft (status: draft)
|
|
70
|
-
- **v0.0.x**: Draft refinements (increment PATCH when editing the SPEC)
|
|
71
|
-
- **v0.1.0**: TDD implementation complete (status: completed, updated via `/alfred:3-sync`)
|
|
72
|
-
- **v0.1.x**: Bug fixes or doc improvements (PATCH increment)
|
|
73
|
-
- **v0.x.0**: Feature additions or major enhancements (MINOR increment)
|
|
74
|
-
- **v1.0.0**: Stable release (production ready, explicit stakeholder approval required)
|
|
75
|
-
|
|
76
|
-
### 3. `status` – Progress State
|
|
77
|
-
- **Type**: enum
|
|
78
|
-
- **Values**:
|
|
79
|
-
- `draft`: Authoring in progress
|
|
80
|
-
- `active`: Implementation underway
|
|
81
|
-
- `completed`: Implementation finished
|
|
82
|
-
- `deprecated`: Planned for retirement
|
|
83
|
-
|
|
84
|
-
### 4. `created` – Creation Date
|
|
85
|
-
- **Type**: date string
|
|
86
|
-
- **Format**: `YYYY-MM-DD`
|
|
87
|
-
- **Example**: `2025-10-06`
|
|
88
|
-
|
|
89
|
-
### 5. `updated` – Last Modified Date
|
|
90
|
-
- **Type**: date string
|
|
91
|
-
- **Format**: `YYYY-MM-DD`
|
|
92
|
-
- **Rule**: Update whenever the SPEC content changes.
|
|
93
|
-
|
|
94
|
-
### 6. `author` – Primary Author
|
|
95
|
-
- **Type**: string
|
|
96
|
-
- **Format**: `@{GitHub ID}`
|
|
97
|
-
- **Example**: `@Goos`
|
|
98
|
-
- **Rules**:
|
|
99
|
-
- Single value only (no `authors` array)
|
|
100
|
-
- Prefix the GitHub handle with `@`
|
|
101
|
-
- Additional contributors belong in the HISTORY section
|
|
102
|
-
|
|
103
|
-
### 7. `priority` – Work Priority
|
|
104
|
-
- **Type**: enum
|
|
105
|
-
- **Values**:
|
|
106
|
-
- `critical`: Immediate attention (security, severe defects)
|
|
107
|
-
- `high`: Major feature work
|
|
108
|
-
- `medium`: Enhancements
|
|
109
|
-
- `low`: Optimizations or documentation
|
|
110
|
-
|
|
111
|
-
---
|
|
112
|
-
|
|
113
|
-
## Optional Fields
|
|
114
|
-
|
|
115
|
-
### Classification / Meta
|
|
116
|
-
|
|
117
|
-
#### 8. `category` – Change Type
|
|
118
|
-
- **Type**: enum
|
|
119
|
-
- **Values**:
|
|
120
|
-
- `feature`: New functionality
|
|
121
|
-
- `bugfix`: Defect resolution
|
|
122
|
-
- `refactor`: Structural improvements
|
|
123
|
-
- `security`: Security enhancements
|
|
124
|
-
- `docs`: Documentation updates
|
|
125
|
-
- `perf`: Performance optimizations
|
|
126
|
-
|
|
127
|
-
#### 9. `labels` – Classification Tags
|
|
128
|
-
- **Type**: array of strings
|
|
129
|
-
- **Purpose**: Search, filtering, grouping
|
|
130
|
-
- **Example**:
|
|
131
|
-
```yaml
|
|
132
|
-
labels:
|
|
133
|
-
- installer
|
|
134
|
-
- template
|
|
135
|
-
- security
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
### Relationship Fields (Dependency Graph)
|
|
139
|
-
|
|
140
|
-
#### 10. `depends_on` – Required SPECs
|
|
141
|
-
- **Type**: array of strings
|
|
142
|
-
- **Meaning**: SPECs that must be completed first
|
|
143
|
-
- **Example**:
|
|
144
|
-
```yaml
|
|
145
|
-
depends_on:
|
|
146
|
-
- USER-001
|
|
147
|
-
- AUTH-001
|
|
148
|
-
```
|
|
149
|
-
- **Use Case**: Determines execution order and parallelization.
|
|
150
|
-
|
|
151
|
-
#### 11. `blocks` – Blocked SPECs
|
|
152
|
-
- **Type**: array of strings
|
|
153
|
-
- **Meaning**: SPECs that cannot proceed until this one is resolved
|
|
154
|
-
- **Example**:
|
|
155
|
-
```yaml
|
|
156
|
-
blocks:
|
|
157
|
-
- PAYMENT-003
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
#### 12. `related_specs` – Associated SPECs
|
|
161
|
-
- **Type**: array of strings
|
|
162
|
-
- **Meaning**: Related items without direct dependencies
|
|
163
|
-
- **Example**:
|
|
164
|
-
```yaml
|
|
165
|
-
related_specs:
|
|
166
|
-
- TOKEN-002
|
|
167
|
-
- SESSION-001
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
#### 13. `related_issue` – Linked GitHub Issue
|
|
171
|
-
- **Type**: string (URL)
|
|
172
|
-
- **Format**: Full GitHub issue URL
|
|
173
|
-
- **Example**:
|
|
174
|
-
```yaml
|
|
175
|
-
related_issue: "https://github.com/modu-ai/moai-adk/issues/123"
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
### Scope Fields (Impact Analysis)
|
|
179
|
-
|
|
180
|
-
#### 14. `scope.packages` – Impacted Packages
|
|
181
|
-
- **Type**: array of strings
|
|
182
|
-
- **Meaning**: Packages or modules touched by the SPEC
|
|
183
|
-
- **Example**:
|
|
184
|
-
```yaml
|
|
185
|
-
scope:
|
|
186
|
-
packages:
|
|
187
|
-
- moai-adk-ts/src/core/installer
|
|
188
|
-
- moai-adk-ts/src/core/git
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
#### 15. `scope.files` – Key Files
|
|
192
|
-
- **Type**: array of strings
|
|
193
|
-
- **Meaning**: Primary files involved (for reference)
|
|
194
|
-
- **Example**:
|
|
195
|
-
```yaml
|
|
196
|
-
scope:
|
|
197
|
-
files:
|
|
198
|
-
- template-processor.ts
|
|
199
|
-
- template-security.ts
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
---
|
|
203
|
-
|
|
204
|
-
## Metadata Validation
|
|
205
|
-
|
|
206
|
-
### Required Field Checks
|
|
207
|
-
```bash
|
|
208
|
-
# Verify that every SPEC includes the required fields
|
|
209
|
-
rg "^(id|version|status|created|updated|author|priority):" .moai/specs/SPEC-*/spec.md
|
|
210
|
-
|
|
211
|
-
# Identify SPECs missing the priority field
|
|
212
|
-
rg -L "^priority:" .moai/specs/SPEC-*/spec.md
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
### Format Checks
|
|
216
|
-
```bash
|
|
217
|
-
# Ensure the author field uses @Handle format
|
|
218
|
-
rg "^author: @[A-Z]" .moai/specs/SPEC-*/spec.md
|
|
219
|
-
|
|
220
|
-
# Ensure the version field follows 0.x.y
|
|
221
|
-
rg "^version: 0\.\d+\.\d+" .moai/specs/SPEC-*/spec.md
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
---
|
|
225
|
-
|
|
226
|
-
## Migration Guide
|
|
227
|
-
|
|
228
|
-
### Updating Existing SPECs
|
|
229
|
-
|
|
230
|
-
#### 1. Add the `priority` Field
|
|
231
|
-
Add it if missing:
|
|
232
|
-
```yaml
|
|
233
|
-
priority: medium # or low|high|critical
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
#### 2. Normalize the `author` Field
|
|
237
|
-
- `authors: ["@goos"]` → `author: @Goos`
|
|
238
|
-
- Convert lowercase handles to the canonical casing.
|
|
239
|
-
|
|
240
|
-
#### 3. Add Optional Fields (Recommended)
|
|
241
|
-
```yaml
|
|
242
|
-
category: refactor
|
|
243
|
-
labels:
|
|
244
|
-
- code-quality
|
|
245
|
-
- maintenance
|
|
246
|
-
```
|
|
247
|
-
|
|
248
|
-
### Updating config.json for Language Support (v0.4.2+)
|
|
249
|
-
|
|
250
|
-
**Background**: MoAI-ADK v0.4.2 introduces conversation language selection in `/alfred:0-project`. Existing projects need to add language metadata to `.moai/config.json`.
|
|
251
|
-
|
|
252
|
-
#### Migration Steps
|
|
253
|
-
|
|
254
|
-
**For Existing Projects** (before v0.4.2):
|
|
255
|
-
|
|
256
|
-
Current config.json structure:
|
|
257
|
-
```json
|
|
258
|
-
{
|
|
259
|
-
"project": {
|
|
260
|
-
"locale": "en",
|
|
261
|
-
"mode": "personal",
|
|
262
|
-
"language": "python"
|
|
263
|
-
}
|
|
264
|
-
}
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
**Updated Structure** (v0.4.2+):
|
|
268
|
-
```json
|
|
269
|
-
{
|
|
270
|
-
"project": {
|
|
271
|
-
"locale": "en",
|
|
272
|
-
"mode": "personal",
|
|
273
|
-
"language": "python",
|
|
274
|
-
"conversation_language": "en",
|
|
275
|
-
"conversation_language_name": "English",
|
|
276
|
-
"codebase_languages": ["python"]
|
|
277
|
-
}
|
|
278
|
-
}
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
#### New Fields
|
|
282
|
-
|
|
283
|
-
| Field | Type | Required | Description | Example |
|
|
284
|
-
|-------|------|----------|-------------|---------|
|
|
285
|
-
| `conversation_language` | string (ISO 639-1 code) | ✅ Yes | Two-letter language code for Alfred dialogs | `"ko"`, `"en"`, `"ja"`, `"zh"` |
|
|
286
|
-
| `conversation_language_name` | string | ✅ Yes | Display name of conversation language | `"Korean"`, `"English"` |
|
|
287
|
-
| `codebase_languages` | array of strings | ✅ Yes | List of programming languages detected | `["python"]`, `["typescript", "python"]` |
|
|
288
|
-
|
|
289
|
-
#### Manual Update Process
|
|
290
|
-
|
|
291
|
-
1. Open `.moai/config.json`
|
|
292
|
-
2. Add the three new fields under `project`:
|
|
293
|
-
```json
|
|
294
|
-
"conversation_language": "en",
|
|
295
|
-
"conversation_language_name": "English",
|
|
296
|
-
"codebase_languages": ["python"]
|
|
297
|
-
```
|
|
298
|
-
3. Save and commit:
|
|
299
|
-
```bash
|
|
300
|
-
git add .moai/config.json
|
|
301
|
-
git commit -m "chore: add language metadata to config.json for v0.4.2+"
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
#### Automated Update (via `/alfred:0-project`)
|
|
305
|
-
|
|
306
|
-
Running `/alfred:0-project` on an existing project will:
|
|
307
|
-
1. Detect current language settings
|
|
308
|
-
2. Add new fields automatically
|
|
309
|
-
3. Preserve existing values
|
|
310
|
-
|
|
311
|
-
**No manual action required if running `/alfred:0-project` after upgrade.**
|
|
312
|
-
|
|
313
|
-
#### Field Mapping (Legacy → New)
|
|
314
|
-
|
|
315
|
-
| Old Field | New Field | Migration Rule |
|
|
316
|
-
|-----------|-----------|-----------------|
|
|
317
|
-
| `locale` | `conversation_language` | Keep as-is (or run `/alfred:0-project` to re-select) |
|
|
318
|
-
| (none) | `conversation_language_name` | Auto-populate from locale mapping |
|
|
319
|
-
| `language` | `codebase_languages` | Wrap in array: `"python"` → `["python"]` |
|
|
320
|
-
|
|
321
|
-
#### Backward Compatibility
|
|
322
|
-
|
|
323
|
-
- ✅ Projects without new fields will continue working
|
|
324
|
-
- ⚠️ New language features (multilingual documentation) unavailable without migration
|
|
325
|
-
- ✅ `/alfred:0-project` automatically migrates on next run
|
|
326
|
-
- ✅ Auto-detection will prefer new fields if present
|
|
327
|
-
|
|
328
|
-
---
|
|
329
|
-
|
|
330
|
-
## Design Principles
|
|
331
|
-
|
|
332
|
-
### 1. DRY (Don't Repeat Yourself)
|
|
333
|
-
- ❌ **Remove**: the `reference` field (every SPEC referenced the same master plan)
|
|
334
|
-
- ✅ **Instead**: document project-level resources in README.md
|
|
335
|
-
|
|
336
|
-
### 2. Context-Aware
|
|
337
|
-
- Include only the necessary context.
|
|
338
|
-
- Use optional fields only when they add value.
|
|
339
|
-
|
|
340
|
-
### 3. Traceable
|
|
341
|
-
- Use `depends_on`, `blocks`, and `related_specs` to map dependencies.
|
|
342
|
-
- Automated tooling can detect cyclic references.
|
|
343
|
-
|
|
344
|
-
### 4. Maintainable
|
|
345
|
-
- Every field must be machine-verifiable.
|
|
346
|
-
- Maintain consistent formatting for easy parsing.
|
|
347
|
-
|
|
348
|
-
### 5. Simple First
|
|
349
|
-
- Keep complexity low.
|
|
350
|
-
- Limit to 7 required + 9 optional fields.
|
|
351
|
-
- Expand gradually when justified.
|
|
352
|
-
|
|
353
|
-
---
|
|
354
|
-
|
|
355
|
-
**Last Updated**: 2025-10-06
|
|
356
|
-
**Author**: @Alfred
|