Summary
Add multiple output format options for better CI/IDE integration.
Problem
Limited output formats - only human-readable text, no machine-readable or CI-friendly formats.
Action Items
-
Add --format flag with options:
text - human-readable (default)
json - machine-readable, structured
yaml - human-friendly structured
junit - CI integration (JUnit XML)
checkstyle - IDE integration (Checkstyle XML)
-
Apply to all commands (validate, format, analyze, lint)
-
Document JSON/YAML schemas:
{
"status": "error",
"errors": [{
"file": "query.sql",
"line": 3,
"column": 15,
"message": "unexpected token",
"code": "E001"
}]
}
-
Add examples for CI/IDE integration
Acceptance Criteria
Technical Details
Priority: Medium
Effort: Small (12h)
Phase: Phase 3 - UX & Documentation
Dependencies: None
Example Usage
# JSON for scripts
gosqlx validate --format json query.sql | jq '.errors'
# JUnit for CI
gosqlx validate --format junit *.sql > test-results.xml
# Checkstyle for IDE
gosqlx validate --format checkstyle src/
Summary
Add multiple output format options for better CI/IDE integration.
Problem
Limited output formats - only human-readable text, no machine-readable or CI-friendly formats.
Action Items
Add
--formatflag with options:text- human-readable (default)json- machine-readable, structuredyaml- human-friendly structuredjunit- CI integration (JUnit XML)checkstyle- IDE integration (Checkstyle XML)Apply to all commands (validate, format, analyze, lint)
Document JSON/YAML schemas:
{ "status": "error", "errors": [{ "file": "query.sql", "line": 3, "column": 15, "message": "unexpected token", "code": "E001" }] }Add examples for CI/IDE integration
Acceptance Criteria
Technical Details
Priority: Medium
Effort: Small (12h)
Phase: Phase 3 - UX & Documentation
Dependencies: None
Example Usage