Docs: Updated Working with Custom Formatters (fixes #9950) #10592
Conversation
eslint-deprecated
bot
added
the
triage
kaicataldo
added
bug
| @@ -254,48 +296,13 @@ error semi | |||
|
|
|||
| ### Using a JSON formatter first | |||
There was a problem hiding this comment.
I wonder if we can make this header clearer now? Something that gets across Outputting to a standard format for other programs to consume? I don't like that exactly, but does that make sense?
| ``` | ||
|
|
||
| And then the formatter can read from stdin | ||
| You can use ESLint's built-in JSON formatter first, and pipe the output to another program that accepts JSON linter results. |
There was a problem hiding this comment.
If we change the header of this section this could be You can use ESLint's built-in JSON formatter and pipe the output to another program that accepts JSON linter results.
There was a problem hiding this comment.
Yeah! I hear you on the title being kinda off now. I'll think about alternate titles for the section and get back to you, probably tomorrow. Will also make that change in wording once the title is nailed down. Thanks for reviewing!
There was a problem hiding this comment.
Ok, how about just "Using built-in formatters with custom formatters" ? I guess you could use the other formatters too, like HTML or something, and then send it to another program to do something with. Since this is the "using custom formatters" page, the "other program" is probably going to format the results. LMK what you think or if you've got other ideas. I'll hold off on submitting another PR until we come to a decision.
There was a problem hiding this comment.
I think that's a bit confusing, personally. I wonder if Outputting to a standard format for other programs to consume actually does work? I think it gets across what this section is trying to convey.
There was a problem hiding this comment.
Yeah, okay. It's a little long but it's probably better to be too long than be confusing. How about we try it out? I'll change the title to that and resubmit the PR.
There was a problem hiding this comment.
Sounds good - we can always change it later if it's confusing! No need to resubmit - you can either add another commit to this branch (we squash and merge) or amend the current commit and force push it. Thanks for working on this!
There was a problem hiding this comment.
Cool! I'll try to amend the current commit. Thank you!
There was a problem hiding this comment.
I tried to amend the current commit, it looks like it made a new commit. Is there anything else I need to do, or will this just get squashed and merged? Thanks!
There was a problem hiding this comment.
Multiple commits is fine! We'll just squash when we merge. Thanks!
There was a problem hiding this comment.
Awesome! Thank you!
Updated title of last section to "Outputting to a standard format for other programs to consume"
|
Ah, one final thing from me: do you mind updating the title of the PR to the first commit message ( |
marla294
changed the title
|
Sure thing - updated! |
|
Merged! Thanks @marla294 for improving the documentation! |
eslint-deprecated
bot
added
the
archived due to age
What is the purpose of this pull request? (put an "X" next to item)
[ X ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Rewrote the Using a JSON formatter first section of documentation.
Is there anything you'd like reviewers to focus on?
Let me know if there's anything you'd like to see different with this, and I'll update. Thanks for allowing me to contribute!