New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Fix JS syntax and doc URL in working-with-custom-formatters.md #13828
Conversation
Hi @nostalic!, thanks for the Pull Request The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.
Read more about contributing to ESLint here |
Hi @nostalic!, thanks for the Pull Request The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.
Read more about contributing to ESLint here |
@snitin315 I had to push the change again due to the commit message check - no code changes involved. Could you please review and approve again if correct? thanks! |
Missing parenthesis on ruleUrl causing syntax error in detailed formatter
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nostalic thanks for the PR!
The change looks good, but formatter still isn't working as intended because there was another "bug".
Can you please also change line 198:
- ruleUrl: data.rulesMeta[msg.ruleId].url,
+ ruleUrl: data.rulesMeta[msg.ruleId].docs.url,
ruleUrl needs to get URL from the docs object
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks! Now it produces output that looks like the example at the end of this section.
Just removed an extra space from the end of the PR title. |
Thanks for contributing! |
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an 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)
Fix a minor JS typo in the custom formatter documentation sample for detailed formatter which causes a syntax error https://eslint.org/docs/developer-guide/working-with-custom-formatters#detailed-formatter
Is there anything you'd like reviewers to focus on?