From 776827a1748da88a25e7903bd794f5439de922b5 Mon Sep 17 00:00:00 2001 From: Percy Ma Date: Wed, 9 Nov 2022 17:03:03 +0800 Subject: [PATCH] docs: init config about specifying shared configs (#16483) * docs: init config about specifying shared configs * remove yarn command * Update docs/src/user-guide/getting-started.md Co-authored-by: Nitin Kumar * Update docs/src/user-guide/getting-started.md Co-authored-by: Milos Djermanovic Co-authored-by: Nitin Kumar Co-authored-by: Milos Djermanovic --- docs/src/user-guide/getting-started.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/src/user-guide/getting-started.md b/docs/src/user-guide/getting-started.md index 675e94f10d0..7c1b048181f 100644 --- a/docs/src/user-guide/getting-started.md +++ b/docs/src/user-guide/getting-started.md @@ -25,6 +25,28 @@ You can install and configure ESLint using this command: npm init @eslint/config ``` +If you want to use a specific shareable config that is hosted on npm, you can use the `--config` option and specify the package name: + +```shell +# use `eslint-config-semistandard` shared config +# npm 6.x +npm init @eslint/config --config semistandard + +# ⚠️ npm 7+, extra double-dash is needed: +npm init @eslint/config -- --config semistandard + +# or (`eslint-config` prefix is optional) +npm init @eslint/config -- --config eslint-config-semistandard +``` + +The `--config` flag also supports passing in arrays: + +```shell +npm init @eslint/config -- --config semistandard,standard +# or +npm init @eslint/config -- --config semistandard --config standard +``` + **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: