Skip to content

feat(formatter): add JSON output support #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mikelolasagasti merged 1 commit into from
Nov 4, 2025
Merged

feat(formatter): add JSON output support #189

mikelolasagasti merged 1 commit into from
Nov 4, 2025

Conversation

@mikelolasagasti
Copy link
Collaborator

@mikelolasagasti mikelolasagasti commented Nov 4, 2025

Introduce a new --output/-o flag to select the output format (text or json). Implements a JSONFormatter for structured violation reporting and marks --format and --output as mutually exclusive for clarity.

Checklist

  • Description of proposed change
  • Documentation (README, docs/, man pages) is updated
  • Unit tests for the proposed change

@mikelolasagasti
feat(formatter): add JSON output support
949fcf3 
Introduce a new `--output/-o` flag to select the output format (`text`
or `json`). Implements a JSONFormatter for structured violation
reporting and marks `--format` and `--output` as mutually exclusive for
clarity.

Signed-off-by: Mikel Olasagasti Uranga <mikel@olasagasti.info>
@mikelolasagasti
Copy link
Collaborator Author

mikelolasagasti commented Nov 4, 2025

Current output:

./checkmake fixtures/missing_phony.make 
     RULE          DESCRIPTION               FILE NAME           LINE NUMBER 
 minphony       Required target     fixtures/missing_phony.make  21          
                "all" must be                                                
                declared PHONY.                                              
 minphony       Required target     fixtures/missing_phony.make  21          
                "test" must be                                               
                declared PHONY.                                              
 phonydeclared  Target "all"        fixtures/missing_phony.make  16          
                should be declared                                           
                PHONY.                                                       
Error: violations found (3)

With json output:

./checkmake fixtures/missing_phony.make -o json
[
  {
    "rule": "minphony",
    "violation": "Required target \"all\" must be declared PHONY.",
    "file_name": "fixtures/missing_phony.make",
    "line_number": 21
  },
  {
    "rule": "minphony",
    "violation": "Required target \"test\" must be declared PHONY.",
    "file_name": "fixtures/missing_phony.make",
    "line_number": 21
  },
  {
    "rule": "phonydeclared",
    "violation": "Target \"all\" should be declared PHONY.",
    "file_name": "fixtures/missing_phony.make",
    "line_number": 16
  }
]
Error: violations found (3)

Parsing with jq:

./checkmake -o json fixtures/missing_phony.make | jq -r '.[] | "\(.rule):\(.line_number)"'
Error: violations found (3)
phonydeclared:16
minphony:21
minphony:21

Note that "Error: violations found (3)" message is part of stderr and not stdout.

obnoxxx
obnoxxx approved these changes Nov 4, 2025
View reviewed changes
Copy link
Collaborator

@obnoxxx obnoxxx left a comment

Choose a reason for hiding this comment

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

This looks like a reasonable enhancement.

Nice to have it covered with tests!

LGTM.

@mikelolasagasti mikelolasagasti merged commit 9277032 into checkmake:main Nov 4, 2025
4 checks passed
@mikelolasagasti mikelolasagasti deleted the output-json branch November 4, 2025 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@obnoxxx obnoxxx obnoxxx approved these changes

Assignees

No one assigned

Labels

enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mikelolasagasti @obnoxxx