From c20c8a7d104d749d1c6bd12177d2b58517356afa Mon Sep 17 00:00:00 2001 From: sepehr-safari Date: Wed, 8 Jul 2026 22:36:22 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20v0.2=20content=20=E2=80=94=20update=20C?= =?UTF-8?q?URRENT=5FSTATE,=20ROADMAP=20for=20release=20readiness?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Mark all v0.2.0 phases as complete. Update package status table, What's Next section, and ROADMAP milestone status. Closes #65 --- CURRENT_STATE.md | 42 +++++++++++++++++++++++------------------- ROADMAP.md | 25 ++++++++++++++----------- 2 files changed, 37 insertions(+), 30 deletions(-) diff --git a/CURRENT_STATE.md b/CURRENT_STATE.md index c98b8a3..ce8614d 100644 --- a/CURRENT_STATE.md +++ b/CURRENT_STATE.md @@ -4,13 +4,13 @@ ## Current Version -`0.2.0` — Packaging Consolidation + Scenario Evaluator & Replay (in progress) +`0.2.1` — Packaging Consolidation + Scenario Evaluator & Replay (ready for release) ## Active Milestone -**v0.2.0 — Packaging Consolidation + Scenario Evaluator & Replay (in progress)** +**v0.2.0 — Packaging Consolidation + Scenario Evaluator & Replay (complete — pending release)** -Phase 0: Packaging consolidation — creating `@ocpp-debugkit/toolkit` single package with subpath exports. +All v0.2.0 features implemented. Ready for release as `@ocpp-debugkit/toolkit@0.2.1`. ## What's Done @@ -160,7 +160,7 @@ Phase 0: Packaging consolidation — creating `@ocpp-debugkit/toolkit` single pa - ✅ `packages/toolkit/` — single `@ocpp-debugkit/toolkit` package created (PR #55) - ✅ Core, scenarios, reporter, CLI code moved into `src/core/`, `src/scenarios/`, `src/reporter/`, `src/cli/` -- ✅ `src/replay/` and `src/react/` stub modules added +- ✅ `src/replay/` and `src/react/` modules added - ✅ Subpath exports configured (`/core`, `/scenarios`, `/reporter`, `/replay`, `/react`, `/cli`, `/fixtures`) - ✅ CLI binary `ocpp-debugkit` via `package.json#bin` - ✅ Old package directories removed @@ -168,21 +168,25 @@ Phase 0: Packaging consolidation — creating `@ocpp-debugkit/toolkit` single pa - ✅ All 196 existing tests pass from new locations - ✅ Build, lint, typecheck, format all green - ✅ `private: true` set to prevent premature auto-publish (PR #67) +- ✅ External fixture test + CI (PR #69) +- ✅ Migration docs + ADR-0010 (PR #71) +- ✅ Release workflow simplified for single package (PR #72) -### Note on premature 0.2.0 publish +### v0.2.0 Features (complete) -`@ocpp-debugkit/toolkit@0.2.0` was accidentally auto-published by the release -workflow when PR #55 merged (Changesets publishes unpublished local versions -even without a changeset). The package contains only Phase 0 stubs — deprecated -on npm. The real release will be `0.2.1`. The premature `release-v0.2.0` -GitHub release and tag were deleted. +- ✅ Expanded failure detection — 7 new rules (PR #70): TIMEOUT_NO_HEARTBEAT, METER_VALUE_GAP, + INVALID_STOP_REASON, UNEXPECTED_START, STATUS_TRANSITION_VIOLATION, DIAGNOSTICS_FAILURE, + FIRMWARE_UPDATE_FAILURE +- ✅ 10 total scenarios + CLI external scenario files (PR #75) +- ✅ Replay engine implementation + tests (PR #74) +- ✅ HTML report format + CLI --format html (PR #73) +- ✅ React components extracted from inspector (PR #76) +- ✅ App replay UI + report viewer + react refactor (PR #77) ## What's Next -1. **v0.2.0 remaining** — External fixture test (#56), migration docs (#57), - release workflow simplification (#58), expanded failure detection (#59), - 10 scenarios (#60), replay engine (#61), HTML reports (#62), React - components (#63), app replay UI (#64), v0.2 docs (#65), release (#66) +1. **v0.2.0 release** — Remove `private: true`, add changeset, publish + `@ocpp-debugkit/toolkit@0.2.1`, create Git tag `v0.2.1`, deprecate old packages 2. **v0.3.0** — Integrations & OSS credibility (trace diffing, CI mode, anonymize, integration examples) 3. **v1.0.0** — API stabilization, 20+ scenarios, docs overhaul, contributor @@ -196,9 +200,9 @@ GitHub release and tag were deleted. | Package | Status | Version | |---------|--------|---------| -| `@ocpp-debugkit/toolkit` | in progress | 0.2.0 | -| `@ocpp-debugkit/core` | published (deprecated after v0.2.0) | 0.1.1 | -| `@ocpp-debugkit/scenarios` | published (deprecated after v0.2.0) | 0.1.1 | -| `@ocpp-debugkit/reporter` | published (deprecated after v0.2.0) | 0.1.1 | -| `@ocpp-debugkit/cli` | published (deprecated after v0.2.0) | 0.1.1 | +| `@ocpp-debugkit/toolkit` | ready for release | 0.2.1 | +| `@ocpp-debugkit/core` | published (deprecated after release) | 0.1.1 | +| `@ocpp-debugkit/scenarios` | published (deprecated after release) | 0.1.1 | +| `@ocpp-debugkit/reporter` | published (deprecated after release) | 0.1.1 | +| `@ocpp-debugkit/cli` | published (deprecated after release) | 0.1.1 | | `apps/web` | deployed | — | diff --git a/ROADMAP.md b/ROADMAP.md index c1e9950..6ac8dfd 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -76,21 +76,24 @@ met. --- -## v0.2.0 — Scenario Evaluator & Replay +## v0.2.0 — Packaging Consolidation + Scenario Evaluator & Replay -**Status:** Next up +**Status:** ✅ Complete (pending release as `@ocpp-debugkit/toolkit@0.2.1`) -Make the tool genuinely useful for developers' daily workflows. +Consolidated four npm packages into `@ocpp-debugkit/toolkit` with subpath +exports. Added offline scenario evaluation, replay, expanded detection, HTML +reports, and reusable React components. -- Expanded failure detection rules (7 new rules) -- 10 total scenarios -- Replay engine package -- Extracted React components package -- CLI: external scenario files, offline evaluator -- HTML report format -- App: replay UI, report viewer, React refactor +- **Packaging:** Single `@ocpp-debugkit/toolkit` package with subpath exports +- **Detection:** 10 failure rules (3 v0.1 + 7 new) +- **Scenarios:** 10 total scenarios + CLI external scenario files +- **Replay:** Replay engine with step/play/pause/jump +- **Reports:** Markdown + HTML report formats +- **React:** Extracted reusable components (SessionTimeline, MessageInspector, etc.) +- **App:** Replay UI, report viewer, three-tab inspector (Inspect/Replay/Report) -**Exit criteria:** GitHub release `release-v0.2.0`. +**Exit criteria:** `@ocpp-debugkit/toolkit@0.2.1` published, Git tag `v0.2.1`, +old packages deprecated. ---