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: Update getting-started.md
#16164
Conversation
|
Hi @blueberryapple!, 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.
To Fix: You can fix this problem by running Read more about contributing to ESLint here |
✅ Deploy Preview for docs-eslint canceled.
|
getting-started.md
getting-started.md
Hi @blueberryapple!, 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.
To Fix: You can fix this problem by running Read more about contributing to ESLint here |
|
||
# or | ||
|
||
yarn dlx @eslint/create-config |
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.
This was intentional we didn't want to add all package managers for initializing the config. #16084 (comment)
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.
Then we should probably remove the yarn command here too:
eslint/docs/src/user-guide/getting-started.md
Lines 35 to 43 in 3cbe11f
After that, you can run ESLint on any file or directory like this: | |
```shell | |
npx eslint yourfile.js | |
# or | |
yarn run eslint yourfile.js | |
``` |
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.
Yea good catch, may be we can remove it. But would like to hear from others as well :)
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.
The installation case is different than the execution case. For installation, the command will ask if you want to install using npm, yarn, pnpm, etc. so it doesn’t really matter how you run it. I think for executing eslint it make sense to also mention yarn.
We purposely left this out, so closing. |
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 autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Updated getting started command to include instructions for yarn 2+.
Is there anything you'd like reviewers to focus on?