feat: Add support for external output formatters #77
Conversation
| -f, --format [format] The output format | ||
| -b, --branch [branch] The branch to diff against | ||
| -h, --help Output usage information | ||
| -V, --version Output the version number |
There was a problem hiding this comment.
With the indent change and the capital O's, this doesn't match the output of the command anymore.
There was a problem hiding this comment.
Hmm, should make a way to keep this the same as the output.
| @@ -78,6 +80,34 @@ below. | |||
|
|
|||
| * `list-files` - list the files in the current diff that lint-filter will use. Nice for faster linting. | |||
|
|
|||
| ### External formatters | |||
| An external formatter should export a function takes two arguments(input and stats) and returns | |||
There was a problem hiding this comment.
Add a space after arguments.
| ### External formatters | ||
| An external formatter should export a function takes two arguments(input and stats) and returns | ||
| a string with the formatted output. Below are examples of the structure that the two arguments | ||
| will be on. Input is a list of files with lint messages and stats is a object with severity as key |
| if (!{}.hasOwnProperty.call(formatters, format)) { | ||
| throw new Error(`Formatter with name '${format}' does not exist.`) | ||
| let formatter | ||
| if (/^require:/.test(format)) { |
There was a problem hiding this comment.
I was thinking it could try to load the external formatter if the name is not one of the builtin ones, instead of having to specify require, but maybe it's better to be explicit?
There was a problem hiding this comment.
I did it explicitly because require is very slow and most use cases is probably going to use an internal one. Also being explicit is good thing ✌️
There was a problem hiding this comment.
You would only call require if the name is not one of the builtins, so it shouldn't matter that it is slow. But sure, being explicit is fine.
relekang
force-pushed
the
feat/external-output-formatter
branch
from
c011b53
to
85256f8
Compare
|
Hi! Any news on this ? I would love to get this feature 😃 |
|
Cool, I had kind of forgotten about this or not prioritised it. If you are interested, I am propably able to do it this week, as in today or tomorrow. Btw, what format are you interested in? |
|
The main issue we have today with the This particular issue can be fixed by updating the |
|
This sounds like a good thing to fix in the text reporter in addition to landing this feature. Are you up for submitting a PR for the text formatter? |
|
No problem, I'll try to submit a PR for this today. |
relekang
force-pushed
the
feat/external-output-formatter
branch
from
85256f8
to
73bb35a
Compare
Fixes #25