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: Update getting-started.md #16164

Closed
wants to merge 1 commit into from

Conversation

blueberryapple
Copy link

@blueberryapple blueberryapple commented Jul 27, 2022

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?

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 27, 2022

CLA Not Signed

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Jul 27, 2022
@eslint-github-bot
Copy link

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.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@netlify
Copy link

netlify bot commented Jul 27, 2022

Deploy Preview for docs-eslint canceled.

Name Link
🔨 Latest commit 3cbe11f
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62e0c3641a80df00085611b0

@blueberryapple blueberryapple changed the title chore(docs): Update getting-started.md docs: Update getting-started.md Jul 27, 2022
@eslint-github-bot
Copy link

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.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Jul 27, 2022
Comment on lines +27 to +30

# or

yarn dlx @eslint/create-config
Copy link
Member

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)

Copy link
Author

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:

After that, you can run ESLint on any file or directory like this:
```shell
npx eslint yourfile.js
# or
yarn run eslint yourfile.js
```

Copy link
Member

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 :)

Copy link
Member

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.

@nzakas
Copy link
Member

nzakas commented Jul 28, 2022

We purposely left this out, so closing.

@nzakas nzakas closed this Jul 28, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jan 25, 2023
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jan 25, 2023
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 triage An ESLint team member will look at this issue soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants