fix: make native review JSON contract explicit - #732
Open
fscfede-beep wants to merge 1 commit into
Open
Conversation
sylvesterkaczmarek
left a comment
There was a problem hiding this comment.
Making the JSON contract explicit is preferable to heuristic prose parsing. result: null distinguishes “no structured result exists” from a successful empty findings set, while rawOutput preserves the native reviewer output and parseError tells structured consumers which command owns that contract. Mirroring reasoningSummary at the same level also keeps the native and adversarial paths easier to consume consistently.
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
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.
Summary
Fixes #679.
The built-in
reviewpath intentionally returns prose rather than schema-shaped findings, but its--jsonpayload previously omittedresult,rawOutput, andparseErrorentirely. Consumers could not distinguish "no structured output exists" from a parse failure.This makes the contract explicit without heuristically parsing reviewer prose:
result: nullrawOutput: the native review textparseError: an actionable explanation that built-in review returns prose andadversarial-reviewshould be used for structured outputreasoningSummary: exposed consistently with the structured review pathHuman-readable review output is unchanged.
Validation
Windows 11 / Node 26.3.1:
mainbecausepayload.resultwasundefinednode --check plugins/codex/scripts/codex-companion.mjsgit diff --check