Skip to content

docs: rewrite roadmap and prepare v5.3.2#19

Merged
flyingrobots merged 6 commits intomainfrom
feat/roadmap-dual-cli-surfaces
Mar 16, 2026
Merged

docs: rewrite roadmap and prepare v5.3.2#19
flyingrobots merged 6 commits intomainfrom
feat/roadmap-dual-cli-surfaces

Conversation

@flyingrobots
Copy link
Member

@flyingrobots flyingrobots commented Mar 15, 2026

Summary

  • rewrite ROADMAP.md around the real shipped state at v5.3.1
  • formalize the human CLI/TUI vs planned git cas agent split
  • replace loose backlog/vision buckets with sequenced milestones M17-M25
  • refresh STATUS.md to match the roadmap and current release line
  • harden slow vault rotation tests with explicit per-test timeouts

Testing

  • npx eslint .
  • npm test
  • GIT_STUNTS_DOCKER=1 npx vitest run test/integration
  • bunx vitest run test/unit
  • GIT_STUNTS_DOCKER=1 bunx vitest run test/integration
  • deno run -A npm:vitest run test/unit
  • GIT_STUNTS_DOCKER=1 deno run -A npm:vitest run test/integration

Summary by CodeRabbit

  • Documentation

    • Clarified README JSON output wording; reorganized STATUS with a refreshed roadmap, interface strategy, and versioning layout.
  • Bug Fixes

    • Improved CLI exit behavior to flush output and handle broken-pipe scenarios; version reporting now reflects package version.
  • Tests

    • Extended several test timeouts and hardened integration tests to invoke the CLI more reliably.
  • Chores

    • Added test-runner workspace/config, new Vitest config, Unreleased changelog entry, and bumped package version.

@coderabbitai
Copy link

coderabbitai bot commented Mar 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b428cd4d-9fcd-45d7-ab99-c04ea0a93361

📥 Commits

Reviewing files that changed from the base of the PR and between 7525cc3 and 47d603a.

📒 Files selected for processing (1)
  • STATUS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • STATUS.md

📝 Walkthrough

Walkthrough

Added a new bin/io.js for broken‑pipe detection and flush‑before‑exit utilities; wired it into the CLI startup/exit flow. Made runAction accept an injectable setExitCode. Replaced shell-based test invocations with spawn helpers, extended several test timeouts, added Vitest workspace/config, and updated docs/metadata.

Changes

Cohort / File(s) Summary
StdIO & CLI wiring
bin/io.js, bin/git-cas.js, bin/actions.js
Add bin/io.js exports (isBrokenPipeError, installBrokenPipeHandlers, flushStdioAndExit); bin/git-cas.js reads version from package.json, installs broken‑pipe handlers, and uses flush-before-exit; runAction gains injectable setExitCode.
Integration tests — spawn helpers
test/integration/vault-cli.test.js, test/integration/round-trip.test.js, test/integration/vault.test.js
Replace shell execSync with spawnSync helpers (runCli, cli, initBareRepo), call CLI with argv arrays, and tighten error handling/assertions.
Unit tests — IO & runAction
test/unit/cli/io.test.js, test/unit/cli/actions.test.js, test/unit/cli/version.test.js, test/unit/cli/vitest-workspace.test.js
Add tests for broken‑pipe handlers and flush/exit behavior; update tests to inject/assert setExitCode; add CLI --version and Vitest workspace assertions.
Test timeouts & config
test/unit/domain/services/rotateVaultPassphrase.test.js, test/unit/facade/ContentAddressableStore.rotation.test.js, test/unit/vault/VaultService.test.js, vitest.config.js, vitest.workspace.js
Introduce LONG_TEST_TIMEOUT_MS = 15000 and apply to several tests; add vitest.config.js and vitest.workspace.js with integration fileParallelism disabled.
Docs & metadata
README.md, STATUS.md, CHANGELOG.md, package.json, jsr.json
Minor README wording tweak; major STATUS.md restructuring; add Unreleased section to CHANGELOG; bump package version to 5.3.2 and update jsr.json.
Misc
.dockerignore
Add .git to .dockerignore.

Sequence Diagram(s)

sequenceDiagram
  rect rgba(220,230,255,0.5)
    participant CLI as CLI (bin/git-cas.js)
    participant IO as IO Module (bin/io.js)
    participant STDOUT as stdout
    participant STDERR as stderr
    participant Proc as process/exit
  end

  CLI->>IO: installBrokenPipeHandlers()
  IO->>STDOUT: attach 'error' listener
  IO->>STDERR: attach 'error' listener

  Note over STDOUT,STDERR: On EPIPE error
  STDOUT-->>IO: 'error' (EPIPE)
  IO->>Proc: call exit(getExitCode())
  CLI->>IO: flushStdioAndExit(code)
  IO->>STDOUT: flushStream()
  IO->>STDERR: flushStream()
  IO->>Proc: exit(code)
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Poem

🐰 I hopped through streams with careful cheer,

Caught broken pipes and kept exits clear,
Spawned new tests that speak in arrays,
Timeouts stretched to patient days,
A little rabbit signs this cheer. 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: rewrite roadmap and prepare v5.3.2' accurately summarizes the main changes: documentation updates to the roadmap/status and version bump to 5.3.2.
Docstring Coverage ✅ Passed Docstring coverage is 80.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/roadmap-dual-cli-surfaces
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 35: Update the user-facing bullet that starts with "Verify & JSON output"
to fix the grammar: replace "provides convenience structured output" with
"provides convenient structured output" (or an equivalent phrasing). Locate the
bullet text containing "git cas verify" and the "--json" mention and change that
fragment only so the rest of the sentence remains unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 92e634d9-5c3a-470c-af00-3e1596e38750

📥 Commits

Reviewing files that changed from the base of the PR and between d63de0b and 50708d7.

📒 Files selected for processing (6)
  • README.md
  • ROADMAP.md
  • STATUS.md
  • test/unit/domain/services/rotateVaultPassphrase.test.js
  • test/unit/facade/ContentAddressableStore.rotation.test.js
  • test/unit/vault/VaultService.test.js

@flyingrobots
Copy link
Member Author

@coderabbitai review please 🥕

@coderabbitai
Copy link

coderabbitai bot commented Mar 15, 2026

@flyingrobots Sure thing! Kicking off a review of PR #19 now. 🥕

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@flyingrobots
Copy link
Member Author

@coderabbitai review please 🥕

@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

@flyingrobots Sure! Triggering another review of PR #19 now. 🥕

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@STATUS.md`:
- Around line 20-29: The "Recently Shipped" table mixes release versions with
milestone IDs that look chronological (e.g., `v3.1.0` with M13 and `v4.0.0` with
M14 appearing alongside M10–M12), so add a brief clarifying note above or below
the table stating that milestone IDs (M10, M11, M12, M13, M14, etc.) are
thematic/non-linear and do not imply chronological order, or alternatively
reorder the rows by milestone sequence; update the table caption or a one-line
parenthetical (e.g., "Milestone IDs are thematic and non-sequential") and ensure
the note references the milestone labels (M10–M14) and versions (`v3.1.0`,
`v4.0.0`, `v5.0.0`, etc.) so readers aren't confused.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6a2ebf1e-801e-4150-be9d-abbebded724a

📥 Commits

Reviewing files that changed from the base of the PR and between 053ea77 and 7525cc3.

📒 Files selected for processing (9)
  • CHANGELOG.md
  • STATUS.md
  • bin/git-cas.js
  • jsr.json
  • package.json
  • test/unit/cli/version.test.js
  • test/unit/cli/vitest-workspace.test.js
  • vitest.config.js
  • vitest.workspace.js
✅ Files skipped from review due to trivial changes (3)
  • CHANGELOG.md
  • jsr.json
  • package.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • vitest.config.js

@flyingrobots flyingrobots changed the title docs: rewrite roadmap around dual CLI surfaces docs: rewrite roadmap and prepare v5.3.2 Mar 16, 2026
@flyingrobots flyingrobots merged commit b445f66 into main Mar 16, 2026
6 checks passed
@flyingrobots flyingrobots deleted the feat/roadmap-dual-cli-surfaces branch March 16, 2026 00:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant