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: include notes about globals in migration-guide #18356
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sindresorhus/globals#239 (comment) When installing it, you will always get the latest version. This change may be more distracting to users. |
I would suggest a more appropriate place to be: https://eslint.org/docs/latest/use/troubleshooting/. Let's hear from the others. @eslint/eslint-team |
You have to remember that some devs (like me) are stupid 😅, I thought this was some magic global package from node or something ("it worked before, I should just change the code to what the guide tells me right?"), so I just imported the package and saw that it was already installed in About the troubleshooting: I'm already trying to find a way to solve the global problem.. why do I have to hunt in another potentially unrelated place the solution? For the specific string search on docs (whitespace issue) I guess it makes sense to be there, but saying "hey, this is not magic, we included the package for you before, but now you'll need to install and use it yourself" would be helpful |
you should always install the package - even if you have not encountered this problem. It may be working without explicitly installing as it may be an indirect dependency, while your package manager (like npm v3+) just flattened it. But it should be avoided. |
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
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! Would like another review before merging.
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!
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
I'm trying to not get too much frustrated with the migration & migration guides.. so I thought I could contribute on the issues I have faced, hopefully they're welcome 🙏
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Added a note about the required instalation of the
globals
package (docs don't make it clear that globals is not a magic package and that we need to make it a direct dev dependency)Is there anything you'd like reviewers to focus on?