这期内容当中小编将会给大家带来有关Node.js项目中怎么安装和使用ESLint,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。
ESLint 是一个开源 JavaScript linting 实用程序,它可以帮助我们规范代码,克服开发人员的一些意想不到错误,因为 JavaScript 是弱类型的语言。
Javascript 社区中有很多规范化选项,比如 JSHint 和 JSCS,用于代码 linting,包括今天我们要讲的 ESLint。
ESLint 旨在使所有规则完全可插入。这是它产生的主要原因之一。它允许开发人员创建自己的 linting 规则。ESLint 官方指南中提供的每个规则都是独立的规则,开发人员可以在任何时候决定是否使用特定的规则。
安装
对于项目目录的本地安装:
$ npm i eslint -D
对于工作系统中的全局安装:
$ npm i eslint -g
安装好后,我们就可以通过终端中的 eslint
命令使用 ESLint。
配置
最简单的配置方法是设置一个 .eslintrc
JSON 文件,其中可以描述所有的 linting 规则。
.eslintrc
的一个示例:
{
"env": {
"node": true,
"browser": true
},
"globals": {
"exampleGlobalVariable": true
},
"rules": {
"no-console": 0,
"space-infix-ops": "error",
"quotes": ["error", "single", {
"avoidEscape": true,
"allowTemplateLiterals": true
}],
"space-before-blocks": ["error", "always"],
"semi": ["error", "never"]
},
"plugins": []
}
主要字段:
parse
— 指定解析器parserOptions
— 指定解析器选项env
— 指定脚本的运行环境root
— 为true
时,停止向上查找父级目录中的配置文件globals
— 脚本在执行期间访问的额外的全局变量rules
— 在此处添加您的自定义规则
如果全局安装了 eslint,我们还可以使用以下命令生成配置文件:
$ eslint --init
在其他情况下,如果您已在本地将其安装到项目中,则需要在终端中输入:
$ ./node_modules/.bin/eslint --init
在这两种情况下,都会提示您生成 .eslintrc
文件的一组基本规则。
上述提示后生成的文件示例:
{
"env": {
"browser": true,
"commonjs": true,
"es2021": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": 12
},
"rules": {
"indent": [
"error",
"tab"
],
"linebreak-style": [
"error",
"windows"
],
"quotes": [
"error",
"single"
],
"semi": [
"error",
"never"
]
}
}
有关配置的详细信息,请阅读:
http://eslint.org/docs/user-guide/configuring
为了方便运行,我们可以在项目的 package.json
,在 scripts
字段里面添加以下脚本:
{
"scripts" : {
"lint": "eslint ***.js -f html -o ./reports/lint-results.html",
"lint-fix": "eslint --fix **
'react/boolean-prop-naming': 'off',
'react/button-has-type': 'off',
'react/default-props-match-prop-types': 'off',
'react/destructuring-assignment': 'off',
'react/display-name': 'off',
// ...
}
}
上述就是小编为大家分享的Node.js项目中怎么安装和使用ESLint了,如果刚好有类似的疑惑,不妨参照上述分析进行理解。如果想知道更多相关知识,欢迎关注编程网行业资讯频道。