docs: document the notes sync JSON output contract - #8
Open
AdaInTheLab wants to merge 1 commit into
Open
AdaInTheLab wants to merge 1 commit into
AdaInTheLab wants to merge 1 commit into
Conversation
The SyncReport shape, its three-term invariant (synced + dryRun + failed = total), the noop shape and the no-start stderr case were only pinned in code and tests. Write them down so consumers (the Sync Explorer, agents) do not guess. No behaviour change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
😼✨ Carmel Approval Stamp™
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
docs/CLI_CONTRACT.mdhad no section on whathpl --json notes syncprints. The shape lives insrc/sync/types.ts+src/sync/summary.ts+src/cli/outputContract.tsand is pinned bytests/outputContract.test.ts, but nothing consumer-facing said so. The first prototype of the Sync Explorer guessedsynced + failed === total, which rejects every real dry run.What
Docs only. Adds a
notes syncOutput section:SyncResult/SyncSummary/SyncReportas emitted (including thesourcefield the command attaches), the invariants, the noop shape, and the no-start case (nothing on stdout, JSON on stderr, exit 1).No code, output or exit-code changes.
🤖 Generated with Claude Code