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: Added naming convention details to plugin usage #12202
Conversation
Thank you for working on this. I think that this should be in the "Configuring ESLint" page because it's about configuration rather than the plugin implementation. ( in other words, it's for the users of plugins rather than plugin authors) |
That actually makes a lot of sense. I've amended the changes to move the Naming Convention section to the proper page. |
Even though I amended the commits to use the correct user, the CLA bot is still complaining. What can we do about this? |
I'm not familiar with the CLA checker, but I guess that one of the commits in this PR has a different email. |
Added clarification about the answer regarding #12190.
Looks like doing a rebase fixed it. |
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, but I think that leaving the list style as-is is better because of keeping the change smaller.
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.
There are a lot of changes of bullet list prefixes from *
to -
. Could you please revert those so the diff is easier to read? Thanks!
I just did that because one of the CI jobs was complaining about it. |
No, but I'm surprised the CI jobs enforce that list style. Not sure if we changed something in configuration somewhere... |
No. Read the lint message. You have fixed it with a wrong way.
|
LOL, I feel so stupid 😅 I've read the docs. Looks like when there's no explicit config, the linter will only ensure consistent usage across the file. That's the reason why it passed when I changed all asterisks to dashes. Anyways, I've amended the commits, should be okay now. |
What is the purpose of this pull request? (put an "X" next to item)
What changes did you make?
Updated the "Working with Plugins" documentation section to clarify the usage of scoped and non-scoped packages for ESLint plugins. This was something that was never really clear to me, which led me to openning #12190 .
Is there anything you'd like reviewers to focus on?
I am not sure I made the edits in the right place. If not, please point me to the right direction.