@zenuml/core 3.47.9 → 3.48.0
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.
- package/dist/cloud-icons-eHuugVSv.js.map +1 -0
- package/dist/zenuml.esm.mjs +2153 -2156
- package/dist/zenuml.esm.mjs.map +1 -0
- package/dist/zenuml.js +82 -82
- package/dist/zenuml.js.map +1 -0
- package/package.json +11 -1
- package/src/cli/zenuml.ts +1164 -0
- package/.agents/skills/babysit-pr/SKILL.md +0 -223
- package/.agents/skills/babysit-pr/agents/openai.yaml +0 -7
- package/.agents/skills/dia-scoring/SKILL.md +0 -139
- package/.agents/skills/dia-scoring/agents/openai.yaml +0 -7
- package/.agents/skills/dia-scoring/references/selectors-and-keys.md +0 -253
- package/.agents/skills/land-pr/SKILL.md +0 -120
- package/.agents/skills/propagate-core-release/SKILL.md +0 -205
- package/.agents/skills/propagate-core-release/agents/openai.yaml +0 -7
- package/.agents/skills/propagate-core-release/references/downstreams.md +0 -42
- package/.agents/skills/ship-branch/SKILL.md +0 -105
- package/.agents/skills/submit-branch/SKILL.md +0 -76
- package/.agents/skills/validate-branch/SKILL.md +0 -72
- package/.claude/commands/README.md +0 -162
- package/.claude/commands/analyze.md +0 -101
- package/.claude/commands/clarify.md +0 -158
- package/.claude/commands/code-review.md +0 -322
- package/.claude/commands/constitution.md +0 -73
- package/.claude/commands/create-docs.md +0 -309
- package/.claude/commands/full-context.md +0 -121
- package/.claude/commands/gemini-consult.md +0 -164
- package/.claude/commands/handoff.md +0 -146
- package/.claude/commands/implement.md +0 -56
- package/.claude/commands/plan.md +0 -43
- package/.claude/commands/refactor.md +0 -188
- package/.claude/commands/specify.md +0 -21
- package/.claude/commands/tasks.md +0 -62
- package/.claude/commands/update-docs.md +0 -314
- package/.claude/hooks/README.md +0 -270
- package/.claude/hooks/config/sensitive-patterns.json +0 -86
- package/.claude/hooks/gemini-context-injector.sh +0 -129
- package/.claude/hooks/mcp-security-scan.sh +0 -147
- package/.claude/hooks/notify.sh +0 -103
- package/.claude/hooks/setup/hook-setup.md +0 -96
- package/.claude/hooks/setup/settings.json.template +0 -63
- package/.claude/hooks/sounds/complete.wav +0 -0
- package/.claude/hooks/sounds/input-needed.wav +0 -0
- package/.claude/hooks/subagent-context-injector.sh +0 -65
- package/.claude/skills/babysit-pr/SKILL.md +0 -223
- package/.claude/skills/babysit-pr/agents/openai.yaml +0 -7
- package/.claude/skills/dia-scoring/SKILL.md +0 -139
- package/.claude/skills/dia-scoring/agents/openai.yaml +0 -7
- package/.claude/skills/dia-scoring/references/selectors-and-keys.md +0 -253
- package/.claude/skills/emoji-eval/SKILL.md +0 -187
- package/.claude/skills/land-pr/SKILL.md +0 -120
- package/.claude/skills/propagate-core-release/SKILL.md +0 -205
- package/.claude/skills/propagate-core-release/agents/openai.yaml +0 -7
- package/.claude/skills/propagate-core-release/references/downstreams.md +0 -42
- package/.claude/skills/ship-branch/SKILL.md +0 -105
- package/.claude/skills/submit-branch/SKILL.md +0 -76
- package/.claude/skills/validate-branch/SKILL.md +0 -72
- package/.claude/skills/zenuml-ux-research/SKILL.md +0 -183
- package/.claude/skills/zenuml-ux-research/references/assertion-catalog.md +0 -261
- package/.claude/skills/zenuml-ux-research/references/best-practices-overview.md +0 -56
- package/.claude/skills/zenuml-ux-research/references/report-template.md +0 -89
- package/.claude/skills/zenuml-ux-research/references/scenarios/edit-message-label.md +0 -37
- package/.claude/skills/zenuml-ux-research/references/scenarios/insert-message.md +0 -36
- package/.claude/skills/zenuml-ux-research/references/scenarios/insert-participant.md +0 -31
- package/.claude/skills/zenuml-ux-research/references/scenarios/rename-participant.md +0 -33
- package/.claude/skills/zenuml-ux-research/references/scenarios/undo-insert.md +0 -35
- package/.devcontainer/devcontainer.json +0 -21
- package/.dockerignore +0 -19
- package/.eslintrc.js +0 -39
- package/.git-blame-ignore-revs +0 -6
- package/.kiro/hooks/README.md +0 -38
- package/.kiro/hooks/session-sound-notification.js +0 -44
- package/.kiro/hooks/session-sound-notification.json +0 -23
- package/.mcp.json.example +0 -17
- package/.nvmrc +0 -1
- package/.prettierignore +0 -4
- package/.prettierrc +0 -1
- package/.specify/memory/constitution.md +0 -33
- package/.specify/scripts/bash/check-prerequisites.sh +0 -166
- package/.specify/scripts/bash/common.sh +0 -113
- package/.specify/scripts/bash/create-new-feature.sh +0 -97
- package/.specify/scripts/bash/setup-plan.sh +0 -60
- package/.specify/scripts/bash/update-agent-context.sh +0 -728
- package/.specify/templates/agent-file-template.md +0 -23
- package/.specify/templates/plan-template.md +0 -219
- package/.specify/templates/spec-template.md +0 -116
- package/.specify/templates/tasks-template.md +0 -127
- package/.storybook/main.ts +0 -25
- package/.storybook/preview.ts +0 -29
- package/.watchmanconfig +0 -3
- package/AGENTS.md +0 -26
- package/CLAUDE.md +0 -124
- package/DEPLOYMENT.md +0 -62
- package/Dockerfile +0 -36
- package/IMPLEMENTATION_PLAN.md +0 -163
- package/Integration/vanilla-js/index.html +0 -42
- package/MCP-ASSISTANT-RULES.md +0 -85
- package/README_CN.md +0 -15
- package/TUTORIAL.md +0 -116
- package/antlr/antlr-4.11.1-complete.jar +0 -0
- package/bun.lock +0 -1544
- package/bunfig.toml +0 -52
- package/docs/UNICODE_SUPPORT.md +0 -179
- package/docs/ai-context/deployment-infrastructure.md +0 -21
- package/docs/ai-context/docs-overview.md +0 -89
- package/docs/ai-context/handoff.md +0 -174
- package/docs/ai-context/project-structure.md +0 -160
- package/docs/ai-context/system-integration.md +0 -21
- package/docs/asciidoc/contributor.adoc +0 -54
- package/docs/asciidoc/create-my-own-theme.adoc +0 -149
- package/docs/asciidoc/images/creation-component.png +0 -0
- package/docs/asciidoc/images/creation-rtl.png +0 -0
- package/docs/asciidoc/images/message-arrow-rtl.png +0 -0
- package/docs/asciidoc/images/occurrence.png +0 -0
- package/docs/asciidoc/images/return-message-conflict.png +0 -0
- package/docs/asciidoc/images/shift-up-half-the-height.png +0 -0
- package/docs/asciidoc/images/three-layer-info-arch.png +0 -0
- package/docs/asciidoc/images/vertical-alignment.svg +0 -1
- package/docs/asciidoc/images/vertically-aligning.png +0 -0
- package/docs/asciidoc/index.adoc +0 -277
- package/docs/asciidoc/theme-debug-web-app.png +0 -0
- package/docs/asciidoc/tutorial.adoc +0 -22
- package/docs/asciidoc/user-css.png +0 -0
- package/docs/async-vs-sync-parser-rules.md +0 -81
- package/docs/divider-parser-allow-spaces.md +0 -38
- package/docs/highlighting-messages.md +0 -52
- package/docs/images/editor-sample.png +0 -0
- package/docs/inherited-vs-provided-from.md +0 -64
- package/docs/parser/Assignment.md +0 -8
- package/docs/parser/PARSER_IMPROVEMENTS_CC.md +0 -425
- package/docs/parser/grammar_review_gemini.md +0 -116
- package/docs/participants-function.md +0 -25
- package/docs/responsive-participant-margin.md +0 -52
- package/docs/starter.md +0 -9
- package/docs/superpowers/plans/2026-03-27-e2e-test-reorg.md +0 -698
- package/docs/superpowers/plans/2026-03-30-emoji-support.md +0 -1220
- package/docs/superpowers/plans/2026-03-30-self-correcting-scoring.md +0 -206
- package/docs/superpowers/plans/2026-04-15-keyboard-editing-on-diagram.md +0 -1992
- package/docs/superpowers/plans/2026-04-15-zenuml-ux-research-skill.md +0 -1452
- package/docs/ux-research/.gitkeep +0 -0
- package/docs/ux-research/2026-04-15-rename-participant.md +0 -156
- package/docs/ux-research/2026-04-18-insert-participant.md +0 -151
- package/docs/width-translate-and-offsets.md +0 -62
- package/docs/xss.md +0 -59
- package/e2e/data/compare-cases.js +0 -1090
- package/e2e/data/diff-algorithm.js +0 -199
- package/e2e/fixtures/create-message.html +0 -26
- package/e2e/fixtures/editable-label.html +0 -35
- package/e2e/fixtures/editable-span.html +0 -122
- package/e2e/fixtures/empty-diagram.html +0 -23
- package/e2e/fixtures/fixture.html +0 -31
- package/e2e/fixtures/insert-participant.html +0 -23
- package/e2e/fixtures/reorder-cross-fragment.html +0 -31
- package/e2e/fixtures/reorder-fragment.html +0 -29
- package/e2e/fixtures/reorder-message.html +0 -27
- package/e2e/fixtures/svg-test.html +0 -21
- package/e2e/fixtures/type-switch.html +0 -29
- package/e2e/tools/canonical-history.html +0 -908
- package/e2e/tools/compare-case.html +0 -371
- package/e2e/tools/compare.html +0 -35
- package/e2e/tools/native-diff-ext/background.js +0 -60
- package/e2e/tools/native-diff-ext/bridge.js +0 -26
- package/e2e/tools/native-diff-ext/content.js +0 -194
- package/e2e/tools/svg-preview.html +0 -56
- package/embed.html +0 -193
- package/eslint.config.mjs +0 -35
- package/firebase-debug.log +0 -108
- package/iframe-container-demo/diagram.html +0 -124
- package/iframe-container-demo/host.html +0 -817
- package/index.html +0 -771
- package/mermaid-zenuml-async-spa-auth.png +0 -0
- package/mermaid-zenuml-async-spa-auth.snapshot.md +0 -96
- package/newsletter/unicode-support-announcement.md +0 -134
- package/playground/creation.html +0 -53
- package/playground/message.html +0 -63
- package/playwright.config.ts +0 -40
- package/renderer.html +0 -366
- package/scripts/analyze-compare-case/collect-data.mjs +0 -1134
- package/scripts/analyze-compare-case/config.mjs +0 -102
- package/scripts/analyze-compare-case/geometry.mjs +0 -101
- package/scripts/analyze-compare-case/native-diff.mjs +0 -224
- package/scripts/analyze-compare-case/output.mjs +0 -74
- package/scripts/analyze-compare-case/panel-diff.mjs +0 -114
- package/scripts/analyze-compare-case/report.mjs +0 -162
- package/scripts/analyze-compare-case/residual-scopes.mjs +0 -347
- package/scripts/analyze-compare-case/scoring.mjs +0 -829
- package/scripts/analyze-compare-case.mjs +0 -149
- package/scripts/bump-version.js +0 -117
- package/scripts/snapshot-dual.js +0 -173
- package/scripts/update-snapshots.js +0 -70
- package/skills/dia-scoring/SKILL.md +0 -129
- package/skills/dia-scoring/agents/openai.yaml +0 -7
- package/skills/dia-scoring/references/selectors-and-keys.md +0 -253
- package/tailwind.config.js +0 -126
- package/test-compression.html +0 -274
- package/test-mermaid-zenuml.html +0 -57
- package/test-setup.ts +0 -124
- package/test-url-params.html +0 -192
- package/tsconfig.app.json +0 -31
- package/tsconfig.node.json +0 -24
- package/tsconfig.test.json +0 -9
- package/vite.config.lib.ts +0 -93
- package/vite.config.ts +0 -84
- package/wrangler.toml +0 -18
|
@@ -1,162 +0,0 @@
|
|
|
1
|
-
# 🔧 Command Templates
|
|
2
|
-
|
|
3
|
-
Orchestration templates that enable Claude Code to coordinate multi-agent workflows for different development tasks.
|
|
4
|
-
|
|
5
|
-
## Overview
|
|
6
|
-
|
|
7
|
-
After reading the [main kit documentation](../README.md), you'll understand how these commands fit into the integrated system. Each command:
|
|
8
|
-
|
|
9
|
-
- **Auto-loads** the appropriate documentation tier for its task
|
|
10
|
-
- **Spawns specialized agents** based on complexity
|
|
11
|
-
- **Integrates MCP servers** when external expertise helps
|
|
12
|
-
- **Maintains documentation** to keep AI context current
|
|
13
|
-
|
|
14
|
-
### 🚀 Automatic Context Injection
|
|
15
|
-
|
|
16
|
-
All commands benefit from automatic context injection via the `subagent-context-injector.sh` hook:
|
|
17
|
-
|
|
18
|
-
- **Core documentation auto-loaded**: Every command and sub-agent automatically receives `@/docs/CLAUDE.md`, `@/docs/ai-context/project-structure.md`, and `@/docs/ai-context/docs-overview.md`
|
|
19
|
-
- **No manual context loading**: Sub-agents spawned by commands automatically have access to essential project documentation
|
|
20
|
-
- **Consistent knowledge**: All agents start with the same foundational understanding
|
|
21
|
-
|
|
22
|
-
## Available Commands
|
|
23
|
-
|
|
24
|
-
### 📊 `/full-context`
|
|
25
|
-
**Purpose**: Comprehensive context gathering and analysis when you need deep understanding or plan to execute code changes.
|
|
26
|
-
|
|
27
|
-
**When to use**:
|
|
28
|
-
- Starting work on a new feature or bug
|
|
29
|
-
- Need to understand how systems interconnect
|
|
30
|
-
- Planning architectural changes
|
|
31
|
-
- Any task requiring thorough analysis before implementation
|
|
32
|
-
|
|
33
|
-
**How it works**: Adaptively scales from direct analysis to multi-agent orchestration based on request complexity. Agents read documentation, analyze code, map dependencies, and consult MCP servers as needed.
|
|
34
|
-
|
|
35
|
-
### 🔍 `/code-review`
|
|
36
|
-
**Purpose**: Get multiple expert perspectives on code quality, focusing on high-impact findings rather than nitpicks.
|
|
37
|
-
|
|
38
|
-
**When to use**:
|
|
39
|
-
- After implementing new features
|
|
40
|
-
- Before merging important changes
|
|
41
|
-
- When you want security, performance, and architecture insights
|
|
42
|
-
- Need confidence in code quality
|
|
43
|
-
|
|
44
|
-
**How it works**: Spawns specialized agents (security, performance, architecture) that analyze in parallel. Each agent focuses on critical issues that matter for production code.
|
|
45
|
-
|
|
46
|
-
### 🧠 `/gemini-consult` *(Requires Gemini MCP Server)*
|
|
47
|
-
**Purpose**: Engage in deep, iterative conversations with Gemini for complex problem-solving and architectural guidance.
|
|
48
|
-
|
|
49
|
-
**When to use**:
|
|
50
|
-
- Tackling complex architectural decisions
|
|
51
|
-
- Need expert guidance on implementation approaches
|
|
52
|
-
- Debugging intricate issues across multiple files
|
|
53
|
-
- Exploring optimization strategies
|
|
54
|
-
- When you need a thinking partner for difficult problems
|
|
55
|
-
|
|
56
|
-
**How it works**: Creates persistent conversation sessions with Gemini, automatically attaching project context and MCP-ASSISTANT-RULES.md. Supports iterative refinement through follow-up questions and implementation feedback.
|
|
57
|
-
|
|
58
|
-
**Key features**:
|
|
59
|
-
- Context-aware problem detection when no arguments provided
|
|
60
|
-
- Persistent sessions maintained throughout problem lifecycle
|
|
61
|
-
- Automatic attachment of foundational project documentation
|
|
62
|
-
- Support for follow-up questions with session continuity
|
|
63
|
-
|
|
64
|
-
### 📝 `/update-docs`
|
|
65
|
-
**Purpose**: Keep documentation synchronized with code changes, ensuring AI context remains current.
|
|
66
|
-
|
|
67
|
-
**When to use**:
|
|
68
|
-
- After modifying code
|
|
69
|
-
- After adding new features
|
|
70
|
-
- When project structure changes
|
|
71
|
-
- Following any significant implementation
|
|
72
|
-
|
|
73
|
-
**How it works**: Analyzes what changed and updates the appropriate CLAUDE.md files across all tiers. Maintains the context that future AI sessions will rely on.
|
|
74
|
-
|
|
75
|
-
### 📄 `/create-docs`
|
|
76
|
-
**Purpose**: Generate initial documentation structure for existing projects that lack AI-optimized documentation.
|
|
77
|
-
|
|
78
|
-
**When to use**:
|
|
79
|
-
- Adopting the framework in an existing project
|
|
80
|
-
- Starting documentation from scratch
|
|
81
|
-
- Need to document legacy code
|
|
82
|
-
- Setting up the 3-tier structure
|
|
83
|
-
|
|
84
|
-
**How it works**: Analyzes your project structure and creates appropriate CLAUDE.md files at each tier, establishing the foundation for AI-assisted development.
|
|
85
|
-
|
|
86
|
-
### ♻️ `/refactor`
|
|
87
|
-
**Purpose**: Intelligently restructure code while maintaining functionality and updating all dependencies.
|
|
88
|
-
|
|
89
|
-
**When to use**:
|
|
90
|
-
- Breaking up large files
|
|
91
|
-
- Improving code organization
|
|
92
|
-
- Extracting reusable components
|
|
93
|
-
- Cleaning up technical debt
|
|
94
|
-
|
|
95
|
-
**How it works**: Analyzes file structure, maps dependencies, identifies logical split points, and handles all import/export updates across the codebase.
|
|
96
|
-
|
|
97
|
-
### 🤝 `/handoff`
|
|
98
|
-
**Purpose**: Preserve context when ending a session or when the conversation becomes too long.
|
|
99
|
-
|
|
100
|
-
**When to use**:
|
|
101
|
-
- Ending a work session
|
|
102
|
-
- Context limit approaching
|
|
103
|
-
- Switching between major tasks
|
|
104
|
-
- Supplementing `/compact` with permanent storage
|
|
105
|
-
|
|
106
|
-
**How it works**: Updates the handoff documentation with session achievements, current state, and next steps. Ensures smooth continuation in future sessions.
|
|
107
|
-
|
|
108
|
-
## Integration Patterns
|
|
109
|
-
|
|
110
|
-
### Typical Workflow
|
|
111
|
-
```bash
|
|
112
|
-
/full-context "implement user notifications" # Understand
|
|
113
|
-
# ... implement the feature ...
|
|
114
|
-
/code-review "review notification system" # Validate
|
|
115
|
-
/update-docs "document notification feature" # Synchronize
|
|
116
|
-
/handoff "completed notification system" # Preserve
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
### Quick Analysis
|
|
120
|
-
```bash
|
|
121
|
-
/full-context "why is the API slow?" # Investigate
|
|
122
|
-
# ... apply fixes ...
|
|
123
|
-
/update-docs "document performance fixes" # Update context
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### Major Refactoring
|
|
127
|
-
```bash
|
|
128
|
-
/full-context "analyze authentication module" # Understand current state
|
|
129
|
-
/refactor "@auth/large-auth-file.ts" # Restructure
|
|
130
|
-
/code-review "review refactored auth" # Verify quality
|
|
131
|
-
/update-docs "document new auth structure" # Keep docs current
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Complex Problem Solving
|
|
135
|
-
```bash
|
|
136
|
-
/gemini-consult "optimize real-time data pipeline" # Start consultation
|
|
137
|
-
# ... implement suggested approach ...
|
|
138
|
-
/gemini-consult # Follow up with results
|
|
139
|
-
/update-docs "document optimization approach" # Capture insights
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
## Customization
|
|
143
|
-
|
|
144
|
-
Each command template can be adapted:
|
|
145
|
-
|
|
146
|
-
- **Adjust agent strategies** - Modify how many agents spawn and their specializations
|
|
147
|
-
- **Change context loading** - Customize which documentation tiers load
|
|
148
|
-
- **Tune MCP integration** - Adjust when to consult external services
|
|
149
|
-
- **Modify output formats** - Tailor results to your preferences
|
|
150
|
-
|
|
151
|
-
Commands are stored in `.claude/commands/` and can be edited directly.
|
|
152
|
-
|
|
153
|
-
## Key Principles
|
|
154
|
-
|
|
155
|
-
1. **Commands work together** - Each command builds on others' outputs
|
|
156
|
-
2. **Documentation stays current** - Commands maintain their own context
|
|
157
|
-
3. **Complexity scales naturally** - Simple tasks stay simple, complex tasks get sophisticated analysis
|
|
158
|
-
4. **Context is continuous** - Information flows between sessions through documentation
|
|
159
|
-
|
|
160
|
-
---
|
|
161
|
-
|
|
162
|
-
*For detailed implementation of each command, see the individual command files in this directory.*
|
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Perform a non-destructive cross-artifact consistency and quality analysis across spec.md, plan.md, and tasks.md after task generation.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
|
|
6
|
-
|
|
7
|
-
User input:
|
|
8
|
-
|
|
9
|
-
$ARGUMENTS
|
|
10
|
-
|
|
11
|
-
Goal: Identify inconsistencies, duplications, ambiguities, and underspecified items across the three core artifacts (`spec.md`, `plan.md`, `tasks.md`) before implementation. This command MUST run only after `/tasks` has successfully produced a complete `tasks.md`.
|
|
12
|
-
|
|
13
|
-
STRICTLY READ-ONLY: Do **not** modify any files. Output a structured analysis report. Offer an optional remediation plan (user must explicitly approve before any follow-up editing commands would be invoked manually).
|
|
14
|
-
|
|
15
|
-
Constitution Authority: The project constitution (`.specify/memory/constitution.md`) is **non-negotiable** within this analysis scope. Constitution conflicts are automatically CRITICAL and require adjustment of the spec, plan, or tasks—not dilution, reinterpretation, or silent ignoring of the principle. If a principle itself needs to change, that must occur in a separate, explicit constitution update outside `/analyze`.
|
|
16
|
-
|
|
17
|
-
Execution steps:
|
|
18
|
-
|
|
19
|
-
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks` once from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS. Derive absolute paths:
|
|
20
|
-
- SPEC = FEATURE_DIR/spec.md
|
|
21
|
-
- PLAN = FEATURE_DIR/plan.md
|
|
22
|
-
- TASKS = FEATURE_DIR/tasks.md
|
|
23
|
-
Abort with an error message if any required file is missing (instruct the user to run missing prerequisite command).
|
|
24
|
-
|
|
25
|
-
2. Load artifacts:
|
|
26
|
-
- Parse spec.md sections: Overview/Context, Functional Requirements, Non-Functional Requirements, User Stories, Edge Cases (if present).
|
|
27
|
-
- Parse plan.md: Architecture/stack choices, Data Model references, Phases, Technical constraints.
|
|
28
|
-
- Parse tasks.md: Task IDs, descriptions, phase grouping, parallel markers [P], referenced file paths.
|
|
29
|
-
- Load constitution `.specify/memory/constitution.md` for principle validation.
|
|
30
|
-
|
|
31
|
-
3. Build internal semantic models:
|
|
32
|
-
- Requirements inventory: Each functional + non-functional requirement with a stable key (derive slug based on imperative phrase; e.g., "User can upload file" -> `user-can-upload-file`).
|
|
33
|
-
- User story/action inventory.
|
|
34
|
-
- Task coverage mapping: Map each task to one or more requirements or stories (inference by keyword / explicit reference patterns like IDs or key phrases).
|
|
35
|
-
- Constitution rule set: Extract principle names and any MUST/SHOULD normative statements.
|
|
36
|
-
|
|
37
|
-
4. Detection passes:
|
|
38
|
-
A. Duplication detection:
|
|
39
|
-
- Identify near-duplicate requirements. Mark lower-quality phrasing for consolidation.
|
|
40
|
-
B. Ambiguity detection:
|
|
41
|
-
- Flag vague adjectives (fast, scalable, secure, intuitive, robust) lacking measurable criteria.
|
|
42
|
-
- Flag unresolved placeholders (TODO, TKTK, ???, <placeholder>, etc.).
|
|
43
|
-
C. Underspecification:
|
|
44
|
-
- Requirements with verbs but missing object or measurable outcome.
|
|
45
|
-
- User stories missing acceptance criteria alignment.
|
|
46
|
-
- Tasks referencing files or components not defined in spec/plan.
|
|
47
|
-
D. Constitution alignment:
|
|
48
|
-
- Any requirement or plan element conflicting with a MUST principle.
|
|
49
|
-
- Missing mandated sections or quality gates from constitution.
|
|
50
|
-
E. Coverage gaps:
|
|
51
|
-
- Requirements with zero associated tasks.
|
|
52
|
-
- Tasks with no mapped requirement/story.
|
|
53
|
-
- Non-functional requirements not reflected in tasks (e.g., performance, security).
|
|
54
|
-
F. Inconsistency:
|
|
55
|
-
- Terminology drift (same concept named differently across files).
|
|
56
|
-
- Data entities referenced in plan but absent in spec (or vice versa).
|
|
57
|
-
- Task ordering contradictions (e.g., integration tasks before foundational setup tasks without dependency note).
|
|
58
|
-
- Conflicting requirements (e.g., one requires to use Next.js while other says to use Vue as the framework).
|
|
59
|
-
|
|
60
|
-
5. Severity assignment heuristic:
|
|
61
|
-
- CRITICAL: Violates constitution MUST, missing core spec artifact, or requirement with zero coverage that blocks baseline functionality.
|
|
62
|
-
- HIGH: Duplicate or conflicting requirement, ambiguous security/performance attribute, untestable acceptance criterion.
|
|
63
|
-
- MEDIUM: Terminology drift, missing non-functional task coverage, underspecified edge case.
|
|
64
|
-
- LOW: Style/wording improvements, minor redundancy not affecting execution order.
|
|
65
|
-
|
|
66
|
-
6. Produce a Markdown report (no file writes) with sections:
|
|
67
|
-
|
|
68
|
-
### Specification Analysis Report
|
|
69
|
-
| ID | Category | Severity | Location(s) | Summary | Recommendation |
|
|
70
|
-
|----|----------|----------|-------------|---------|----------------|
|
|
71
|
-
| A1 | Duplication | HIGH | spec.md:L120-134 | Two similar requirements ... | Merge phrasing; keep clearer version |
|
|
72
|
-
(Add one row per finding; generate stable IDs prefixed by category initial.)
|
|
73
|
-
|
|
74
|
-
Additional subsections:
|
|
75
|
-
- Coverage Summary Table:
|
|
76
|
-
| Requirement Key | Has Task? | Task IDs | Notes |
|
|
77
|
-
- Constitution Alignment Issues (if any)
|
|
78
|
-
- Unmapped Tasks (if any)
|
|
79
|
-
- Metrics:
|
|
80
|
-
* Total Requirements
|
|
81
|
-
* Total Tasks
|
|
82
|
-
* Coverage % (requirements with >=1 task)
|
|
83
|
-
* Ambiguity Count
|
|
84
|
-
* Duplication Count
|
|
85
|
-
* Critical Issues Count
|
|
86
|
-
|
|
87
|
-
7. At end of report, output a concise Next Actions block:
|
|
88
|
-
- If CRITICAL issues exist: Recommend resolving before `/implement`.
|
|
89
|
-
- If only LOW/MEDIUM: User may proceed, but provide improvement suggestions.
|
|
90
|
-
- Provide explicit command suggestions: e.g., "Run /specify with refinement", "Run /plan to adjust architecture", "Manually edit tasks.md to add coverage for 'performance-metrics'".
|
|
91
|
-
|
|
92
|
-
8. Ask the user: "Would you like me to suggest concrete remediation edits for the top N issues?" (Do NOT apply them automatically.)
|
|
93
|
-
|
|
94
|
-
Behavior rules:
|
|
95
|
-
- NEVER modify files.
|
|
96
|
-
- NEVER hallucinate missing sections—if absent, report them.
|
|
97
|
-
- KEEP findings deterministic: if rerun without changes, produce consistent IDs and counts.
|
|
98
|
-
- LIMIT total findings in the main table to 50; aggregate remainder in a summarized overflow note.
|
|
99
|
-
- If zero issues found, emit a success report with coverage statistics and proceed recommendation.
|
|
100
|
-
|
|
101
|
-
Context: $ARGUMENTS
|
|
@@ -1,158 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Identify underspecified areas in the current feature spec by asking up to 5 highly targeted clarification questions and encoding answers back into the spec.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
|
|
6
|
-
|
|
7
|
-
User input:
|
|
8
|
-
|
|
9
|
-
$ARGUMENTS
|
|
10
|
-
|
|
11
|
-
Goal: Detect and reduce ambiguity or missing decision points in the active feature specification and record the clarifications directly in the spec file.
|
|
12
|
-
|
|
13
|
-
Note: This clarification workflow is expected to run (and be completed) BEFORE invoking `/plan`. If the user explicitly states they are skipping clarification (e.g., exploratory spike), you may proceed, but must warn that downstream rework risk increases.
|
|
14
|
-
|
|
15
|
-
Execution steps:
|
|
16
|
-
|
|
17
|
-
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --paths-only` from repo root **once** (combined `--json --paths-only` mode / `-Json -PathsOnly`). Parse minimal JSON payload fields:
|
|
18
|
-
- `FEATURE_DIR`
|
|
19
|
-
- `FEATURE_SPEC`
|
|
20
|
-
- (Optionally capture `IMPL_PLAN`, `TASKS` for future chained flows.)
|
|
21
|
-
- If JSON parsing fails, abort and instruct user to re-run `/specify` or verify feature branch environment.
|
|
22
|
-
|
|
23
|
-
2. Load the current spec file. Perform a structured ambiguity & coverage scan using this taxonomy. For each category, mark status: Clear / Partial / Missing. Produce an internal coverage map used for prioritization (do not output raw map unless no questions will be asked).
|
|
24
|
-
|
|
25
|
-
Functional Scope & Behavior:
|
|
26
|
-
- Core user goals & success criteria
|
|
27
|
-
- Explicit out-of-scope declarations
|
|
28
|
-
- User roles / personas differentiation
|
|
29
|
-
|
|
30
|
-
Domain & Data Model:
|
|
31
|
-
- Entities, attributes, relationships
|
|
32
|
-
- Identity & uniqueness rules
|
|
33
|
-
- Lifecycle/state transitions
|
|
34
|
-
- Data volume / scale assumptions
|
|
35
|
-
|
|
36
|
-
Interaction & UX Flow:
|
|
37
|
-
- Critical user journeys / sequences
|
|
38
|
-
- Error/empty/loading states
|
|
39
|
-
- Accessibility or localization notes
|
|
40
|
-
|
|
41
|
-
Non-Functional Quality Attributes:
|
|
42
|
-
- Performance (latency, throughput targets)
|
|
43
|
-
- Scalability (horizontal/vertical, limits)
|
|
44
|
-
- Reliability & availability (uptime, recovery expectations)
|
|
45
|
-
- Observability (logging, metrics, tracing signals)
|
|
46
|
-
- Security & privacy (authN/Z, data protection, threat assumptions)
|
|
47
|
-
- Compliance / regulatory constraints (if any)
|
|
48
|
-
|
|
49
|
-
Integration & External Dependencies:
|
|
50
|
-
- External services/APIs and failure modes
|
|
51
|
-
- Data import/export formats
|
|
52
|
-
- Protocol/versioning assumptions
|
|
53
|
-
|
|
54
|
-
Edge Cases & Failure Handling:
|
|
55
|
-
- Negative scenarios
|
|
56
|
-
- Rate limiting / throttling
|
|
57
|
-
- Conflict resolution (e.g., concurrent edits)
|
|
58
|
-
|
|
59
|
-
Constraints & Tradeoffs:
|
|
60
|
-
- Technical constraints (language, storage, hosting)
|
|
61
|
-
- Explicit tradeoffs or rejected alternatives
|
|
62
|
-
|
|
63
|
-
Terminology & Consistency:
|
|
64
|
-
- Canonical glossary terms
|
|
65
|
-
- Avoided synonyms / deprecated terms
|
|
66
|
-
|
|
67
|
-
Completion Signals:
|
|
68
|
-
- Acceptance criteria testability
|
|
69
|
-
- Measurable Definition of Done style indicators
|
|
70
|
-
|
|
71
|
-
Misc / Placeholders:
|
|
72
|
-
- TODO markers / unresolved decisions
|
|
73
|
-
- Ambiguous adjectives ("robust", "intuitive") lacking quantification
|
|
74
|
-
|
|
75
|
-
For each category with Partial or Missing status, add a candidate question opportunity unless:
|
|
76
|
-
- Clarification would not materially change implementation or validation strategy
|
|
77
|
-
- Information is better deferred to planning phase (note internally)
|
|
78
|
-
|
|
79
|
-
3. Generate (internally) a prioritized queue of candidate clarification questions (maximum 5). Do NOT output them all at once. Apply these constraints:
|
|
80
|
-
- Maximum of 5 total questions across the whole session.
|
|
81
|
-
- Each question must be answerable with EITHER:
|
|
82
|
-
* A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
|
|
83
|
-
* A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
|
|
84
|
-
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
|
|
85
|
-
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
|
|
86
|
-
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
|
|
87
|
-
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
|
|
88
|
-
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
|
|
89
|
-
|
|
90
|
-
4. Sequential questioning loop (interactive):
|
|
91
|
-
- Present EXACTLY ONE question at a time.
|
|
92
|
-
- For multiple‑choice questions render options as a Markdown table:
|
|
93
|
-
|
|
94
|
-
| Option | Description |
|
|
95
|
-
|--------|-------------|
|
|
96
|
-
| A | <Option A description> |
|
|
97
|
-
| B | <Option B description> |
|
|
98
|
-
| C | <Option C description> | (add D/E as needed up to 5)
|
|
99
|
-
| Short | Provide a different short answer (<=5 words) | (Include only if free-form alternative is appropriate)
|
|
100
|
-
|
|
101
|
-
- For short‑answer style (no meaningful discrete options), output a single line after the question: `Format: Short answer (<=5 words)`.
|
|
102
|
-
- After the user answers:
|
|
103
|
-
* Validate the answer maps to one option or fits the <=5 word constraint.
|
|
104
|
-
* If ambiguous, ask for a quick disambiguation (count still belongs to same question; do not advance).
|
|
105
|
-
* Once satisfactory, record it in working memory (do not yet write to disk) and move to the next queued question.
|
|
106
|
-
- Stop asking further questions when:
|
|
107
|
-
* All critical ambiguities resolved early (remaining queued items become unnecessary), OR
|
|
108
|
-
* User signals completion ("done", "good", "no more"), OR
|
|
109
|
-
* You reach 5 asked questions.
|
|
110
|
-
- Never reveal future queued questions in advance.
|
|
111
|
-
- If no valid questions exist at start, immediately report no critical ambiguities.
|
|
112
|
-
|
|
113
|
-
5. Integration after EACH accepted answer (incremental update approach):
|
|
114
|
-
- Maintain in-memory representation of the spec (loaded once at start) plus the raw file contents.
|
|
115
|
-
- For the first integrated answer in this session:
|
|
116
|
-
* Ensure a `## Clarifications` section exists (create it just after the highest-level contextual/overview section per the spec template if missing).
|
|
117
|
-
* Under it, create (if not present) a `### Session YYYY-MM-DD` subheading for today.
|
|
118
|
-
- Append a bullet line immediately after acceptance: `- Q: <question> → A: <final answer>`.
|
|
119
|
-
- Then immediately apply the clarification to the most appropriate section(s):
|
|
120
|
-
* Functional ambiguity → Update or add a bullet in Functional Requirements.
|
|
121
|
-
* User interaction / actor distinction → Update User Stories or Actors subsection (if present) with clarified role, constraint, or scenario.
|
|
122
|
-
* Data shape / entities → Update Data Model (add fields, types, relationships) preserving ordering; note added constraints succinctly.
|
|
123
|
-
* Non-functional constraint → Add/modify measurable criteria in Non-Functional / Quality Attributes section (convert vague adjective to metric or explicit target).
|
|
124
|
-
* Edge case / negative flow → Add a new bullet under Edge Cases / Error Handling (or create such subsection if template provides placeholder for it).
|
|
125
|
-
* Terminology conflict → Normalize term across spec; retain original only if necessary by adding `(formerly referred to as "X")` once.
|
|
126
|
-
- If the clarification invalidates an earlier ambiguous statement, replace that statement instead of duplicating; leave no obsolete contradictory text.
|
|
127
|
-
- Save the spec file AFTER each integration to minimize risk of context loss (atomic overwrite).
|
|
128
|
-
- Preserve formatting: do not reorder unrelated sections; keep heading hierarchy intact.
|
|
129
|
-
- Keep each inserted clarification minimal and testable (avoid narrative drift).
|
|
130
|
-
|
|
131
|
-
6. Validation (performed after EACH write plus final pass):
|
|
132
|
-
- Clarifications session contains exactly one bullet per accepted answer (no duplicates).
|
|
133
|
-
- Total asked (accepted) questions ≤ 5.
|
|
134
|
-
- Updated sections contain no lingering vague placeholders the new answer was meant to resolve.
|
|
135
|
-
- No contradictory earlier statement remains (scan for now-invalid alternative choices removed).
|
|
136
|
-
- Markdown structure valid; only allowed new headings: `## Clarifications`, `### Session YYYY-MM-DD`.
|
|
137
|
-
- Terminology consistency: same canonical term used across all updated sections.
|
|
138
|
-
|
|
139
|
-
7. Write the updated spec back to `FEATURE_SPEC`.
|
|
140
|
-
|
|
141
|
-
8. Report completion (after questioning loop ends or early termination):
|
|
142
|
-
- Number of questions asked & answered.
|
|
143
|
-
- Path to updated spec.
|
|
144
|
-
- Sections touched (list names).
|
|
145
|
-
- Coverage summary table listing each taxonomy category with Status: Resolved (was Partial/Missing and addressed), Deferred (exceeds question quota or better suited for planning), Clear (already sufficient), Outstanding (still Partial/Missing but low impact).
|
|
146
|
-
- If any Outstanding or Deferred remain, recommend whether to proceed to `/plan` or run `/clarify` again later post-plan.
|
|
147
|
-
- Suggested next command.
|
|
148
|
-
|
|
149
|
-
Behavior rules:
|
|
150
|
-
- If no meaningful ambiguities found (or all potential questions would be low-impact), respond: "No critical ambiguities detected worth formal clarification." and suggest proceeding.
|
|
151
|
-
- If spec file missing, instruct user to run `/specify` first (do not create a new spec here).
|
|
152
|
-
- Never exceed 5 total asked questions (clarification retries for a single question do not count as new questions).
|
|
153
|
-
- Avoid speculative tech stack questions unless the absence blocks functional clarity.
|
|
154
|
-
- Respect user early termination signals ("stop", "done", "proceed").
|
|
155
|
-
- If no questions asked due to full coverage, output a compact coverage summary (all categories Clear) then suggest advancing.
|
|
156
|
-
- If quota reached with unresolved high-impact categories remaining, explicitly flag them under Deferred with rationale.
|
|
157
|
-
|
|
158
|
-
Context for prioritization: $ARGUMENTS
|