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.

Sign up for GitHub

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

Jump to bottom

docs: Remove the $ prefix in terminal commands #15565

Merged
merged 5 commits into from Feb 4, 2022
Merged

docs: Remove the $ prefix in terminal commands #15565

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a0eb72f
Remove the $ prefix in terminal commands
Feb 2, 2022
b804024
docs: Remove the $ prefix in terminal commands
Feb 2, 2022
32a075f
Merge branch 'patch-1' of https://github.com/AndreasLewis/eslint into…
Feb 4, 2022
782ed89
docs: Remove $ prefix from all commands w/o output
Feb 4, 2022
632d91e
docs: Remove MD014 rule
Feb 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/user-guide/getting-started.md
View file
Open in desktop
Expand Up @@ -23,23 +23,23 @@ yarn add eslint --dev
You should then set up a configuration file, and the easiest way to do that is:

```shell
$ npm init @eslint/config
npm init @eslint/config

# or

$ yarn create @eslint/config
yarn create @eslint/config
```

**Note:** `npm init @eslint/config` assumes you have a `package.json` file already. If you don't, make sure to run `npm init` or `yarn init` beforehand.

After that, you can run ESLint on any file or directory like this:

```shell
$ npx eslint yourfile.js
npx eslint yourfile.js

# or

$ yarn run eslint yourfile.js
yarn run eslint yourfile.js
```

It is also possible to install ESLint globally rather than locally (using `npm install eslint --global`). However, this is not recommended, and any plugins or shareable configs that you use must be installed locally in either case.
Expand Down