WIP: Add --output-format oneline options for easier editor integration #84
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Editor integrations for linters tend to work better with one line per offense, unlike the more human-oriented default of two line + newline per offense. This adds an `--output-format oneline` command-line option for a more compact and machine-parseable output format. The output takes the form of: ``` <filename>:<start-line>:<start-col>:<offense-message> ```
|
This looks good. If more output formats are added we would likely have to extract the code in individual formatter objects. Anything else you would like to add before removing WIP? |
|
Has there been any movement on this? We've started using I'm thinking of contributing a JSON formatter, but do not want to reimplement the wheel on an interface if this one is ready to roll. What can I do to help to get formatting support implemented as part of an official release of |
Merged
hc0503
approved these changes
Nov 9, 2020
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Editor integration for linters tend to work better with one line per
offense, unlike the more human-oriented default of two line + newline
per offense. In particular I'm thinking of the regexes used bye ALE for vim.
This adds an
--output-format onelinecommand-line option for a morecompact and machine-parsable output format. Omitting the option ore using
--output-format multiplineuses the current "two lines + newline" output. The oneline output takes the formof:
I'm marking this as a WIP because I'd like feedback as to my approach, and whether this is a feature the maintainers would be interested in. I'm also investigating a JSON output option, which should be a relatively straightforward extension of this approach once a schema is decided on. The schema used by Rubocop's JSON formatter might be a good starting point.