purpleclay / misspell-codeclimate Goto Github PK

Describe your feature

Format the default report provided by misspell into a CodeClimate format that is recognisable by GitLab, and can effectively be used to annotate merge requests.

Sample output:

docs/README.md:1:14: "incorectly" is a misspelling of "incorrectly"

Your potential solution

Expose the reading of the input file through a -f flag within the CLI. Upon reading the file, the parsed content will be translated into the expected JSON format and written to Stdout, where it can then be piped into a file within a GitLab job.

The current report format is broken down into the following sub-parts, based on the documented Go template:

{{ .Filename }}:{{ .Line }}:{{ .Column }}:corrected {{ printf "%q" .Original }} to "{{ printf "%q" .Corrected }}"

This should map fairly easily to the following CodeClimate format:

[
  {
    "description": "\"incorectly\" is a misspelling of \"incorrectly\"",
    "fingerprint": "7815696ecbf1c96e6894b779456d330e",
    "severity": "minor",
    "location": {
      "path": "docs/README.md",
      "lines": {
        "begin": 1
      }
    }
  }
]

Any additional information?

https://docs.gitlab.com/ee/ci/testing/code_quality.html#implementing-a-custom-tool

Code of Conduct

• I agree to follow this project's Code of Conduct

Describe your feature

Using strings.Split() is causing inconsistent results. So switching to using a bufio scanner for file reading should better support edge cases

Your potential solution

Switch to using a bufio.NewScanner() and read the file line by line. Process each line in turn as per normal.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

Describe your feature

To use misspell-codeclimate within GitLab currently, both binaries need to be downloaded and installed. This could be a lot simpler by using a pre-built docker image.

Your potential solution

Package up the required binaries into a docker container that can be used within a GitLab job.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct