react-native系列(4)入门篇:在VSCode中配置ESLint(代码检测工具)

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/zeping891103/article/details/85923084

ESLint是一套javascript代码检测工具。要记住,代码也是写给人看的,所以一定要注意代码的编写规范。ESLint可以根据自己设置的规则实现对代码的检测,从而规范了代码的风格。本篇内容主要介绍如何在VSCode中使用ESLint。

ESLint的官网地址是:https://eslint.org/

全局初始化:

$ npm install eslint -g

在VSCode中安装ESLint插件:

输入命令行创建ESLint配置文件,配置信息根据项目自行设置:

$ eslint --init

我配置信息如下:

根据以上配置会生成一个.eslintrc.js文件,文件内容是:

module.exports = {
    "env": {
        "browser": true,
        "commonjs": true,
        "es6": true
    },
    "extends": "eslint:recommended",
    "parserOptions": {
        "ecmaFeatures": {
            "jsx": true
        },
        "ecmaVersion": 2018,
        "sourceType": "module"
    },
    "plugins": [
        "react"
    ],
    "rules": {
        "indent": [
            "error",
            "tab"
        ],
        "linebreak-style": [
            "error",
            "windows"
        ],
        "quotes": [
            "error",
            "single"
        ],
        "semi": [
            "error",
            "always"
        ]
    }
};

此时打开App.js文件,会发现很多报错,表示ESLint已经生效

这些报错是因为不符合.eslintrc.js文件里的规则配置而报出来的,比如例子中的缩进报错,是因为VSCode的缩进与ESLint上的缩进规则不一致。导入React报错是因为在.eslintrc.js文件里没有加入React插件支持。显然,这个.eslintrc.js里的配置并不是我们想要的,我把该配置文件修改一下:

module.exports = {
    // 环境里定义了一组预定义的全局变量
    "env": {
        "browser": true,
        "commonjs": true,
        "es6": true
    },
    // extends属性表示启用一系列核心规则,若有plugins属性表示同时启用插件的核心规则
    "extends": [
        "eslint:recommended",
        'plugin:react/recommended'
    ],
    // 设置解析器
    "parser": "babel-eslint",
    // 解析器选项
    "parserOptions": {
        // 表示一些附加特性的对象, 支持JSX
        "ecmaFeatures": {
            "jsx": true
        },
        // ECMAScript的版本
        "ecmaVersion": 2018,
        "sourceType": "module"
    },
    // 支持使用的第三方插件,在使用插件之前,你必须使用 npm 安装它。
    "plugins": [
        "react"
    ],
    // 规则配置
    "rules": {
        "indent": [
            "off",
            "tab"
        ],
        "linebreak-style": [
            "off",
            "windows"
        ],
        "quotes": [
            "error",
            "single"
        ],
        "semi": [
            "error",
            "always"
        ],
        "react/jsx-indent-props": [
            "error", 
            4
        ],
        "react/no-direct-mutation-state": 
            2
        ,
        "no-console": 
            0
        ,
        "no-debugger": 
            2
    }
};

这样App.js就不会报错了,以后所有的代码就可以按照这套规范统一编写,实现代码风格的一致性。同样,每个企业对自己的代码规范高低程度不同,可以根据自己的需求制定代码规范检测条件。关于这些配置检测条件,可以查看ESLint文档:https://cn.eslint.org/docs/user-guide/configuring

其中配置项rules,rules中的值0、1、2分别表示不开启检查、警告、错误。配置参考:

"rules": {
    "quotes": [2, "single"], //单引号
    "no-console": 0, //不禁用console
    "no-debugger": 2, //禁用debugger
    "no-var": 0, //对var警告
    "semi": 0, //不强制使用分号
    "no-irregular-whitespace": 0, //不规则的空白不允许
    "no-trailing-spaces": 1, //一行结束后面有空格就发出警告
    "eol-last": 0, //文件以单一的换行符结束
    "no-unused-vars": [2, {"vars": "all", "args": "after-used"}], //不能有声明后未被使用的变量或参数
    "no-underscore-dangle": 0, //标识符不能以_开头或结尾
    "no-alert": 2, //禁止使用alert confirm prompt
    "no-lone-blocks": 0, //禁止不必要的嵌套块
    "no-class-assign": 2, //禁止给类赋值
    "no-cond-assign": 2, //禁止在条件表达式中使用赋值语句
    "no-const-assign": 2, //禁止修改const声明的变量
    "no-delete-var": 2, //不能对var声明的变量使用delete操作符
    "no-dupe-keys": 2, //在创建对象字面量时不允许键重复
    "no-duplicate-case": 2, //switch中的case标签不能重复
    "no-dupe-args": 2, //函数参数不能重复
    "no-empty": 2, //块语句中的内容不能为空
    "no-func-assign": 2, //禁止重复的函数声明
    "no-invalid-this": 0, //禁止无效的this,只能用在构造器,类,对象字面量
    "no-redeclare": 2, //禁止重复声明变量
    "no-spaced-func": 2, //函数调用时 函数名与()之间不能有空格
    "no-this-before-super": 0, //在调用super()之前不能使用this或super
    "no-undef": 2, //不能有未定义的变量
    "no-use-before-define": 2, //未定义前不能使用
    "camelcase": 0, //强制驼峰法命名
    "jsx-quotes": [2, "prefer-double"], //强制在JSX属性(jsx-quotes)中一致使用双引号
    "react/display-name": 0, //防止在React组件定义中丢失displayName
    "react/forbid-prop-types": [2, {"forbid": ["any"]}], //禁止某些propTypes
    "react/jsx-boolean-value": 2, //在JSX中强制布尔属性符号
    "react/jsx-closing-bracket-location": 1, //在JSX中验证右括号位置
    "react/jsx-curly-spacing": [2, {"when": "never", "children": true}], //在JSX属性和表达式中加强或禁止大括号内的空格。
    "react/jsx-indent-props": [2, 4], //验证JSX中的props缩进
    "react/jsx-key": 2, //在数组或迭代器中验证JSX具有key属性
    "react/jsx-max-props-per-line": [1, {"maximum": 1}], // 限制JSX中单行上的props的最大数量
    "react/jsx-no-bind": 0, //JSX中不允许使用箭头函数和bind
    "react/jsx-no-duplicate-props": 2, //防止在JSX中重复的props
    "react/jsx-no-literals": 0, //防止使用未包装的JSX字符串
    "react/jsx-no-undef": 1, //在JSX中禁止未声明的变量
    "react/jsx-pascal-case": 0, //为用户定义的JSX组件强制使用PascalCase
    "react/jsx-sort-props": 2, //强化props按字母排序
    "react/jsx-uses-react": 1, //防止反应被错误地标记为未使用
    "react/jsx-uses-vars": 2, //防止在JSX中使用的变量被错误地标记为未使用
    "react/no-danger": 0, //防止使用危险的JSX属性
    "react/no-did-mount-set-state": 0, //防止在componentDidMount中使用setState
    "react/no-did-update-set-state": 1, //防止在componentDidUpdate中使用setState
    "react/no-direct-mutation-state": 2, //防止this.state的直接变异
    "react/no-multi-comp": 2, //防止每个文件有多个组件定义
    "react/no-set-state": 0, //防止使用setState
    "react/no-unknown-property": 2, //防止使用未知的DOM属性
    "react/prefer-es6-class": 2, //为React组件强制执行ES5或ES6类
    "react/prop-types": 0, //防止在React组件定义中丢失props验证
    "react/react-in-jsx-scope": 2, //使用JSX时防止丢失React
    "react/self-closing-comp": 0, //防止没有children的组件的额外结束标签
    "react/sort-comp": 2, //强制组件方法顺序
    "no-extra-boolean-cast": 0, //禁止不必要的bool转换
    "react/no-array-index-key": 0, //防止在数组中遍历中使用数组key做索引
    "react/no-deprecated": 1, //不使用弃用的方法
    "react/jsx-equals-spacing": 2, //在JSX属性中强制或禁止等号周围的空格
    "no-unreachable": 1, //不能有无法执行的代码
    "comma-dangle": 2, //对象字面量项尾不能有逗号
    "no-mixed-spaces-and-tabs": 0, //禁止混用tab和空格
    "prefer-arrow-callback": 0, //比较喜欢箭头回调
    "arrow-parens": 0, //箭头函数用小括号括起来
    "arrow-spacing": 0 //=>的前/后括号
  }

 

没有更多推荐了,返回首页