speccrew 0.7.63 → 0.7.64

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.
@@ -14,248 +14,4 @@ tools: Read, Write, Glob, Grep
14
14
 
15
15
  <!-- @agentflow: SKILL.xml -->
16
16
 
17
- > **REQUIRED**: Before executing this workflow, read the XML workflow specification: `speccrew-workspace/docs/rules/agentflow-spec.md`
18
-
19
- ## Workflow
20
-
21
- ## Absolute Constraints
22
-
23
- > **These rules apply to ALL steps. Violation = task failure.**
24
-
25
- 1. **READ-ONLY on Feature Spec and API Contract** — NEVER modify Feature Spec or API Contract documents. Only read for analysis.
26
- 2. **READ-ONLY on techs knowledge** — NEVER modify techs knowledge files. Only read for capability assessment.
27
- 3. **Evidence-based evaluation** — Every recommendation MUST cite specific Feature Spec requirements and specific tech stack limitations.
28
- 4. **No assumptions** — DO NOT assume framework capabilities. Only recommend frameworks with documented capabilities.
29
-
30
- ## Step 1: Read Inputs
31
-
32
- **Input Parameters** (from agent context):
33
-
34
- | Parameter | Required | Description |
35
- |-----------|----------|-------------|
36
- | `feature_spec_paths` | Yes | Array of Feature Spec file paths |
37
- | `api_contract_paths` | Yes | Array of API Contract file paths |
38
- | `techs_knowledge_paths` | Yes | Object with platform_id → knowledge paths mapping |
39
- | `iteration_path` | Yes | Current iteration directory path |
40
- | `output_path` | No | Output file path (default: `iteration_path/03.system-design/framework-evaluation.md`) |
41
-
42
- Read in order:
43
-
44
- 1. **All Feature Spec documents** — Extract functional requirements, especially:
45
- - Real-time features (WebSocket, SSE, push notifications)
46
- - File processing (upload, download, preview, conversion)
47
- - Data visualization (charts, dashboards, reports)
48
- - Rich text / editor features
49
- - Map / geolocation features
50
- - Payment / third-party integrations
51
- - Search / filtering / pagination patterns
52
- - Media processing (image, video, audio)
53
-
54
- 2. **All API Contract documents** — Extract:
55
- - Communication protocols (REST, GraphQL, WebSocket, gRPC)
56
- - Authentication patterns (JWT, OAuth, Session)
57
- - Data formats (JSON, protobuf, multipart)
58
-
59
- 3. **Techs knowledge per platform**:
60
- - `tech-stack.md` — Current frameworks, libraries, versions
61
- - `architecture.md` — Current architecture patterns
62
- - `conventions-design.md` — Design conventions
63
- - `conventions-dev.md` — Development conventions
64
-
65
- ## Step 2: Gap Analysis
66
-
67
- For each requirement extracted in Step 1, evaluate against current tech stack:
68
-
69
- ### 2.1 Build Capability Matrix
70
-
71
- | Requirement Category | Specific Requirement | Source (Feature ID) | Current Stack Support | Gap? |
72
- |---------------------|---------------------|--------------------|-----------------------|------|
73
- | Real-time | WebSocket connections | F-CRM-01 | Not in current stack | YES |
74
- | File Processing | PDF preview | F-ORD-02 | Not in current stack | YES |
75
- | Data Viz | Dashboard charts | F-RPT-01 | Not in current stack | YES |
76
- | Authentication | JWT token | F-SYS-01 | Already supported | NO |
77
-
78
- ### 2.2 Categorize Gaps
79
-
80
- Group identified gaps by category:
81
-
82
- - **Critical Gaps**: Core functionality cannot be implemented without new framework
83
- - **Enhancement Gaps**: Functionality possible but significantly better with dedicated library
84
- - **Optional Gaps**: Nice-to-have improvements, current stack can handle acceptably
85
-
86
- ## Step 3: Framework Research
87
-
88
- For each identified gap (Critical and Enhancement only):
89
-
90
- ### 3.1 Evaluate Candidates
91
-
92
- For each gap, research and evaluate 1-3 candidate frameworks/libraries:
93
-
94
- | Evaluation Criteria | Description |
95
- |--------------------|-------------|
96
- | **Functionality Fit** | Does it solve the specific capability gap? |
97
- | **License** | MIT, Apache 2.0, BSD preferred. GPL requires flagging. |
98
- | **Maturity** | GitHub stars, npm downloads, last release date, version stability |
99
- | **Bundle Size** | Impact on frontend bundle (if applicable) |
100
- | **Integration Complexity** | How much existing code needs modification? |
101
- | **Community & Docs** | Documentation quality, community support, ecosystem |
102
-
103
- ### 3.2 Make Recommendations
104
-
105
- For each gap, provide a single primary recommendation with justification.
106
-
107
- ## Step 4: Generate Report
108
-
109
- Write the framework evaluation report to `output_path`.
110
-
111
- ### Report Structure (When Gaps Found)
112
-
113
- ```markdown
114
- # Framework Evaluation Report — iteration_name
115
-
116
- ## 1. Evaluation Summary
117
-
118
- - **Iteration**: iteration_name
119
- - **Feature Specs Analyzed**: feature_count
120
- - **Platforms Evaluated**: platform_count
121
- - **Capability Gaps Found**: gap_count
122
- - **New Frameworks Recommended**: framework_count
123
-
124
- ## 2. Capability Gap Analysis
125
-
126
- ### 2.1 Gap Summary
127
-
128
- | # | Gap Category | Specific Gap | Severity | Source Features | Recommendation |
129
- |---|-------------|-------------|----------|----------------|---------------|
130
- | 1 | Real-time | WebSocket support | Critical | F-CRM-01, F-MSG-01 | Socket.IO |
131
- | 2 | Data Viz | Chart rendering | Enhancement | F-RPT-01 | ECharts |
132
- | ... | ... | ... | ... | ... | ... |
133
-
134
- ### 2.2 Detailed Gap Analysis
135
-
136
- #### Gap 1: {Gap Name}
137
-
138
- **Requirement Source**: {Feature IDs and specific requirement text}
139
- **Current Stack Status**: {What the current stack provides/lacks}
140
- **Impact**: {What cannot be implemented without addressing this gap}
141
-
142
- ## 3. Framework Recommendations
143
-
144
- ### 3.1 Recommendation Summary
145
-
146
- | # | Framework | Version | License | For Gap | Platform | Integration Impact |
147
- |---|-----------|---------|---------|---------|----------|-------------------|
148
- | 1 | Socket.IO | ^4.x | MIT | WebSocket support | backend + web | Medium |
149
- | 2 | ECharts | ^5.x | Apache 2.0 | Chart rendering | web | Low |
150
-
151
- ### 3.2 Detailed Recommendations
152
-
153
- #### Recommendation 1: {Framework Name}
154
-
155
- - **Solves Gap**: {gap description}
156
- - **License**: {license type}
157
- - **Maturity**: {stars, downloads, last release}
158
- - **Integration Impact**: Low / Medium / High
159
- - **Integration Notes**: {specific integration considerations}
160
- - **Alternatives Considered**: {other options and why not chosen}
161
-
162
- ## 4. No-Change Confirmations
163
-
164
- Capabilities already covered by current stack:
165
- - {capability 1}: Covered by {existing framework}
166
- - {capability 2}: Covered by {existing framework}
167
-
168
- ## 5. Version Constraints
169
-
170
- | Framework | Required Version | Constraint Reason |
171
- |-----------|-----------------|-------------------|
172
- | {name} | {version range} | {compatibility reason} |
173
- ```
174
-
175
- ### Simplified Report Structure (When No Gaps Found)
176
-
177
- ```markdown
178
- # Framework Evaluation Report — iteration_name
179
-
180
- ## 1. Evaluation Summary
181
-
182
- - **Feature Specs Analyzed**: feature_count
183
- - **Platforms Evaluated**: platform_count
184
- - **Capability Gaps Found**: 0
185
- - **New Frameworks Recommended**: 0
186
-
187
- ## 2. Assessment
188
-
189
- All Feature Spec requirements can be fully implemented with the current technology stack. No new frameworks or libraries are needed.
190
-
191
- ### Capabilities Confirmed
192
- - {list each major capability confirmed as supported}
193
-
194
- ## 3. Conclusion
195
-
196
- Current tech stack is sufficient. Proceed to system design without framework changes.
197
- ```
198
-
199
- ## Step 5: Output Task Completion Report
200
-
201
- After writing the report, output:
202
-
203
- ```
204
- --- TASK COMPLETION REPORT ---
205
- Task: Framework Evaluation
206
- Status: SUCCESS
207
- Output: output_path
208
- Gaps Found: gap_count
209
- Frameworks Recommended: framework_count
210
- --- END REPORT ---
211
- ```
212
-
213
- If any step fails:
214
-
215
- ```
216
- --- TASK COMPLETION REPORT ---
217
- Task: Framework Evaluation
218
- Status: FAILED
219
- Error: {specific error description}
220
- Failed At: Step {N}
221
- --- END REPORT ---
222
- ```
223
-
224
- ## OUTPUT EFFICIENCY RULES
225
-
226
- When executing this skill:
227
-
228
- 1. **Direct-to-File Output**: All design content (architecture diagrams, API mappings, component specifications, data models) MUST be written directly to the output file
229
- 2. **Minimal Conversation Output**: Only output:
230
- - Block execution announcements (1 line each): `"[Block XX] Designing..."`
231
- - Error messages requiring attention
232
- - Task Completion Report (final summary)
233
- 3. **FORBIDDEN in conversation**:
234
- - ❌ Full document sections or drafts
235
- - ❌ Mermaid diagrams displayed in chat
236
- - ❌ API endpoint listings
237
- - ❌ Data model tables
238
- - ❌ Architecture descriptions longer than 2 lines
239
- 4. **Rationale**: Workers run in batch mode. Displaying design content in conversation wastes context window and provides no value since content goes to file anyway.
240
-
241
- # Key Rules
242
-
243
- | Rule | Description |
244
- |------|-------------|
245
- | **READ-ONLY Inputs** | Feature Spec, API Contract, and techs knowledge are reference only — never modify |
246
- | **Evidence-based** | Every gap and recommendation must cite specific requirement sources |
247
- | **Gap Categories** | Only Critical and Enhancement gaps require framework recommendations |
248
- | **License Awareness** | GPL and copyleft licenses must be flagged in recommendations |
249
- | **No Assumptions** | Only recommend frameworks with documented, verified capabilities |
250
-
251
- # Checklist
252
-
253
- - [ ] All Feature Spec documents read and requirements extracted
254
- - [ ] All API Contract documents read and protocols identified
255
- - [ ] Techs knowledge loaded for all platforms
256
- - [ ] Capability matrix built with all requirements mapped
257
- - [ ] Gaps categorized by severity (Critical/Enhancement/Optional)
258
- - [ ] Framework candidates evaluated against criteria
259
- - [ ] Primary recommendations made for each gap
260
- - [ ] Report generated with correct structure
261
- - [ ] Task Completion Report output
17
+ > **REQUIRED**: Read and execute the XML workflow above. The XML contains the complete workflow definition including all steps, rules, conditions, and checklist.
@@ -36,6 +36,19 @@
36
36
  <field name="text">Only recommend frameworks with documented capabilities</field>
37
37
  </block>
38
38
 
39
+ <block type="rule" id="R5" level="mandatory" desc="Direct-to-File Output">
40
+ <field name="text">All design content MUST be written directly to the output file</field>
41
+ </block>
42
+
43
+ <block type="rule" id="R6" level="mandatory" desc="Minimal Conversation Output">
44
+ <field name="text">Only output block execution announcements, error messages, and Task Completion Report</field>
45
+ </block>
46
+
47
+ <block type="rule" id="R7" level="forbidden" desc="No conversation document output">
48
+ <field name="text">NEVER display full document sections, Mermaid diagrams, API endpoint listings, data model tables in conversation</field>
49
+ <field name="text">NEVER display architecture descriptions longer than 2 lines in conversation</field>
50
+ </block>
51
+
39
52
  <!-- ============================================================
40
53
  Main Processing Sequence
41
54
  ============================================================ -->
@@ -219,8 +232,34 @@ Frameworks Recommended: ${recommendations.length}
219
232
  </branch>
220
233
  </block>
221
234
 
235
+ <block type="checkpoint" id="CP2" name="final_checklist" desc="Framework Evaluation Final Checklist">
236
+ <field name="conditions">
237
+ feature_specs_read: all Feature Spec documents read and requirements extracted,
238
+ api_contracts_read: all API Contract documents read and protocols identified,
239
+ techs_knowledge_loaded: techs knowledge loaded for all platforms,
240
+ capability_matrix_built: capability matrix built with all requirements mapped,
241
+ gaps_categorized: gaps categorized by severity (Critical/Enhancement/Optional),
242
+ framework_candidates_evaluated: framework candidates evaluated against criteria,
243
+ primary_recommendations_made: primary recommendations made for each gap,
244
+ report_generated: report generated with correct structure,
245
+ task_completion_report_output: task completion report output
246
+ </field>
247
+ </block>
248
+
222
249
  </sequence>
223
250
 
251
+ <!-- ============================================================
252
+ Failure Report Format
253
+ ============================================================ -->
254
+ <block type="event" id="E4" action="log" level="error" desc="Task failure report">
255
+ <field name="message">--- TASK COMPLETION REPORT ---
256
+ Task: Framework Evaluation
257
+ Status: FAILED
258
+ Error: {specific error description}
259
+ Failed At: Step {N}
260
+ --- END REPORT ---</field>
261
+ </block>
262
+
224
263
  <!-- ============================================================
225
264
  Output Results
226
265
  ============================================================ -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "speccrew",
3
- "version": "0.7.63",
3
+ "version": "0.7.64",
4
4
  "description": "Spec-Driven Development toolkit for AI-powered IDEs",
5
5
  "author": "charlesmu99",
6
6
  "repository": {