如何使用eslint和editorconfig規范代碼

這篇文章主要為大家展示了“如何使用eslint和editorconfig規范代碼”，內容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領大家一起研究并學習一下“如何使用eslint和editorconfig規范代碼”這篇文章吧。

使用eslint和editorconfig規范代碼

為什么要用這些：

1. 代碼規范有利于團隊協作

2. 純手工規范耗時耗力而且不能保證準確性

3. 能配合編輯器自動提醒錯誤，提高開發效率

eslint

隨著ECMAScript版本一直更新的Js lint工具，插件豐富，并且能夠套用規范，規則非常豐富，能夠滿足大部分團隊的需求。

eslint 配合 git

為了最大程度控制每個人的規范，我們可以在git commit代碼的時候，使用git hook調用eslint進行代碼規范驗證，不規范的代碼無法提交到倉庫。

editorconfig

不同編輯器對文本的格式會有一定的區別，如果不統一一些規范，可能你和別人合作的時候每次更新下來別人的代碼就會出一大堆錯誤-webstorm自動支持editorconfig配置文件。

首先安裝eslintnpm i eslint 因為create-react-app默認已經安裝了

  "babel-eslint": "7.2.3",
  "eslint": "4.10.0",
  "eslint-config-react-app": "^2.1.0",
  "eslint-loader": "1.9.0",
  "eslint-plugin-flowtype": "2.39.1",
  "eslint-plugin-import": "2.8.0",
  "eslint-plugin-jsx-a11y": "5.1.1",
  "eslint-plugin-react": "7.4.0",

我們針對我們想要的自定義配置，我們再安裝如下

npm i babel-eslint \
\ eslint-config-airbnb eslint-config-standard \
\ eslint-loader \
\ eslint-plugin-import \
\ eslint-plugin-jsx-a11y \
\ eslint-plugin-node \
\ eslint-plugin-promise \
\ eslint-plugin-react \
\ eslint-plugin-standard -D

我們在根目錄下新建 .eslintrc 文件針對整個項目做一個標準的規范

{
 "extends": "standard"
}

主要項目是前端工程，所以我們在前端文件夾下新建 .eslintrc 文件，在這里去規范客戶端代碼，客戶端代碼使用 jsx，很多規則和 nodejs 是不同的，在這里使用更加嚴格的規范來要求客戶端代碼。

配置的value對應的值： 0 : off 1 : warning 2 : error

{
 "parser": "babel-eslint",
 "env": {
  "browser": true,
  "es6": true,
  "node": true
 },
 "parserOptions": {
  "ecmaVersion": 6,
  "sourceType": "module"
 },
 "extends": "airbnb",
 "rules": {
  "semi": [0],
  "react/jsx-filename-extension": [0],
  "jsx-a11y/anchor-is-valid": [0]
 }
}

使用 babel-eslint 去解析代碼，定義環境是瀏覽器和es6，會包含公共變量，webpack所以需要node一些環境變量，parserOptions定義版本，jsmodule模式方法書寫。

因為需要在每次編譯之前都要去檢查一下代碼，所以還需要配置 webpack,這是create-react-app默認的

   {
    test: /\.(js|jsx|mjs)$/,
    enforce: 'pre',
    use: [
     {
      options: {
       formatter: eslintFormatter,
       eslintPath: require.resolve('eslint'),
       
      },
      loader: require.resolve('eslint-loader'),
     },
    ],
    include: paths.appSrc,
   },

我們希望屏蔽掉 node_modules 文件夾下的代碼

exclude:[path.resolve(__dirname, '../node_modules')]

在項目根目錄下新建文件 .editorconfig webstom默認就有配置

1. root = true 項目根目錄

2. [*] 所有文件都應用這個規則

3. charset = utf-8 編碼模式

4. indent_style = space 使用 tab 的樣式制表符和 space

5. indent_size = 2

6. end_of_line = lf 行尾結尾方式

7. insert_final_newline = true 自動保存行尾最后一行是空行

8. trim_trailing_whitespace = true 一行結束后面的空格自動去掉

eslint 不檢測這行代碼 // eslint-disable-line

eslint 不檢測這個文件，在開頭 /* eslint-disable */在文件結尾/* eslint-enable */

安裝 npm i husky -D

然后在 package.json scripts中增加git 鉤子,會在執行git commit之前會調用這個命令

"lint": "eslint --ext .js --ext .jsx src/",
"precommit": "npm run lint"

git commit 強制執行 eslint 通過的代碼

以上是“如何使用eslint和editorconfig規范代碼”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！