ESLint学习与使用
- 一、eslint安装
- 二、生成配置文件,初始化
- 三、关于ESLint的配置方式
- 四、关于ESLint的配置属性与忽略文件
- 五、关于eslint之地红检查vue,jsx文件的编译命令
- 六 、在webstorm中使用eslint,在代码编写过程中就检测错误
- 七、在webpack编译的时候,进行eslint检测 --借助webpack的preLoaders
- 八、在git提交的时候进行eslint检测
一、eslint安装
npm install -g eslint
npm install -D eslint
vue init webpack 然后在创建eslint的选项中选yes
二、生成配置文件,初始化
#采用局部安装的方式安装eslint之后,使用下面命令进行初始化
npx eslint --init
#如果是采用vue init webpack安装的,那么eslint完全配置好了。
三、关于ESLint的配置方式
# 在package.json的同级目录,创建eslintrc.js /eslintrc.json/eslintrc.yml文件
- 使用js注释,临时为指定文件,或者文件中的某一行添加rules。
# 在 js,vue,jsx 等文夹头中加入含有eslint的注释
# 在 js,vue,jsx 等文件的某一行代码中加入含有eslint的注释
alert(foo);
四、关于ESLint的配置属性与忽略文件
- ESLint可以设置忽略检查的目录
- 第一种方式: 在package.json文件中配置 'eslintIgnore’属性指定要忽略的文件。
{
'eslintIgnore' : ['hello.js', 'world.js']
}
- 第二种方式: 在 .eslintrc.js 同级目录创建 .eslintignore 文件,忽略规则与gitignore相同。
- 以#开头的行被当做注释,不影响忽略模式。
- 路径是相对于 .eslintrc.js 或者 当前工作目录。
- 忽略模式同 .gitignore规范。
- 以 !开头的行是否定模式,它将会重新包含一个之前的忽略的模式。
常见的eslintignore配置:
/build/ 忽略build目录
/config/ 忽略config目录
/dist/ 忽略dist目录
- ESLint的配置属性
module.exports = {
#root: true 禁止持续查找
#eslint将在根目录下的所有父文件夹中查找配置文件。该属性的左右是一旦发现了配置文件就停止对父文件夹的查找。
root: true
# 解析器选项
parserOptions {
#ES的版本,默认是5;如果要使用es6,指定6即可。
ecmaVersion : 6
#配置js文件的加载模式,script表示标签引入js,module表示模块引入js。
sourceType: "module"
#配置想要使用的额外语言特性
ecmaFeatures: {
#启用对对象的扩展
experimentalObjectRestSpread : true
#启用jsx语法
jsx : true
#允许return在全局使用
gloablReturn : true
#启用严格校验模式
impliedStrict: true
}
#解析器,默认情况下ESLint使用Espree解析器,这里使用babel-eslint
parser : 'babel-eslint'
}
# 预设全局环境变量
env {
#常见的环境变量有:
browser : 浏览器全局变量;
node : nodejs全局变量和nodejs范围;
common.js : CommonJS全局变量;
shared-node-browser:nodejs和browser的通用全局;
es6:启用除模块外的所有es6功能(需要将ecmaVersion解析器设置为6);
mocha:增加所有的Mocha测试全局变量;
jquery:jquery全局变量;
mongo:MongoDB全局变量;
browser: true
}
# 除了env中预先设置的全局变量,也可以使用globals来自定义全局环境变量;
# document : true 表示可读可写;
# window : readonly 表示可读不可写;
globals : {
"document" : true,
"navigator" : true,
"window" : "readonly"
}
# extends 继承
# 可以通过extends配置基础属性,可以分为覆盖和继承两种方式。
# 可以制定本地的eslint-config文件;也可以指定第三方的配置文件,不给过第三方的一般需要plugins支持.
extends : [
'plugin:vue/essential',
'standard'
]
# plugins 插件
# 如果需要对某类文件进行检测,需要对应的插件支持。一般针对react,vue。
# plugins : ['standard', 'promise', 'react', 'vue']
plugins : [
'vue'
]
# rules 配置eslint的规则
# -- 规则的错误等级有三种:
# ---- 'off'或者0 :表示关闭规则。
# ---- ‘warn’或者1 : 表示打开规则,并作为一个警告(不影响exit code)。
# ---- ‘error’或者2:表示打开规则,并作为一个错误(exit code将会是1)
rules: {
/ 可能的错误
"no-cond-assign": 2,
"no-console": 0,
"no-constant-condition": 2,
"no-control-regex": 2,
"comma-dangle": [1, "never"],
"no-debugger": 2,
"no-dupe-args": 2,
"no-dupe-keys": 2,
"no-duplicate-case": 2,
"no-empty": 2,
"no-empty-character-class": 2,
"no-ex-assign": 2,
"no-extra-boolean-cast": 2,
"no-extra-parens": 0,
"no-extra-semi": 2,
"no-func-assign": 2,
"no-inner-declarations": [2, "functions"],
"no-invalid-regexp": 2,
"no-irregular-whitespace": 2,
"no-negated-in-lhs": 2,
"no-obj-calls": 2,
"no-prototype-builtins": 0,
"no-regex-spaces": 2,
"no-sparse-arrays": 2,
"no-unexpected-multiline": 2,
"no-unreachable": 2,
"use-isnan": 2,
"valid-jsdoc": 1,
"valid-typeof": 2,
"accessor-pairs": 2,
"array-callback-return": 0,
"block-scoped-var": 0,
"complexity": [2, 9],
"consistent-return": 0,
"curly": [2, "all"],
"default-case": 2,
"dot-location": [2, "property"],
"dot-notation": [2, {
"allowKeywords": false
}],
"eqeqeq": [2, "allow-null"],
"guard-for-in": 2,
"no-alert": 0,
"no-caller": 2,
"no-case-declarations": 2,
"no-div-regex": 2,
"no-else-return": 0,
"no-empty-function": 2,
"no-empty-pattern": 2,
"no-eq-null": 1,
"no-eval": 2,
"no-extend-native": 2,
"no-extra-bind": 2,
"no-extra-label:": 0,
"no-fallthrough": 2,
"no-floating-decimal": 2,
"no-implicit-coercion": 0,
"no-implicit-globals": 1,
"no-implied-eval": 2,
"no-invalid-this": 0,
"no-iterator": 2,
"no-labels": 2,
"no-lone-blocks": 2,
"no-loop-func": 1,
"no-magic-numbers": [1, {
"ignore": [0, -1, 1]
}],
"no-multi-spaces": 2,
"no-multi-str": 2,
"no-native-reassign": 2,
"no-new": 2,
"no-new-func": 0,
"no-new-wrappers": 2,
"no-octal": 2,
"no-octal-escape": 2,
"no-param-reassign": 0,
"no-proto": 2,
"no-redeclare": 2,
"no-return-assign": 0,
"no-script-url": 0,
"no-self-assign": 2,
"no-self-compare": 2,
"no-sequences": 2,
"no-throw-literal": 2,
"no-unmodified-loop-condition": 2,
"no-unused-expressions": 0,
"no-unused-labels": 2,
"no-useless-call": 2,
"no-useless-concat": 2,
"no-useless-escape": 0,
"no-void": 0,
"no-warning-comments": 0,
"no-with": 2,
"radix": 2,
"vars-on-top": 0,
"wrap-iife": [2, "any"],
"yoda": [2, "never"],
"strict": 0,
"init-declarations": 0,
"no-catch-shadow": 0,
"no-delete-var": 2,
"no-label-var": 2,
"no-restricted-globals": 0,
"no-shadow": 0,
"no-shadow-restricted-names": 2,
"no-undef": 2,
"no-undef-init": 2,
"no-undefined": 0,
"no-unused-vars": [2, {
"vars": "all",
"args": "none"
}],
"no-use-before-define": 0,
"callback-return": 0,
"global-require": 1,
"handle-callback-err": [2, "^(err|error)$"],
"no-mixed-requires": 0,
"no-new-require": 2,
"no-path-concat": 0,
"no-process-env": 0,
"no-process-exit": 0,
"no-sync": 0,
"array-bracket-spacing": [2, "never"],
"block-spacing": [1, "never"],
"brace-style": [2, "1tbs", {
"allowSingleLine": true
}],
"camelcase": 2,
"comma-spacing": [2, {
"before": false,
"after": true
}],
"comma-style": [2, "last"],
"computed-property-spacing": [2, "never"],
"consistent-this": [1, "that"],
"func-names": 0,
"eol-last": 2,
"indent": [2, 4, {
"SwitchCase": 1
}],
"key-spacing": [2, {
"beforeColon": false,
"afterColon": true
}],
"linebreak-style": [1, "unix"],
"lines-around-comment": [1, {
"beforeBlockComment": true
}],
"func-style": 0,
"max-nested-callbacks": [1, 5],
"id-blacklist": 0,
"id-length": 0,
"id-match": 0,
"jsx-quotes": 0,
"keyword-spacing": 2,
"max-len": [1, 200],
"max-lines": 0,
"max-params": [1, 7],
"max-statements": [1, 200],
"max-statements-per-line": 0,
"new-cap": [2, {
"newIsCap": true,
"capIsNew": false
}],
"new-parens": 2,
"newline-after-var": 0,
"no-array-constructor": 2,
"no-bitwise": 0,
"newline-before-return": 0,
"newline-per-chained-call": 1,
"no-continue": 0,
"no-inline-comments": 0,
"no-lonely-if": 0,
"no-mixed-operators": 0,
"no-mixed-spaces-and-tabs": 2,
"no-multiple-empty-lines": [2, {
"max": 2
}],
"no-negated-condition": 0,
"no-nested-ternary": 0,
"no-new-object": 2,
"no-plusplus": 0,
"no-restricted-syntax": 0,
"no-spaced-func": 2,
"no-ternary": 0,
"no-trailing-spaces": 2,
"no-underscore-dangle": 0,
"no-unneeded-ternary": 2,
"no-whitespace-before-property": 0,
"object-curly-newline": 0,
"object-curly-spacing": 0,
"object-property-newline": 0,
"one-var": [2, {
"initialized": "never"
}],
"one-var-declaration-per-line": 0,
"operator-assignment": 0,
"operator-linebreak": [2, "after", {
"overrides": {
"?": "before",
":": "before"
}
}],
"padded-blocks": 0,
"quote-props": 0,
"quotes": [2, "double", "avoid-escape"],
"require-jsdoc": 1,
"semi": [2, "always"],
"semi-spacing": 0,
"sort-vars": 0,
"space-before-blocks": [2, "always"],
"space-before-function-paren": [0, "always"],
"space-in-parens": [2, "never"],
"space-infix-ops": 2,
"space-unary-ops": [2, {
"words": true,
"nonwords": false
}],
"spaced-comment": [2, "always", {
"markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!"] }],
"unicode-bom": 0,
"wrap-regex": 0,
"arrow-body-style": 2,
"arrow-parens": 2,
"arrow-spacing": [2, {
"before": true,
"after": true
}],
"constructor-super": 0,
"generator-star-spacing": [2, {
"before": true,
"after": true
}],
"no-class-assign": 2,
"no-confusing-arrow": 0,
"no-const-assign": 2,
"no-dupe-class-members": 2,
"no-duplicate-imports": 0,
"no-new-symbol": 2,
"no-restricted-imports": 0,
"no-this-before-super": 2,
"no-useless-computed-key": 0,
"no-var": 0,
"object-shorthand": 0,
"prefer-arrow-callback": 0,
"prefer-const": 0,
"prefer-reflect": 0,
"prefer-spread": 0,
"prefer-template": 0,
"prefer-rest-params": 0,
"require-yield": 0,
"rest-spread-spacing": 0,
"sort-imports": 0,
"template-curly-spacing": 1,
"yield-star-spacing": 2
}
},
# glob方式强制指定特定文件的rules。
overrides : {
files : ['*.test.js'],
rules : {
'no-console' : 'off',
'quotes' : ['error', 'single']
}
}
}
五、关于eslint之地红检查vue,jsx文件的编译命令
npx eslint --ext .js,.vue src
六 、在webstorm中使用eslint,在代码编写过程中就检测错误
Prefrences --> Language & Frameworks --> Javascript --> Code Quality Tools --> Eslint --> Enable --> apply
七、在webpack编译的时候,进行eslint检测 --借助webpack的preLoaders
module : {
preLoaders : [
{
test : /\.jsE$/,
exclude : /node_modules/,
loader : 'eslint-loader'
}
]
}
八、在git提交的时候进行eslint检测
npm install huskey -D
{
"huskey" : {
"hooks" : {
"pre-commit" : "npx eslint src"
}
}
}