Support for reporting problems to file with machine-readable format

[fenuks]

It would be great to be able to output problems to some machine-readable format for further processing (in addition to human-readable terminal output). In my example, I would like add pydoclint to GitLab CI job, and GitLab can load CodeClimate report as job output.

Currently one has to write own parser and converter for terminal output, that probably is not guaranteed to be stable.

[jsh9]

Could you provide some example of what machine-readable format looks like? Thanks!

[fenuks]

Specification for CodeClimate can be found at https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#data-types. GitLab supports only subset of full CodeClimate spec. https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format The latter site offers a simple example of report. Here's an example from my script converting cli output to CodeClimate report:

[
  {
    "description": "Function `test` has \"yield\" statements, but the docstring does not have a \"Yields\" section",
    "check_name": "DOC402",
    "severity": "major",
    "location": {
      "path": "script.py",
      "positions": {
        "begin": {
          "line": 41
        }
      }
    },
    "fingerprint": "d9d6b1e908756ea85867a7620d30d4c6"
  }
]