ESlint規(guī)則的簡(jiǎn)要介紹及初步配置

1.什么是ESlint?

ESLint是一個(gè)語(yǔ)法規(guī)則和代碼風(fēng)格的檢查工具,用于尋找有問(wèn)題的模式或者代碼,并且不依賴于具體的編碼風(fēng)格。

簡(jiǎn)單來(lái)說(shuō),ESLint是一個(gè)工具,致力于保證代碼的一致性,并且?guī)椭_(kāi)發(fā)人員避免錯(cuò)誤。


2.為什么要使用ESlint?

首先,ESLint的自定義規(guī)則可以幫助開(kāi)發(fā)者避免一些非常低級(jí)的錯(cuò)誤,其次,ESLint 的所有規(guī)則都被設(shè)計(jì)成可插入的,開(kāi)發(fā)者可以創(chuàng)建自己的檢測(cè)規(guī)則,避免一些高發(fā)的錯(cuò)誤操作,極大的提高工作效率。

最后,在大型的項(xiàng)目開(kāi)發(fā)中,模塊式的開(kāi)發(fā)必不可少,團(tuán)隊(duì)的合作至關(guān)重要。ESLint保證了團(tuán)隊(duì)開(kāi)發(fā)代碼的風(fēng)格一致性,使得內(nèi)部交接過(guò)程更高效、更便捷。


3.ESlint的主要特點(diǎn)

  • 內(nèi)置規(guī)則和自定義規(guī)則共用一套規(guī)則 API

  • 內(nèi)置的格式化方法和自定義的格式化方法共用一套格式化 API

  • 額外的規(guī)則和格式化方法能夠在運(yùn)行時(shí)指定

  • 規(guī)則和對(duì)應(yīng)的格式化方法并不強(qiáng)制捆綁使用

  • 每條規(guī)則都是各自獨(dú)立的,可以根據(jù)項(xiàng)目情況選擇開(kāi)啟或關(guān)閉

  • 用戶可以將結(jié)果設(shè)置成警告或者錯(cuò)誤

  • ESLint 并不推薦任何編碼風(fēng)格,規(guī)則是自由的

  • 所有內(nèi)置規(guī)則都是泛化的


4.ESlint的基本規(guī)范

ESLint附帶了一些默認(rèn)規(guī)則,完整列表如下:

ESLint默認(rèn)規(guī)則

示例:


"no-console":2,//禁止使用console

"no-const-assign":2,//禁止修改const聲明的變量

"no-constant-condition":2,//禁止在條件中使用常量表達(dá)式if(true)if(1)

"no-continue":0,//禁止使用continue

"no-control-regex":2,//禁止在正則表達(dá)式中使用控制字符

"no-debugger":2,//禁止使用debugger

"no-delete-var":2,//不能對(duì)var聲明的變量使用delete操作符

"no-div-regex":1,//不能使用看起來(lái)像除法的正則表達(dá)式/=foo/

"no-dupe-keys":2,//在創(chuàng)建對(duì)象字面量時(shí)不允許鍵重復(fù) {a:1,a:1}

"no-dupe-args":2,//函數(shù)參數(shù)不能重復(fù)

"no-duplicate-case":2,//switch中的case標(biāo)簽不能重復(fù)

"no-else-return":2,//如果if語(yǔ)句里面有return,后面不能跟else語(yǔ)句



5.ESlint的安裝及配置

  • 首先,使用以下代碼確保電腦的node 和 npm 環(huán)境已安裝配置完成:

node -v

npm -v

出現(xiàn)版本號(hào)即可。

  • 接著全局安裝eslint:

npm install -g eslint

具體安裝方式取決于項(xiàng)目,開(kāi)發(fā)人員可根據(jù)實(shí)際情況選擇本地安裝還是全局安裝。

本地安裝:

npm install eslint

  • 安裝使用eslint所需的包:

npm install --save-dev babel-eslint eslint eslint-plugin-react

  • 在項(xiàng)目的根目錄里面手動(dòng)創(chuàng)建.eslintrc.js 文件

該文件為規(guī)則的配置文件,是否需要某個(gè)規(guī)則,或者修改規(guī)則的報(bào)警級(jí)別,都可以在這里進(jìn)行修改。

  • 0:忽略問(wèn)題,即發(fā)出"off"警告;

  • 1:給出警告,即發(fā)出"warn"警告;

  • 2:直接報(bào)錯(cuò),即發(fā)出"error"警告;


  "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"], //單引號(hào)

    "no-console": 0, //不禁用console

    "no-debugger": 2, //禁用debugger

    "no-var": 0, //對(duì)var警告

    "semi": 0, //不強(qiáng)制使用分號(hào)

    "no-irregular-whitespace": 0, //不規(guī)則的空白不允許

    "no-trailing-spaces": 1, //一行結(jié)束后面有空格就發(fā)出警告

    "eol-last": 0, //文件以單一的換行符結(jié)束

    "no-unused-vars": [2, {"vars": "all", "args": "after-used"}], //不能有聲明后未被使用的變量或參數(shù)

    "no-underscore-dangle": 0, //標(biāo)識(shí)符不能以_開(kāi)頭或結(jié)尾

    "no-alert": 2, //禁止使用alert confirm prompt

    "no-lone-blocks": 0, //禁止不必要的嵌套塊

    "no-class-assign": 2, //禁止給類賦值

    "no-cond-assign": 2, //禁止在條件表達(dá)式中使用賦值語(yǔ)句

    "no-const-assign": 2, //禁止修改const聲明的變量

    "no-delete-var": 2, //不能對(duì)var聲明的變量使用delete操作符

    "no-dupe-keys": 2, //在創(chuàng)建對(duì)象字面量時(shí)不允許鍵重復(fù)

    "no-duplicate-case": 2, //switch中的case標(biāo)簽不能重復(fù)

    "no-dupe-args": 2, //函數(shù)參數(shù)不能重復(fù)

    "no-empty": 2, //塊語(yǔ)句中的內(nèi)容不能為空

    "no-func-assign": 2, //禁止重復(fù)的函數(shù)聲明

    "no-invalid-this": 0, //禁止無(wú)效的this,只能用在構(gòu)造器,類,對(duì)象字面量

    "no-redeclare": 2, //禁止重復(fù)聲明變量

    "no-spaced-func": 2, //函數(shù)調(diào)用時(shí) 函數(shù)名與()之間不能有空格

    "no-this-before-super": 0, //在調(diào)用super()之前不能使用this或super

    "no-undef": 2, //不能有未定義的變量

    "no-use-before-define": 2, //未定義前不能使用

    "camelcase": 0, //強(qiáng)制駝峰法命名

    "jsx-quotes": [2, "prefer-double"], //強(qiáng)制在JSX屬性(jsx-quotes)中一致使用雙引號(hào)

    "react/display-name": 0, //防止在React組件定義中丟失displayName

    "react/forbid-prop-types": [2, {"forbid": ["any"]}], //禁止某些propTypes

    "react/jsx-boolean-value": 2, //在JSX中強(qiáng)制布爾屬性符號(hào)

    "react/jsx-closing-bracket-location": 1, //在JSX中驗(yàn)證右括號(hào)位置

    "react/jsx-curly-spacing": [2, {"when": "never", "children": true}], //在JSX屬性和表達(dá)式中加強(qiáng)或禁止大括號(hào)內(nèi)的空格。

    "react/jsx-indent-props": [2, 4], //驗(yàn)證JSX中的props縮進(jìn)

    "react/jsx-key": 2, //在數(shù)組或迭代器中驗(yàn)證JSX具有key屬性

    "react/jsx-max-props-per-line": [1, {"maximum": 1}], // 限制JSX中單行上的props的最大數(shù)量

    "react/jsx-no-bind": 0, //JSX中不允許使用箭頭函數(shù)和bind

    "react/jsx-no-duplicate-props": 2, //防止在JSX中重復(fù)的props

    "react/jsx-no-literals": 0, //防止使用未包裝的JSX字符串

    "react/jsx-no-undef": 1, //在JSX中禁止未聲明的變量

    "react/jsx-pascal-case": 0, //為用戶定義的JSX組件強(qiáng)制使用PascalCase

    "react/jsx-sort-props": 2, //強(qiáng)化props按字母排序

    "react/jsx-uses-react": 1, //防止反應(yīng)被錯(cuò)誤地標(biāo)記為未使用

    "react/jsx-uses-vars": 2, //防止在JSX中使用的變量被錯(cuò)誤地標(biāo)記為未使用

    "react/no-danger": 0, //防止使用危險(xiǎn)的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, //防止每個(gè)文件有多個(gè)組件定義

    "react/no-set-state": 0, //防止使用setState

    "react/no-unknown-property": 2, //防止使用未知的DOM屬性

    "react/prefer-es6-class": 2, //為React組件強(qiáng)制執(zhí)行ES5或ES6類

    "react/prop-types": 0, //防止在React組件定義中丟失props驗(yàn)證

    "react/react-in-jsx-scope": 2, //使用JSX時(shí)防止丟失React

    "react/self-closing-comp": 0, //防止沒(méi)有children的組件的額外結(jié)束標(biāo)簽

    "react/sort-comp": 2, //強(qiáng)制組件方法順序

    "no-extra-boolean-cast": 0, //禁止不必要的bool轉(zhuǎn)換

    "react/no-array-index-key": 0, //防止在數(shù)組中遍歷中使用數(shù)組key做索引

    "react/no-deprecated": 1, //不使用棄用的方法

    "react/jsx-equals-spacing": 2, //在JSX屬性中強(qiáng)制或禁止等號(hào)周圍的空格

    "no-unreachable": 1, //不能有無(wú)法執(zhí)行的代碼

    "comma-dangle": 2, //對(duì)象字面量項(xiàng)尾不能有逗號(hào)

    "no-mixed-spaces-and-tabs": 0, //禁止混用tab和空格

    "prefer-arrow-callback": 0, //比較喜歡箭頭回調(diào)

    "arrow-parens": 0, //箭頭函數(shù)用小括號(hào)括起來(lái)

    "arrow-spacing": 0 //=>的前/后括號(hào)

  },

  "settings": {

    "import/ignore": [

      "node_modules"

    ]

  }

};

進(jìn)行到這一步,便可以進(jìn)行代碼的校驗(yàn)檢測(cè)啦!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容