Skip to content

Commit

Permalink
docs: IA Update page URL move
Browse files Browse the repository at this point in the history
  • Loading branch information
kecrily committed Feb 28, 2023
1 parent d44826b commit 11a79dd
Showing 1 changed file with 106 additions and 4 deletions.
110 changes: 106 additions & 4 deletions src/use/getting-started.md
Expand Up @@ -79,7 +79,7 @@ yarn run eslint yourfile.js
* `"warn"``1` - 启用并警告(不影响现有代码)
* `"error"``2` - 启用并报错(错误代码 1)

你可以调节这三档错误级别以精准控制 ESLint 规则实施方式(更多配置项和细节,参见[配置文档](configuring/))。
你可以调节这三档错误级别以精准控制 ESLint 规则实施方式(更多配置项和细节,参见[配置文档](configure/))。

你的 `.eslintrc.{js,yml,json}` 配置文件也会包括这一行:

Expand All @@ -89,14 +89,116 @@ yarn run eslint yourfile.js
}
```

<<<<<<< HEAD
这一行将启用[所有标记为“推荐”的规则](../rules/)。另外,你也可以通过在 [npmjs.com](https://www.npmjs.com/search?q=eslint-config) 上搜索“eslint-config”并使用别人创建的配置。在没有扩展别人的可共享配置或在配置中明确启用规则时,ESLint 不会限制你的代码。
||||||| parent of 3ffc6a1 (docs: IA Update page URL move)
这一行将启用[所有标记为“推荐”的规则](../rules)。另外,你也可以通过在 [npmjs.com](https://www.npmjs.com/search?q=eslint-config) 上搜索“eslint-config”并使用别人创建的配置。在没有使用别人的可共享配置或在配置中明确启用规则时,ESLint 不会检查你的代码。

## 全局安装

也可以全局安装 ESLint 而不仅限于羡慕本地(使用 `npm install eslint --global`)。但并不推荐这样做,因为即使全局安装 ESLint,你仍需要在本地安装插件和可共享配置。

## 手动设置

你也可以在项目中手动设置 ESLint.

在开始前你必须确保存在 `package.json` 文件。如果不存在,请优先运行 `npm init``yarn init` 来创建此文件。

1. 在项目中安装 ESLint 包:

```shell
npm install --save-dev eslint
```

1. 添加任一[支持的配置文件格式](./configuring/configuration-files#配置文件格式)`.eslintrc` 文件。

```shell
# 创建 JavaScript 配置文件
touch .eslintrc.js
```

1.`.eslintrc` 文件中添加配置。阅读[配置 ESLint 文档](configuring/)学习如何添加规则、环境、自定义配置、插件以及其他内容。

```js
// .eslintrc.js 示例
module.exports = {
"env": {
"browser": true,
"es2021": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module"
},
}
```

1. 使用 ESLint 命令行检查代码:

```shell
npx eslint project-dir/ file1.js
```

更多关于可用命令行选项的信息,参见[命令行文档](./command-line-interface)
=======
这一行将启用[所有标记为“推荐”的规则](../rules)。另外,你也可以通过在 [npmjs.com](https://www.npmjs.com/search?q=eslint-config) 上搜索“eslint-config”并使用别人创建的配置。在没有使用别人的可共享配置或在配置中明确启用规则时,ESLint 不会检查你的代码。

## 全局安装

也可以全局安装 ESLint 而不仅限于羡慕本地(使用 `npm install eslint --global`)。但并不推荐这样做,因为即使全局安装 ESLint,你仍需要在本地安装插件和可共享配置。

## 手动设置

你也可以在项目中手动设置 ESLint.

在开始前你必须确保存在 `package.json` 文件。如果不存在,请优先运行 `npm init``yarn init` 来创建此文件。

1. 在项目中安装 ESLint 包:

```shell
npm install --save-dev eslint
```

1. 添加任一[支持的配置文件格式](./configure/configuration-files#配置文件格式)`.eslintrc` 文件。

```shell
# 创建 JavaScript 配置文件
touch .eslintrc.js
```

1.`.eslintrc` 文件中添加配置。阅读[配置 ESLint 文档](configure/)学习如何添加规则、环境、自定义配置、插件以及其他内容。

```js
// .eslintrc.js 示例
module.exports = {
"env": {
"browser": true,
"es2021": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module"
},
}
```

1. 使用 ESLint 命令行检查代码:

```shell
npx eslint project-dir/ file1.js
```

更多关于可用命令行选项的信息,参见[命令行文档](./command-line-interface)
>>>>>>> 3ffc6a1 (docs: IA Update page URL move)
---

## 下一步

* 了解 ESLint [可选配置](configuring/)
* 了解 ESLint [可选配置](configure/)
* 熟悉一下[命令行选项](command-line-interface)
*[ESLint 集成](integrations)带到诸如编辑器、构建系统以及其他工具中。
* 找不到合适的规则?创造属于自己的[自定义规则](../developer-guide/working-with-rules)
* 通过[贡献](../developer-guide/contributing/)让 ESLint 变得更棒。
* 找不到合适的规则?创造属于自己的[自定义规则](../extend/custom-rules)
* 通过[贡献](../contribute//)让 ESLint 变得更棒。

0 comments on commit 11a79dd

Please sign in to comment.