Json output

[alexkiousis]

This introduces a JSON format output.

Each message is a JSON dictionary. Example output:

yamllint -f json yamllint/conf/*
{"code": "YAMLLINT", "char": 1, "severity": "error", "line": 1, "path": "yamllint/conf/default.yaml", "name": "YAMLLINT", "description": "too many blank lines (1 > 0) (empty-lines)"}
{"code": "YAMLLINT", "char": 1, "severity": "warning", "line": 2, "path": "yamllint/conf/default.yaml", "name": "YAMLLINT", "description": "missing document start \"---\" (document-start)"}
{"code": "YAMLLINT", "char": 1, "severity": "warning", "line": 1, "path": "yamllint/conf/relaxed.yaml", "name": "YAMLLINT", "description": "missing document start \"---\" (document-start)"}

The output is based on Phabricator's API for linting input. I use it with this Jenkins plugin.

[coveralls]

Coverage decreased (-0.2%) to 97.805% when pulling b0412b5 on alexkiousis:json_output into db57127 on adrienverge:master.

[alexkiousis]

This is basically my first PR, so any feedback is welcome.
I'm trying to figure out what test is needed to "cover" the new function introduced.

[adrienverge]

Hi,

Looks good!

Indeed you need to add tests to make sure future development won't break your feature. Can you add a function at the end of tests/test_cli.py, for instance test_run_json_output()? Something that checks that when passing -f json, the output is parsable using json.loads() and matches a pre-defined dictionnary.

[adrienverge]

Other formats don't have _output, you can simply name this function json(problem, filename) ;-)

[adrienverge]

The name of the tool is yamllint (lowercase), can you keep it?

[xelatirdan]

@alexkiousis Hello, are you going to bring your pull request to finish?

[MrBones757]

is there any progress on this issue? I've come across a situation where this would be very useful to have if its possible to move this forward..

[adrienverge]

@MrBones757 as you can see, this PR seems abandoned. Yes it's "possible to move this forward": do you want to contribute and write a new, clean pull request?

It needs to come with tests (see previous comments), and the output format would be better like that:

{
  "path": ...,
  "line": ...,
  "column": ...,
  "message": ...,
  "rule": ...,
  "level": "warning|error"
}

[bluikko]

Please consider using the Codeclimate JSON syntax. Why come up with a proprietary JSON schema when a de facto standard exists? It would also be supported in GitLab.

Edit: I saw there was an issue closed with regards to my suggested specific JSON schema. Why when there is an output format "github"? If the JSON output would be codeclimate style then it could be used out of the box with the GitLab cloud which is no different from GitHub. Call it "gitlab" if it makes you feel better...