1. 程式人生 > >react-native系列(4)入門篇:在VSCode中配置ESLint(程式碼檢測工具)

react-native系列(4)入門篇:在VSCode中配置ESLint(程式碼檢測工具)

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 //=>的前/後括號
  }