Json-Output

[strowi]

Hi,

since we are using gitlab and its codeclimate integration, we really would like json-formatted output.
Would you be willing to accept an MR adding json-output adhering to the codeclimate spec ?

-> https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#output

{
  "type": "issue",
  "check_name": "yamllint",
  "description": "wrong indentation: expected 2 but found 4 (indentation)",
  "categories": "Complexity",
  "severity": "critical",
  "location": {
    "path": "/home/x/y/z/test.yml",
    "positions": {
      "begin": {
        "lines": "12",
        "column": "5"
      }
    }
  }
}

Ideally this would include the severity:

severity -- Optional. A Severity string (info, minor, major, critical, or blocker) describing the potential impact of the issue found.

But this would be a breaking change i guess? Since it's optional it could be left out..

regards,
strowi

[adrienverge]

Hello @strowi, have you searched similar issues before opening this one?

[strowi]

Hi @adrienverge,

i only found this ~3y old one regarding json?
#68

After reading the codeclimate-specs again, it seems, they require every issue to be json, but separate issues by "\0", which is not json-compliant. So i guess this would require a separate codeclimate-format?

[adrienverge]

Hi @strowi,

A codeclimate-specific (or any software-specific) format won't be accepted here. For JSON output, I propose to continue in #68.

Thanks

[bluikko]

A codeclimate-specific (or any software-specific) format won't be accepted here. For JSON output, I propose to continue in #68.

yamllint has support for GitHub. Similarly to GitHub, the cloud service GitLab supports reading output in the "codeclimate" format.

Wouldn't this be comparable to the GitHub support?

[adrienverge]

Many could be comparable to the GitHub support. Similarly, we could accept dozens of formats with the same argument. For this reason, there won't be new third-party formats added.

[gardar]

In case someone else comes across this issue when searching for gitlab codeclimate/codequality output, I found this project: https://github.com/ProfessorManhattan/codeclimate-yamllint
Which contains the following script to generate codeclimate output

yamllint $CONFIG -f parsable . | awk 'BEGIN {FS = ":" } ;{gsub(/^[ \t]+|[ \t]+$|"/, "",$4); match($4,/^\[(warning|error)\](.*)\((.*)\)$/,a); if(a[1]=="error") {sev="major"} else { sev="minor"}}; {printf("{\42location\42:{\42path\42:\42%s\42,\42lines\42:{\42begin\42:%s,\42end\42:%s}},\42severity\42:\42%s\42,\42check_name\42:\42%s\42,\42categories\42:[\42Style\42],\42type\42:\42issue\42,\42description\42:\42%s\42}\0",$1,$2,$3,sev,a[3],a[2]);}'

I had to change it a bit to get valid json from it but I ended up with this:

lint:
  stage: lint
  script:
    - mkdir reports
    - >
      yamllint -f parsable . | tee >(awk '
      BEGIN {FS = ":"; ORS="\n"; first=1}
      {
          gsub(/^[ \t]+|[ \t]+$|"/, "", $4);
          match($4, /^\[(warning|error)\](.*)\((.*)\)$/, a);
          sev = (a[1] == "error" ? "major" : "minor");
          if (first) {
              first=0;
              printf("[");
          } else {
              printf(",");
          }
          printf("{\"location\":{\"path\":\"%s\",\"lines\":{\"begin\":%s,\"end\":%s}}," \
                 "\"severity\":\"%s\",\"check_name\":\"%s\",\"categories\":[\"Style\"]," \
                 "\"type\":\"issue\",\"description\":\"%s\"}",
                 $1, $2, $3, sev, a[3], a[2]);
      }
      END { if (!first) printf("]\n"); }' > reports/codequality.json)
  artifacts:
    when: always
    paths:
      - reports
    expire_in: 1 week
    reports:
      codequality: reports/codequality.json

Many could be comparable to the GitHub support. Similarly, we could accept dozens of formats with the same argument. For this reason, there won't be new third-party formats added.

How about going the same route as flake8 and offloading the formatters to plugins?
for example: https://github.com/awelzel/flake8-gl-codeclimate