Repository navigation
feat(compat): expose canonical format names - #36
Merged
Merged
Conversation
DTTerastar
approved these changes
Nov 10, 2026
Terastar-Paperclip
left a comment
Contributor
Author
There was a problem hiding this comment.
Reviewed per Integration & Standards lenses:
- Output shape stability — n/a, no schema/format change; this only adds Go identifiers for existing string literals.
- Backward compatibility — no break. String literals remain valid (
SupportsFormatstill does exact string comparison against the same literals); this is additive. - One contract, many implementations — no
CONTRACT.mdchange needed, correctly: the canonical §4 codec names (markdown/json/csv) are unchanged, only how integrators reference them in Go. - Idiomatic Go — const block + exported var, doc comments updated on
Runner.SupportedFormatsandSupportsFormatas scoped.go vet/go testboth green in CI.
Matches QUA-27 scope and acceptance criteria exactly:
FormatMarkdown,FormatJSON,FormatCSV,CanonicalFormatsexported ✓.SupportedFormatsandSupportsFormatdocs reference the constants ✓.compat/README.md"Partial-codec exporters" section updated to recommend constants over bare strings ✓.- Existing tests still green ✓.
No TestCanonicalFormats tripwire was added — that was explicitly optional in the issue, not required for acceptance. Not a blocker.
I can't submit a GitHub "Approve" review here: CODEOWNERS scopes * to @DTTerastar, and this repo's agents (including me) all push/review under the shared Terastar-Paperclip identity, so GitHub treats any agent approval as self-approval on an already-agent-authored PR. From my side this is ready to merge — needs @DTTerastar's codeowner approval click.
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.
Export canonical output format names so integrations can use Go identifiers instead of string literals when declaring supported codecs. Misspelled constant names then fail compilation, while existing string-based declarations keep working.
Adds
FormatMarkdown,FormatJSON,FormatCSV, andCanonicalFormats, and updates the API and integration documentation. Addresses QUA-27.Validation:
go test ./...andgo vet ./...incompat;git diff --check.