前端系列——React開發必不可少的eslint配置

二月發表於2018-01-31

專案需要安裝的外掛

"babel-eslint": "^8.0.3",
"eslint": "^4.13.1",
"eslint-plugin-react": "^7.5.1",

配置詳情

下面的配置涵蓋了開發者所需要的絕大部分資訊,rules中的值0、1、2分別表示不開啟檢查、警告、錯誤。你可以看到下面有些是0,如果有需要開啟檢查,可以自己修改為1或者2。

module.exports = {
    "env": {
        "browser": true,
        "commonjs": true,
        "es6": true
    },
    "extends": "eslint:recommended",
    "globals": {
        "$": true,
        "process": true,
        "__dirname": true
    },
    "parser": "babel-eslint",
    "parserOptions": {
        "ecmaFeatures": {
            "experimentalObjectRestSpread": true,
            "jsx": true
        },
        "sourceType": "module",
        "ecmaVersion": 7
    },
    "plugins": [
        "react"
    ],
    "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 //=>的前/後括號
    },
    "settings": {
        "import/ignore": [
            "node_modules"
        ]
    }
};

哦,老天,你還希望看到更多的react檢查器,那就去 eslint-plugin-react 的github文件去慢慢翻譯吧。

某些檔案關閉eslint檢查

你不總是希望所有的檔案都開啟eslint檢查,那麼,給單獨的js檔案關閉eslint的方式,只需要在該檔案的最頂部加上一段註釋。

/*eslint-disable*/
function test() {
    return true
}

給某一行js程式碼關閉eslint檢查

關閉整個js檔案的行為有點暴力,別擔心,你還可以只給其中某段程式碼關閉eslint。

// eslint-disable-next-line
alert(`foo`)

eslint配置檔案型別

eslint配置檔案型別不只有js和json,其實包括下面這些:

  • .eslintrc.js
  • .eslintrc.yaml
  • .eslintrc.yml
  • .eslintrc.json
  • .eslintrc
  • package.json

相關文章