摘要:使用去定义配置的结构,的文件允许风格的注释已弃用在里创建一个属性,在那里定义你的配置属性支持使用第三方插件以开头的包,在使用插件之前,必须使用安装。如等属性一个配置文件可以被基础配置中的已启用的规则继承。
一、Eslint安装 1.全局安装
如果你想使 ESLint 适用于你所有的项目,建议全局安装 ESLint
$ npm install -g eslint
初始化配置文件
$ eslint --init2.局部安装
$ npm install eslint --save-dev
初始化配置文件
$ ./node_modules/.bin/eslint --init3.webpack中配置eslint
需要安装eslint-loader解析.eslint文件
{ test: /.(js|jsx|mjs)$/, enforce: "pre", use: [ { options: { formatter: eslintFormatter, eslintPath: require.resolve("eslint"), }, loader: require.resolve("eslint-loader"), }, ], include: paths.appSrc, //也可以用exclude排除不需要检查的目录或者用.eslintignore },二、ESlint配置 1.配置文件类型与优先级顺序
.eslintrc.js - 使用 .eslintrc.js 然后输出一个配置对象
.eslintrc.yaml - 使用 .eslintrc.yaml 或 .eslintrc.yml 去定义配置的结构。
.eslintrc.yml
.eslintrc.json - 使用 .eslintrc.json 去定义配置的结构,ESLint 的 JSON 文件允许 JavaScript 风格的注释
.eslintrc(已弃用)
package.json - 在 package.json 里创建一个 eslintConfig属性,在那里定义你的配置
2.plugin属性ESLint 支持使用第三方插件(以eslint-plugin-开头的npm包),在使用插件之前,必须使用 npm 安装。如eslint-plugin-react、eslint-plugin-vue等
module.exports = { "plugins": [ "react" ], "extends": [ "eslint:recommended" ], "rules": { "no-set-state": "off" } }3.extends属性
一个配置文件可以被基础配置中的已启用的规则继承。可以使用以下规则继承:
(1)"eslint:recommended"继承Eslint中推荐的(打钩的)规则项
module.exports = { "extends": "eslint:recommended", "rules": { } }(2)使用别人写好的规则包(以eslint-config-开头的npm包),如eslint-config-standard
module.exports = { "extends": "standard", "rules": { } }(3)使用Eslint插件中命名的配置
module.exports = { "plugins": [ "react" ], "extends": [ "eslint:recommended", "plugin:react/recommended" ], "rules": { "no-set-state": "off" } }(4)使用"eslint:all",继承Eslint中所有的核心规则项
module.exports = { "extends": "eslint:all", "rules": { // override default options "comma-dangle": ["error", "always"], "indent": ["error", 2], "no-cond-assign": ["error", "always"], // disable now, but enable in the future "one-var": "off", // ["error", "never"] // disable "init-declarations": "off", "no-console": "off", "no-inline-comments": "off", } }4.rules属性(根据自己的需要进行配置) (1)Eslint部分核心规则
"rules": { /** **这些规则与 JavaScript 代码中可能的错误或逻辑错误有关 **/ "for-direction":"error",//强制 “for” 循环中更新子句的计数器朝着正确的方向移动 "getter-return":"error",//强制在 getter 属性中出现一个 return 语句 "no-await-in-loop":"error",//禁止在循环中 出现 await "no-compare-neg-zer":"error",//禁止与 -0 进行比较 "no-cond-assign":[//禁止在条件语句中出现赋值操作符 "error", "always" ], "no-console":[//禁用 console "error" // { "allow": ["warn", "error"] } ], "no-constant-condition":"error",//禁止在条件中使用常量表达式 "no-control-regex":"error",//禁止在正则表达式中使用控制字符 "no-debugger":"error",//禁用 debugger "no-dupe-args":"error",//禁止在 function 定义中出现重复的参数 "no-dupe-keys":"error",//禁止在对象字面量中出现重复的键 "no-duplicate-case":"error",//禁止重复 case 标签 "no-empty":"error",//禁止空块语句 "no-empty-character-class":"error",//禁止在正则表达式中出现空字符集 "no-ex-assign":"error",//禁止对 catch 子句中的异常重新赋值 "no-extra-boolean-cast":"error",//禁止不必要的布尔类型转换 "no-extra-parens":"error",//禁止冗余的括号 "no-extra-semi":"error",//禁用不必要的分号 "no-func-assign":"error",//禁止对 function 声明重新赋值 "no-inner-declarations":"error",//禁止在嵌套的语句块中出现变量或 function 声明 "no-invalid-regexp":"error",//禁止在 RegExp 构造函数中出现无效的正则表达式 "no-irregular-whitespace":"error",//禁止不规则的空白 "no-obj-calls":"error",//禁止将全局对象当作函数进行调用 "no-prototype-builtins":"error",//禁止直接使用 Object.prototypes 的内置属性 "no-regex-spaces":"error",//禁止正则表达式字面量中出现多个空格 "no-sparse-arrays": "error",//禁用稀疏数组 "no-template-curly-in-string":"error",//禁止在常规字符串中出现模板字面量占位符语法 "no-unexpected-multiline":"error",//禁止使用令人困惑的多行表达式 "no-unreachable":"error",//禁止在 return、throw、continue 和 break 语句后出现不可达代码 "no-unsafe-finally":"error",//禁止在 finally 语句块中出现控制流语句 "no-unsafe-negation":"error",//禁止对关系运算符的左操作数使用否定操作符 "use-isnan":"error",//要求调用 isNaN()检查 NaN "valid-jsdoc":"error",//强制使用有效的 JSDoc 注释 "valid-typeof":"error",//强制 typeof 表达式与有效的字符串进行比较 /** **最佳实践 **/ "accessor-pairs":"error",//强制getter/setter成对出现在对象中 "array-callback-return":"error",//强制数组方法的回调函数中有 return 语句 "block-scoped-var":"error",//把 var 语句看作是在块级作用域范围之内 "class-methods-use-this":"error",//强制类方法使用 this "complexity":"error"//限制圈复杂度 ..... }(2)eslint-plugin-vue中的规则
"rules": { /* for vue */ // 禁止重复的二级键名 // @off 没必要限制 "vue/no-dupe-keys": "off", // 禁止出现语法错误 "vue/no-parsing-error": "error", // 禁止覆盖保留字 "vue/no-reservered-keys": "error", // 组件的 data 属性的值必须是一个函数 "vue/no-shared-component-data": "off", // 禁止 使用 key 属性 "vue/no-template-key": "off", // render 函数必须有返回值 "vue/require-render-return": "error", // prop 的默认值必须匹配它的类型 "vue/require-valid-default-prop": "off", // 计算属性必须有返回值 "vue/return-in-computed-property": "error", // template 的根节点必须合法 "vue/valid-template-root": "error", // v-bind 指令必须合法 "vue/valid-v-bind": "error", // v-cloak 指令必须合法 "vue/valid-v-cloak": "error", // v-else-if 指令必须合法 "vue/valid-v-else-if": "error", // v-else 指令必须合法 "vue/valid-v-else": "error", // v-for 指令必须合法 "vue/valid-v-for": "error", // v-html 指令必须合法 "vue/valid-v-html": "error", // v-if 指令必须合法 "vue/valid-v-if": "error", // v-model 指令必须合法 "vue/valid-v-model": "error", // v-on 指令必须合法 "vue/valid-v-on": "error", // v-once 指令必须合法 "vue/valid-v-once": "error", // v-pre 指令必须合法 "vue/valid-v-pre": "error", // v-show 指令必须合法 "vue/valid-v-show": "error", // v-text 指令必须合法 "vue/valid-v-text": "error", // // 最佳实践 // // @fixable html 的结束标签必须符合规定 // @off 有的标签不必严格符合规定,如(3)eslint-plugin-react中的规则
或
都应该是合法的 "vue/html-end-tags": "off", // 计算属性禁止包含异步方法 "vue/no-async-in-computed-properties": "error", // 禁止出现难以理解的 v-if 和 v-for "vue/no-confusing-v-for-v-if": "error", // 禁止出现重复的属性 "vue/no-duplicate-attributes": "error", // 禁止在计算属性中对属性修改 "vue/no-side-effects-in-computed-properties": "off", // 禁止在
/** **react规则 **/ "react/boolean-prop-naming": ["error", { "rule": "^is[A-Z]([A-Za-z0-9]?)+" }],//bool类型的props强制固定命名 "react/button-has-type": ["error", {"reset": false}],//强制按钮的type属性必须是"button","submit","reset"三者之一 "react/default-props-match-prop-types": [2, { "allowRequiredDefaults": false }],//强制所有defaultProps有对应的non-required PropType "react/destructuring-assignment": [1, "always"],//强制将props,state,context解构赋值 "react/display-name": [1, { "ignoreTranspilerName": false }],//react组件中强制定义displayName "react/forbid-component-props": [1],//禁止在自定义组件中使用(className, style)属性 "react/forbid-dom-props": [1, { "forbid": ["style"] }],//禁止在dom元素上使用禁止的属性 "react/forbid-elements": [1, { "forbid": ["button"] }],//禁止某些元素用于其他元素 "react/forbid-prop-types": [1],//禁止某些propTypes属性类型 "react/no-access-state-in-setstate":"error",//禁止在setState中使用this.state "react/no-children-prop":[1],//不要把Children当做属性 "react/no-string-refs":[1],//不要使用string类型的ref "react/no-unused-state":[1],//不要在state中定义未使用的变量 //..... "react/jsx-no-undef": [1, { "allowGlobals": false }],//不允许使用未声明的变量 "react/jsx-key":[1]//遍历使用key
文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。
转载请注明本文地址:https://www.ucloud.cn/yun/97529.html
摘要:前端构建之之前写了一个前端构建之,同样的目的写一个,内容基本上和一样,主要用来自己学习记录。合并很方便的实现合并最后附上完整的源代码。 前端构建之webpack 之前写了一个前端构建之gulp,同样的目的写一个webpack, 内容基本上和gulp一样,主要用来自己学习记录。 为什么需要前端构建 不解释 本文大致分为以下几个内容: 规范校验js代码(jslint) js解释器(b...
摘要:编码规范是独角兽公司内部的编码规范,该项目是上很受欢迎的一个开源项目,在前端开发中使用广泛,本文的配置规则就是以编码规范和编码规范作为基础的。 更新时间:2019-01-22React.js create-react-app 项目 + VSCode 编辑器 + ESLint 代码检查工具 + Airbnb 编码规范 前言 为什么要使用 ESLint 在项目开发过程中,编写符合团队编码规...
摘要:整个代码检查和格式化流程应该规范为如下步骤使用并且尝试自动修复所有问题有提示,可以进行修复,按照配置文件来进行修复。参考文档如何花分钟解决产生的各种错误的记忆现场本文转载自我的更新版梳理前端开发使用和来检查和格式化代码问题 更新版,之前的版本可以看这里:梳理前端开发使用eslint和prettier来检查和格式化代码问题 一、问题痛点 在团队的项目开发过程中,代码维护所占的时间比重...
摘要:它的目标是提供一个插件化的代码检测工具。,有了全局的和当前项目根目录下的规则配置文件,我们开始装插件并测试功能吧代码检查这个功能需要的插件为和。但是它本身并没有代码检查的功能,需要借助这样的特定语言检查支持。 前言 第一次运行 Vue 项目时被浏览器中满屏的 ESLint 报错给吓到了,果断禁用了该功能! 再之后找了个时间认真的了解了一下 ESLint,终于有了一些概念。简单来说,ES...
摘要:否则可能会导致全局安装的版本与项目中的配置文件可能存在不匹配。是一个流行的插件,其作用是为中的属性添加浏览器特定的前缀。插件允许开发人员在当前的项目中使用将来版本中可能会加入的新特性。 本文webpack是在Mac平台下基于官方最新版本v3.10,对于webpack@v2会有小的差异,待全文完成后会补充webpack@v2与v3版本之间的差异 使用webpack前的准备 1、初始化一个...
阅读 3312·2021-11-22 14:44
阅读 2522·2019-08-30 14:10
阅读 2563·2019-08-30 13:12
阅读 1188·2019-08-29 18:36
阅读 1324·2019-08-29 16:16
阅读 3293·2019-08-26 10:33
阅读 1739·2019-08-23 18:16
阅读 360·2019-08-23 18:12