From e5c41078e62a825606ecfc895b4e9bd6ee0dd5e0 Mon Sep 17 00:00:00 2001 From: sepehr-safari Date: Thu, 9 Jul 2026 02:49:14 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20post-v0.2.1=20milestone=20boundary=20au?= =?UTF-8?q?dit=20=E2=80=94=20update=20README,=20ROADMAP,=20CURRENT=5FSTATE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes #83 --- CURRENT_STATE.md | 35 ++++++++++++++++++++++------------- README.md | 28 ++++++++++++++++------------ ROADMAP.md | 6 ++++-- 3 files changed, 42 insertions(+), 27 deletions(-) diff --git a/CURRENT_STATE.md b/CURRENT_STATE.md index ce8614d..98f6b1c 100644 --- a/CURRENT_STATE.md +++ b/CURRENT_STATE.md @@ -4,13 +4,15 @@ ## Current Version -`0.2.1` — Packaging Consolidation + Scenario Evaluator & Replay (ready for release) +`0.2.1` — Packaging Consolidation + Scenario Evaluator & Replay (published) ## Active Milestone -**v0.2.0 — Packaging Consolidation + Scenario Evaluator & Replay (complete — pending release)** +**v0.3.0 — Integrations & OSS Credibility (in progress)** -All v0.2.0 features implemented. Ready for release as `@ocpp-debugkit/toolkit@0.2.1`. +v0.2.1 is published to npm. Old v0.1.1 packages are deprecated. v0.3.0 adds +trace diffing, rich scenario assertions, CI/anonymize/diff CLI commands, +integration examples, and contributor onboarding. ## What's Done @@ -183,13 +185,20 @@ All v0.2.0 features implemented. Ready for release as `@ocpp-debugkit/toolkit@0. - ✅ React components extracted from inspector (PR #76) - ✅ App replay UI + report viewer + react refactor (PR #77) +### v0.2.1 Release + +- ✅ `@ocpp-debugkit/toolkit@0.2.1` published to npm (PR #79) +- ✅ Old v0.1.1 packages (`@ocpp-debugkit/core`, `scenarios`, `reporter`, `cli`) deprecated on npm +- ✅ Git tag `v0.2.1` + GitHub release `v0.2.1` created +- ✅ Docs updated for v0.2 content (PR #78) +- ✅ Web app fixes — npm links, inspector nav, docs prose styling (PR #80, #81) + ## What's Next -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 +1. **v0.3.0 — Integrations & OSS Credibility** — Trace diffing, rich scenario + assertions, CI/anonymize/diff CLI commands, integration examples, contributor + onboarding (Issues #82–#92) +2. **v1.0.0** — API stabilization, 20+ scenarios, docs overhaul, contributor onboarding ## Known Blockers / Decisions Pending @@ -200,9 +209,9 @@ All v0.2.0 features implemented. Ready for release as `@ocpp-debugkit/toolkit@0. | Package | Status | Version | |---------|--------|---------| -| `@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 | +| `@ocpp-debugkit/toolkit` | published | 0.2.1 | +| `@ocpp-debugkit/core` | deprecated | 0.1.1 | +| `@ocpp-debugkit/scenarios` | deprecated | 0.1.1 | +| `@ocpp-debugkit/reporter` | deprecated | 0.1.1 | +| `@ocpp-debugkit/cli` | deprecated | 0.1.1 | | `apps/web` | deployed | — | diff --git a/README.md b/README.md index 3bdd832..4a1a6df 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![CI](https://github.com/ocpp-debugkit/ocpp-debugkit/actions/workflows/ci.yml/badge.svg)](https://github.com/ocpp-debugkit/ocpp-debugkit/actions/workflows/ci.yml) [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/ocpp-debugkit/ocpp-debugkit/blob/main/LICENSE) -[![npm](https://img.shields.io/badge/npm-%40ocpp--debugkit-blue.svg)](https://www.npmjs.com/package/@ocpp-debugkit/toolkit) +[![npm version](https://img.shields.io/npm/v/@ocpp-debugkit/toolkit.svg)](https://www.npmjs.com/package/@ocpp-debugkit/toolkit) OCPP DebugKit is a developer toolkit for inspecting, analyzing, and debugging OCPP (Open Charge Point Protocol) charging session traces. It helps EV charging @@ -15,19 +15,23 @@ validate behavior against known scenarios. - **Trace Inspector** — Load OCPP traces, view session timelines, inspect individual messages, and identify failures. -- **Failure Detection** — Automatically detect common session failure patterns - (failed authorization, connector faults, station offline). -- **Scenario Library** — 5 predefined trace scenarios with expected failure - outcomes for testing the analysis engine. -- **Report Generation** — Export session analysis as Markdown reports. -- **CLI** — Analyze traces from the command line. +- **Failure Detection** — 10 detection rules covering common failure patterns + (failed authorization, connector faults, station offline, heartbeat timeout, + meter value gaps, invalid stop reasons, status transition violations, + diagnostics failures, firmware update failures, unexpected starts). +- **Scenario Evaluator** — 10 predefined scenarios with expected failure + outcomes for testing the analysis engine. Supports external scenario files. +- **Replay Engine** — Deterministic, pure replay engine with step forward/back, + jump-to-event, and configurable playback speed. +- **Report Generation** — Export session analysis as Markdown or HTML reports. +- **React Components** — Reusable, SSR-safe components for building custom + inspector UIs (SessionTimeline, MessageInspector, FailureSummary, + ReportViewer, ReplayControls). +- **CLI** — Analyze traces, generate reports, and run scenarios from the + command line. - **Browser-Local** — All trace processing happens in your browser. No data leaves your machine when using the web app. -> **Scenario Evaluator & Replay** (comparing detected vs expected failures, -> replay engine, extracted React components) is planned for v0.2.0. See the -> [Roadmap](./ROADMAP.md). - ## What It's Not - Not a CSMS (Charging Station Management System) @@ -56,7 +60,7 @@ OCPP DebugKit is a pnpm monorepo. All modules ship in a single npm package, |-------------|-------------| | `@ocpp-debugkit/toolkit/core` | Data model, trace parser, event normalizer, timeline, failure detection | | `@ocpp-debugkit/toolkit/scenarios` | Predefined trace scenarios for testing | -| `@ocpp-debugkit/toolkit/reporter` | Report generators (Markdown) | +| `@ocpp-debugkit/toolkit/reporter` | Report generators (Markdown, HTML) | | `@ocpp-debugkit/toolkit/replay` | Replay engine | | `@ocpp-debugkit/toolkit/react` | Reusable React components | | `@ocpp-debugkit/toolkit/cli` | Programmatic CLI entry (`bin: ocpp-debugkit`) | diff --git a/ROADMAP.md b/ROADMAP.md index 6ac8dfd..d19ef9c 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -78,7 +78,9 @@ met. ## v0.2.0 — Packaging Consolidation + Scenario Evaluator & Replay -**Status:** ✅ Complete (pending release as `@ocpp-debugkit/toolkit@0.2.1`) +**Status:** ✅ Complete — published as `@ocpp-debugkit/toolkit@0.2.1` on npm, +Git tag `v0.2.1`, GitHub release `v0.2.1`. Old v0.1.1 packages deprecated. +Web app deployed at ocppdebugkit.com. Consolidated four npm packages into `@ocpp-debugkit/toolkit` with subpath exports. Added offline scenario evaluation, replay, expanded detection, HTML @@ -99,7 +101,7 @@ old packages deprecated. ## v0.3.0 — Integrations & OSS Credibility -**Status:** Not started +**Status:** In progress Connect to real ecosystem workflows. Attract external engagement.