Skip to content
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

Merged
merged 2 commits into from Sep 14, 2019
Merged

Docs: Added naming convention details to plugin usage #12202

merged 2 commits into from Sep 14, 2019

Conversation

hbarcelos
Copy link
Contributor

@hbarcelos hbarcelos commented Sep 2, 2019

What is the purpose of this pull request? (put an "X" next to item)

  • 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?

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.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Sep 2, 2019
@mysticatea
Copy link
Member

mysticatea commented Sep 2, 2019

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)

@mysticatea mysticatea added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Sep 2, 2019
@jsf-clabot
Copy link

jsf-clabot commented Sep 3, 2019

CLA assistant check
All committers have signed the CLA.

@hbarcelos
Copy link
Contributor Author

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.

@hbarcelos hbarcelos marked this pull request as ready for review September 3, 2019 21:08
@hbarcelos
Copy link
Contributor Author

Even though I amended the commits to use the correct user, the CLA bot is still complaining. What can we do about this?

@mysticatea
Copy link
Member

mysticatea commented Sep 4, 2019

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.
@hbarcelos
Copy link
Contributor Author

Looks like doing a rebase fixed it.

Copy link
Member

@mysticatea mysticatea left a 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.

Copy link
Member

@platinumazure platinumazure left a 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!

@hbarcelos
Copy link
Contributor Author

I just did that because one of the CI jobs was complaining about it.
Is it ok to have them failing?

@platinumazure
Copy link
Member

Is it ok to have them failing?

No, but I'm surprised the CI jobs enforce that list style. Not sure if we changed something in configuration somewhere...

@mysticatea
Copy link
Member

No. Read the lint message. You have fixed it with a wrong way.

docs/user-guide/configuring.md: 359: MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/user-guide/configuring.md: 360: MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/user-guide/configuring.md: 361: MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
https://github.com/eslint/eslint/runs/210954641

@hbarcelos hbarcelos changed the title Added naming convention details to plugin usage Docs: Added naming convention details to plugin usage Sep 6, 2019
@hbarcelos
Copy link
Contributor Author

hbarcelos commented Sep 6, 2019

No. Read the lint message. You have fixed it with a wrong way.

docs/user-guide/configuring.md: 359: MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/user-guide/configuring.md: 360: MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/user-guide/configuring.md: 361: MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
https://github.com/eslint/eslint/runs/210954641

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants