@gravirei/reis 1.2.3 β 2.1.0-beta.1
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/CHANGELOG.md +318 -0
- package/README.md +305 -149
- package/bin/reis.js +39 -4
- package/docs/CHECKPOINTS.md +728 -0
- package/docs/CONFIG_GUIDE.md +922 -0
- package/docs/MIGRATION_GUIDE.md +420 -0
- package/docs/V2_FEATURES.md +910 -0
- package/docs/VERIFICATION.md +427 -0
- package/docs/WAVE_EXECUTION.md +606 -0
- package/docs/debugger/API_REFERENCE.md +306 -0
- package/docs/debugger/USER_GUIDE.md +409 -0
- package/examples/advanced-features/.planning/phases/phase-2-api/2-1-rest-endpoints.PLAN.md +865 -0
- package/examples/advanced-features/PROJECT.md +133 -0
- package/examples/advanced-features/README.md +283 -0
- package/examples/advanced-features/ROADMAP.md +291 -0
- package/examples/advanced-features/TUTORIAL.md +325 -0
- package/examples/advanced-features/reis.config.js +65 -0
- package/examples/basic-workflow/.planning/phases/phase-1-setup/1-1-initial-setup.PLAN.md +347 -0
- package/examples/basic-workflow/PROJECT.md +53 -0
- package/examples/basic-workflow/README.md +135 -0
- package/examples/basic-workflow/REQUIREMENTS.md +144 -0
- package/examples/basic-workflow/ROADMAP.md +177 -0
- package/examples/basic-workflow/STATE.md +67 -0
- package/examples/basic-workflow/reis.config.js +40 -0
- package/examples/migration-example/README.md +342 -0
- package/examples/migration-example/v1-project/PROJECT.md +33 -0
- package/examples/migration-example/v1-project/ROADMAP.md +105 -0
- package/examples/migration-example/v2-project/PROJECT.md +37 -0
- package/examples/migration-example/v2-project/ROADMAP.md +263 -0
- package/examples/migration-example/v2-project/reis.config.js +42 -0
- package/examples/sample-configs/README.md +343 -0
- package/examples/sample-configs/ci-cd.reis.config.js +135 -0
- package/examples/sample-configs/minimal.reis.config.js +25 -0
- package/examples/sample-configs/solo-developer.reis.config.js +73 -0
- package/examples/sample-configs/team-optimized.reis.config.js +92 -0
- package/lib/commands/checkpoint.js +336 -0
- package/lib/commands/config.js +324 -0
- package/lib/commands/debug.js +325 -12
- package/lib/commands/execute-plan.js +309 -7
- package/lib/commands/resume.js +348 -7
- package/lib/commands/verify.js +242 -19
- package/lib/commands/visualize.js +194 -0
- package/lib/utils/config.js +263 -0
- package/lib/utils/debug-analyzer.js +723 -0
- package/lib/utils/fix-plan-generator.js +490 -0
- package/lib/utils/git-integration.js +422 -0
- package/lib/utils/issue-classifier.js +531 -0
- package/lib/utils/metrics-tracker.js +483 -0
- package/lib/utils/pattern-matcher.js +341 -0
- package/lib/utils/plan-validator.js +439 -0
- package/lib/utils/solution-designer.js +486 -0
- package/lib/utils/state-manager.js +465 -0
- package/lib/utils/visualizer.js +439 -0
- package/lib/utils/wave-executor.js +407 -0
- package/package.json +17 -7
- package/subagents/reis_debugger.md +1748 -0
- package/subagents/reis_verifier.md +3066 -0
- package/templates/CONFIG_DOCS.md +497 -0
- package/templates/DEBUG_REPORT.md +233 -0
- package/templates/FIX_PLAN.md +220 -0
- package/templates/STATE_VERIFICATION_ENTRY.md +60 -0
- package/templates/VERIFICATION_REPORT.md +183 -0
- package/templates/reis.config.template.js +138 -0
- package/docs/.gitkeep +0 -0
- package/docs/COMPLETE_COMMANDS.md +0 -528
- package/docs/INTEGRATION_GUIDE.md +0 -407
- package/docs/QUICK_REFERENCE.md +0 -250
- package/docs/README.md +0 -249
- package/docs/README_DOCS.md +0 -193
- package/docs/SHORTCUT_GUIDE.md +0 -361
- package/docs/WORKFLOW_EXAMPLES.md +0 -973
- package/docs/shortcuts.json +0 -40
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to REIS will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [2.0.0-beta.1] - 2024-01-XX
|
|
9
|
+
|
|
10
|
+
### Added - REIS Verifier π
|
|
11
|
+
|
|
12
|
+
**Major Feature: Automated Verification with FR4.1 Feature Completeness Validation**
|
|
13
|
+
|
|
14
|
+
- **`reis verify` command** - Automated verification of execution results
|
|
15
|
+
- Verify phases: `reis verify 2` or `reis verify phase-2`
|
|
16
|
+
- Verify plans: `reis verify path/to/plan.PLAN.md`
|
|
17
|
+
- Options: `--verbose` for detailed output, `--strict` for strict mode
|
|
18
|
+
|
|
19
|
+
- **reis_verifier subagent** - Comprehensive verification agent
|
|
20
|
+
- 7-step verification protocol
|
|
21
|
+
- Automated test execution and parsing
|
|
22
|
+
- Code quality checks (syntax, linting)
|
|
23
|
+
- Success criteria validation
|
|
24
|
+
- Documentation verification
|
|
25
|
+
- Detailed report generation
|
|
26
|
+
- STATE.md integration
|
|
27
|
+
|
|
28
|
+
- **FR4.1: Feature Completeness Validation** - CRITICAL NEW CAPABILITY
|
|
29
|
+
- Detects when executor skips tasks or leaves features incomplete
|
|
30
|
+
- Parses all tasks from PLAN.md
|
|
31
|
+
- Extracts expected deliverables (files, functions, classes, endpoints)
|
|
32
|
+
- Verifies each deliverable exists in codebase using multiple methods:
|
|
33
|
+
* File existence checks (fs, git ls-files)
|
|
34
|
+
* Code pattern matching (grep for functions/classes)
|
|
35
|
+
* Git diff analysis
|
|
36
|
+
* Test presence verification
|
|
37
|
+
- Calculates task completion percentage (Tasks complete / Total tasks)
|
|
38
|
+
- **Requires 100% task completion to pass verification**
|
|
39
|
+
- Reports missing deliverables with search evidence
|
|
40
|
+
- Impact assessment (HIGH/MEDIUM/LOW) for incomplete tasks
|
|
41
|
+
- Specific recommendations for fixing incomplete features
|
|
42
|
+
|
|
43
|
+
- **Verification Reports** - Comprehensive markdown reports
|
|
44
|
+
- Executive summary with key metrics
|
|
45
|
+
- Feature Completeness section (task-by-task breakdown)
|
|
46
|
+
- Test results with failure details
|
|
47
|
+
- Success criteria validation
|
|
48
|
+
- Code quality metrics
|
|
49
|
+
- Documentation status
|
|
50
|
+
- Issues summary (critical/major/minor)
|
|
51
|
+
- Actionable recommendations
|
|
52
|
+
- Saved to `.planning/verification/{phase}/VERIFICATION_REPORT.md`
|
|
53
|
+
|
|
54
|
+
- **Templates**
|
|
55
|
+
- `templates/VERIFICATION_REPORT.md` - Report template with FR4.1 section
|
|
56
|
+
- `templates/STATE_VERIFICATION_ENTRY.md` - STATE.md entry template
|
|
57
|
+
|
|
58
|
+
- **Documentation**
|
|
59
|
+
- `docs/VERIFICATION.md` - Comprehensive verification guide
|
|
60
|
+
- README.md updated with verification section
|
|
61
|
+
- FR4.1 Feature Completeness extensively documented
|
|
62
|
+
- Examples and best practices
|
|
63
|
+
|
|
64
|
+
- **Test Suite**
|
|
65
|
+
- Comprehensive tests for verify command
|
|
66
|
+
- FR4.1 feature completeness validation tests
|
|
67
|
+
- Scenario tests (complete/incomplete tasks, tests pass/fail)
|
|
68
|
+
- Test coverage for all verification components
|
|
69
|
+
|
|
70
|
+
### Why FR4.1 Matters
|
|
71
|
+
|
|
72
|
+
Previous verification approaches only checked if tests passed. This meant:
|
|
73
|
+
- β Executor could skip tasks without detection
|
|
74
|
+
- β Tests might pass but features were missing
|
|
75
|
+
- β Incomplete implementations went unnoticed
|
|
76
|
+
|
|
77
|
+
FR4.1 solves this by:
|
|
78
|
+
- β
Verifying ALL planned tasks are implemented
|
|
79
|
+
- β
Checking that deliverables actually exist
|
|
80
|
+
- β
Providing evidence for completeness
|
|
81
|
+
- β
Requiring 100% task completion before proceeding
|
|
82
|
+
|
|
83
|
+
### Example
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
$ reis verify phase-2
|
|
87
|
+
|
|
88
|
+
β VERIFICATION FAILED
|
|
89
|
+
- Feature Completeness: 66% (1 task incomplete)
|
|
90
|
+
- Task 2: Build Password Reset - INCOMPLETE
|
|
91
|
+
Missing: src/auth/password-reset.js, sendResetEmail()
|
|
92
|
+
|
|
93
|
+
# After fixing
|
|
94
|
+
$ reis verify phase-2
|
|
95
|
+
|
|
96
|
+
β
VERIFICATION PASSED
|
|
97
|
+
- Feature Completeness: 100% (3/3 tasks)
|
|
98
|
+
- All checks passed
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Technical Details
|
|
102
|
+
|
|
103
|
+
- Verification protocol: 7 steps (load β test β quality β FR4.1 β docs β report β state)
|
|
104
|
+
- FR4.1 uses file existence, grep patterns, git diff for verification
|
|
105
|
+
- Confidence scoring (0.7-1.0) prevents false positives
|
|
106
|
+
- Handles refactoring and file renames gracefully
|
|
107
|
+
- Integration with STATE.md for verification history
|
|
108
|
+
|
|
109
|
+
### Breaking Changes
|
|
110
|
+
|
|
111
|
+
None - This is a new feature addition.
|
|
112
|
+
|
|
113
|
+
### Migration
|
|
114
|
+
|
|
115
|
+
No migration needed. Existing projects can immediately use `reis verify`.
|
|
116
|
+
|
|
117
|
+
### Credits
|
|
118
|
+
|
|
119
|
+
FR4.1 Feature Completeness Validation was designed to solve the critical gap of detecting incomplete implementations that tests alone cannot catch.
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## [2.0.0-beta.1] - 2026-01-18 (Phase 4 Wave 1-2 Complete)
|
|
124
|
+
|
|
125
|
+
### Added - Phase 4 Wave 1-2: Visualization & Performance
|
|
126
|
+
- **Visualizer Utility** (`lib/utils/visualizer.js`)
|
|
127
|
+
- ASCII bar charts for metrics
|
|
128
|
+
- Timeline visualization for roadmap phases
|
|
129
|
+
- Progress bars with ETA
|
|
130
|
+
- Distribution charts for statistics
|
|
131
|
+
- Tables with borders and alignment
|
|
132
|
+
- Terminal-safe, width-adaptive rendering
|
|
133
|
+
- Color and monochrome mode support
|
|
134
|
+
|
|
135
|
+
- **Visualize Command** (`lib/commands/visualize.js`)
|
|
136
|
+
- Real-time progress visualization
|
|
137
|
+
- Wave execution timeline
|
|
138
|
+
- Roadmap overview
|
|
139
|
+
- Metrics dashboard
|
|
140
|
+
- Watch mode with auto-refresh (5s intervals)
|
|
141
|
+
- Compact and colorless modes
|
|
142
|
+
|
|
143
|
+
- **Performance Benchmarks** (`test/performance.test.js`)
|
|
144
|
+
- Baseline metrics for all utilities
|
|
145
|
+
- Config load: <50ms
|
|
146
|
+
- STATE.md operations: <100ms
|
|
147
|
+
- Git commits: <250ms
|
|
148
|
+
- Wave parsing: <150ms
|
|
149
|
+
- Metrics operations: <10ms
|
|
150
|
+
- Validation: <200ms
|
|
151
|
+
- Visualization rendering: <10ms
|
|
152
|
+
- Memory profiling for large operations
|
|
153
|
+
|
|
154
|
+
### Technical Details
|
|
155
|
+
- 297 tests passing (58 new tests for Phase 4 Wave 1-2)
|
|
156
|
+
- All performance targets met and validated
|
|
157
|
+
- Regression detection baselines established
|
|
158
|
+
|
|
159
|
+
## [2.0.0-alpha.3] - 2026-01-18 (Phase 3 Complete)
|
|
160
|
+
|
|
161
|
+
### Added - Phase 3: Advanced Features
|
|
162
|
+
- **Plan Validator** (`lib/utils/plan-validator.js`)
|
|
163
|
+
- Validate PLAN.md structure and syntax
|
|
164
|
+
- Check wave definitions and dependencies
|
|
165
|
+
- Validate task completeness (files, actions, verification)
|
|
166
|
+
- Detect circular dependencies
|
|
167
|
+
- Provide actionable error messages
|
|
168
|
+
|
|
169
|
+
- **Metrics Tracker** (`lib/utils/metrics-tracker.js`)
|
|
170
|
+
- Track wave execution metrics (duration, success rate)
|
|
171
|
+
- Log deviations and blockers
|
|
172
|
+
- Calculate phase-level and overall statistics
|
|
173
|
+
- Export metrics for analysis
|
|
174
|
+
- JSON-based metrics storage
|
|
175
|
+
|
|
176
|
+
### Technical Details
|
|
177
|
+
- 239 tests passing (82 new tests for Phase 3)
|
|
178
|
+
- Full validator coverage with edge cases
|
|
179
|
+
- Metrics persistence and retrieval
|
|
180
|
+
- Performance validated (<10ms operations)
|
|
181
|
+
|
|
182
|
+
## [2.0.0-alpha.2] - 2026-01-18 (Phase 2 Complete)
|
|
183
|
+
|
|
184
|
+
### Added - Phase 2: Command Enhancement
|
|
185
|
+
- **Enhanced execute-plan Command** (`lib/commands/execute-plan.js`)
|
|
186
|
+
- Wave-based execution with automatic checkpoints
|
|
187
|
+
- Parallel wave detection and dependency resolution
|
|
188
|
+
- Interactive mode with wave-by-wave confirmation
|
|
189
|
+
- Deviation detection and logging
|
|
190
|
+
- Git integration for wave completion commits
|
|
191
|
+
|
|
192
|
+
- **Checkpoint Command** (`lib/commands/checkpoint.js`)
|
|
193
|
+
- Manual checkpoint creation with custom messages
|
|
194
|
+
- Automatic checkpoint creation between waves
|
|
195
|
+
- List all checkpoints with --list flag
|
|
196
|
+
- Git commit integration with refs/reis/checkpoints
|
|
197
|
+
|
|
198
|
+
- **Resume Command** (`lib/commands/resume.js`)
|
|
199
|
+
- Smart resume with context-aware recommendations
|
|
200
|
+
- Resume from specific checkpoint with git diff display
|
|
201
|
+
- Continue wave execution from interruption point
|
|
202
|
+
- Blocker detection and next steps display
|
|
203
|
+
|
|
204
|
+
- **Config Command** (`lib/commands/config.js`)
|
|
205
|
+
- Initialize reis.config.js in project root
|
|
206
|
+
- Show current configuration (merged defaults + overrides)
|
|
207
|
+
- Validate configuration files
|
|
208
|
+
- Interactive config setup
|
|
209
|
+
|
|
210
|
+
### Technical Details
|
|
211
|
+
- 157 tests passing (109 new tests for Phase 2)
|
|
212
|
+
- Integration tests for command workflows
|
|
213
|
+
- E2E scenario tests for real developer workflows
|
|
214
|
+
- Backward compatible with REIS v1.x projects
|
|
215
|
+
|
|
216
|
+
## [2.0.0-alpha.1] - 2026-01-18 (Phase 1 Complete)
|
|
217
|
+
|
|
218
|
+
### Added - Phase 1: Foundation
|
|
219
|
+
- **Config System** (`lib/utils/config.js`)
|
|
220
|
+
- Load and validate `reis.config.js` from project root
|
|
221
|
+
- Wave size configuration (small/medium/large)
|
|
222
|
+
- Git integration settings
|
|
223
|
+
- Deep merge with defaults
|
|
224
|
+
- Comprehensive validation
|
|
225
|
+
|
|
226
|
+
- **Enhanced State Management** (`lib/utils/state-manager.js`)
|
|
227
|
+
- Wave tracking with start/complete/progress
|
|
228
|
+
- Checkpoint management with history
|
|
229
|
+
- Activity logging with timestamps
|
|
230
|
+
- Metrics tracking (success rate, duration)
|
|
231
|
+
- Markdown-based state persistence
|
|
232
|
+
|
|
233
|
+
- **Git Integration** (`lib/utils/git-integration.js`)
|
|
234
|
+
- Repository detection and status checking
|
|
235
|
+
- Structured commits with metadata
|
|
236
|
+
- Wave completion auto-commits
|
|
237
|
+
- Checkpoint commits and milestone tagging
|
|
238
|
+
- Branch management and rollback support
|
|
239
|
+
|
|
240
|
+
- **Wave Execution Engine** (`lib/utils/wave-executor.js`)
|
|
241
|
+
- Parse PLAN.md into Wave objects
|
|
242
|
+
- Wave lifecycle management
|
|
243
|
+
- Sequential execution with auto-checkpoints
|
|
244
|
+
- Deviation detection and reporting
|
|
245
|
+
- Resume from checkpoint capability
|
|
246
|
+
|
|
247
|
+
- **Comprehensive Test Suite**
|
|
248
|
+
- 48 unit and integration tests (100% passing)
|
|
249
|
+
- Full workflow integration tests
|
|
250
|
+
- Test coverage for all Phase 1 utilities
|
|
251
|
+
|
|
252
|
+
### Technical Details
|
|
253
|
+
- ~1,587 lines of utility code
|
|
254
|
+
- 4 core utility modules
|
|
255
|
+
- Wave-based execution model from GSD analysis
|
|
256
|
+
- Backward compatible with REIS v1.x projects
|
|
257
|
+
|
|
258
|
+
## [1.0.0] - 2025-01-17
|
|
259
|
+
|
|
260
|
+
### Added - Initial Release
|
|
261
|
+
|
|
262
|
+
#### Core System
|
|
263
|
+
- **29 Commands** - Complete systematic development workflow
|
|
264
|
+
- Project initialization: `new`, `map`
|
|
265
|
+
- Requirements & roadmap: `requirements`, `roadmap`
|
|
266
|
+
- Phase management: `plan`, `discuss`, `research`, `assumptions`, `execute`, `execute-plan`, `verify`
|
|
267
|
+
- Progress tracking: `progress`, `pause`, `resume`
|
|
268
|
+
- Roadmap management: `add`, `insert`, `remove`
|
|
269
|
+
- Milestones: `milestone complete`, `milestone discuss`, `milestone new`
|
|
270
|
+
- Utilities: `todo`, `todos`, `debug`, `update`, `whats-new`, `docs`, `uninstall`
|
|
271
|
+
- Help: `help`, `version`
|
|
272
|
+
|
|
273
|
+
#### 3 Specialized Subagents
|
|
274
|
+
- **reis_planner** - Creates executable phase plans with task breakdown
|
|
275
|
+
- **reis_executor** - Executes plans with atomic commits and deviation handling
|
|
276
|
+
- **reis_project_mapper** - Maps existing codebases and bootstraps REIS structure
|
|
277
|
+
|
|
278
|
+
#### Documentation (8 files)
|
|
279
|
+
- `README.md` - Main documentation and architecture guide
|
|
280
|
+
- `COMPLETE_COMMANDS.md` - All 29 commands with examples
|
|
281
|
+
- `QUICK_REFERENCE.md` - Quick reference for daily use
|
|
282
|
+
- `WORKFLOW_EXAMPLES.md` - Real-world workflow examples
|
|
283
|
+
- `INTEGRATION_GUIDE.md` - Rovo Dev integration instructions
|
|
284
|
+
- `SHORTCUT_GUIDE.md` - Natural language shortcuts
|
|
285
|
+
- `README_DOCS.md` - Documentation navigation guide
|
|
286
|
+
- `shortcuts.json` - Structured shortcut definitions
|
|
287
|
+
|
|
288
|
+
#### Templates (5 files)
|
|
289
|
+
- `PROJECT.md` - Project vision template
|
|
290
|
+
- `REQUIREMENTS.md` - Requirements document template
|
|
291
|
+
- `ROADMAP.md` - Roadmap structure template
|
|
292
|
+
- `STATE.md` - State tracking template
|
|
293
|
+
- `PLAN.md` - Phase plan template
|
|
294
|
+
|
|
295
|
+
#### Features
|
|
296
|
+
- β
Parallel execution - Run up to 4 subagents simultaneously
|
|
297
|
+
- β
No context rot - Fresh 200k context per task
|
|
298
|
+
- β
Atomic commits - One commit per task
|
|
299
|
+
- β
Auto-fix - Bugs and gaps fixed automatically
|
|
300
|
+
- β
Structured documentation - Always-loaded context
|
|
301
|
+
- β
Beautiful CLI - Colors, icons, and clear formatting
|
|
302
|
+
- β
Silent mode - CI/CD friendly installation
|
|
303
|
+
- β
Idempotent installation - Safe to run multiple times
|
|
304
|
+
|
|
305
|
+
#### Installation
|
|
306
|
+
- NPM package with `npx reis` support
|
|
307
|
+
- Interactive installation with confirmation prompt
|
|
308
|
+
- Automatic file copying to `~/.rovodev/reis/`
|
|
309
|
+
- Subagent installation to `~/.rovodev/subagents/`
|
|
310
|
+
|
|
311
|
+
### Credits
|
|
312
|
+
Inspired by [Get Shit Done](https://github.com/glittercowboy/get-shit-done) by TΓCHES, adapted for Atlassian Rovo Dev with enhanced parallel subagent execution.
|
|
313
|
+
|
|
314
|
+
[2.0.0-beta.1]: https://github.com/Gravirei/reis/releases/tag/v2.0.0-beta.1
|
|
315
|
+
[2.0.0-alpha.3]: https://github.com/Gravirei/reis/releases/tag/v2.0.0-alpha.3
|
|
316
|
+
[2.0.0-alpha.2]: https://github.com/Gravirei/reis/releases/tag/v2.0.0-alpha.2
|
|
317
|
+
[2.0.0-alpha.1]: https://github.com/Gravirei/reis/releases/tag/v2.0.0-alpha.1
|
|
318
|
+
[1.0.0]: https://github.com/Gravirei/reis/releases/tag/v1.0.0
|