從零搭建webpack4+react+typescript+eslint腳手架(五)

這一篇主要介紹代碼規範相關的內容。

eslint

咱們一般使用lint工具來檢查代碼不規範的地方，如下是將 eslint、typescript 和 webpack 結合使用的例子。

首先安裝依賴：

$ npm i -D eslint babel-eslint eslint-loader eslint-plugin-jsx-control-statements
$ npm i -D eslint-plugin-react @typescript-eslint/parser @typescript-eslint/eslint-plugin

而後在根目錄新建eslint配置文件.eslintrc.js：

module.exports = {
  "root": true,
  "env": {
    "browser": true,
    "node": true,
    "es6": true,
    // "jquery": true
    "jest": true,
    "jsx-control-statements/jsx-control-statements": true // 可以在jsx中使用if，須要配合另外的babel插件使用
  },
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "sourceType": 'module',
    "ecmaFeatures": {
      "jsx": true,
      "experimentalObjectRestSpread": true
    }
  },
  "globals": {
    // "wx": "readonly",
  },
  "extends": [
    "eslint:recommended",
    "plugin:react/recommended",
    "plugin:jsx-control-statements/recommended", // 須要另外配合babel插件使用
  ],
  "settings": {
    "react": {
      "version": "detect" // 自動讀取已安裝的react版本
    }
  },
  "plugins": ["@typescript-eslint", "react", "jsx-control-statements"],
  "rules": {
    "no-extra-semi": 0, // 禁止沒必要要的分號
    "quotes": ['error', 'single'], // 強制使用單引號
    "no-unused-vars": 0 // 不容許未定義的變量
    // ...你本身的配置
  }
};

咱們可能但願檢查或不檢查某些特定的文件，能夠在根目錄新建.eslintignore，如下配置不檢查src目錄之外的js文件：

**/*.js
!src/**/*.js

還須要配置webpack，才能在開發時啓用eslint：

// webpack.base.js
module: {
  rules: [
    // 把這個配置放在全部loader以前
    {
      enforce: 'pre',
      test: /\.tsx?$/,
      exclude: /node_modules/,
      include: [APP_PATH],
      loader: 'eslint-loader',
      options: {
        emitWarning: true, // 這個配置須要打開，才能在控制檯輸出warning信息
        emitError: true, // 這個配置須要打開，才能在控制檯輸出error信息
        fix: true // 是否自動修復，若是是，每次保存時會自動修復能夠修復的部分
      }
    }
  ]
}

prettier

除了約束開發時的編碼規範外，咱們通常還但願在提交代碼時自動格式化代碼，但咱們只但願處理當前提交的代碼，而不是整個代碼庫，不然會把提交記錄搞得亂七八糟，prettier和lint-staged能夠完成這項任務。

先安裝工具：

$ npm i -D prettier eslint-plugin-prettier eslint-config-prettier
$ npm i -D lint-staged

在根目錄增長prettier配置.prettierrc.js，一樣的也能夠增長忽略配置.prettierignore（建議配置爲與lint忽略規則一致）：

// 這個配置須要與eslint一致，不然在啓用 eslint auto fix 的狀況下會形成衝突
module.exports = {
  "printWidth": 120, //一行的字符數，若是超過會進行換行，默認爲80
  "tabWidth": 2,
  "useTabs": false, // 注意：makefile文件必須使用tab，視具體狀況忽略
  "singleQuote": true,
  "semi": true,
  "trailingComma": "none", //是否使用尾逗號，有三個可選值"<none|es5|all>"
  "bracketSpacing": true, //對象大括號直接是否有空格，默認爲true，效果：{ foo: bar }
};

修改eslint配置.eslintrc.js：

module.exports = {
  "extends": [
    "eslint:recommended",
    "plugin:react/recommended",
    "plugin:jsx-control-statements/recommended", // 須要另外配合babel插件使用
    "prettier" // 注意順序
  ],
  "plugins": ["@typescript-eslint", "react", "jsx-control-statements", "prettier"], // 注意順序
  "rules": {
    "prettier/prettier": 2, // 這樣prettier的提示可以以錯誤的形式在控制檯輸出
  }
};

而後咱們要配置lint-staged，在提交代碼時自動格式化代碼。

修改package.json：

"husky": {
  "hooks": {
    "pre-commit": "lint-staged"
  }
},
"lint-staged": {
  "src/**/*.{jsx,js,tsx,ts}": [
    "prettier --write",
    "eslint --fix",
    "git add"
  ]
}

用editorconfig統一編輯器規範

有些編輯器可以根據配置提示會自動格式化代碼，咱們能夠爲各類編輯器提供一個統一的配置。

在根目錄新建.editorconfig便可，注意不要與已有的lint規則衝突：

root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

使用jest

使用jest能夠幫助咱們測試代碼，在項目中使用jest的實現方式有不少種，文本不具體展開討論，只提供一些必備的工具和配置。

必備工具：

$ npm i -D jest babel-jest ts-jest @types/jest

參考配置jest.config.js，測試文件均放在__test__目錄中：

module.exports = {
  transform: {
    '^.+\\.tsx?$': 'ts-jest',
  },
  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$',
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
};

---

• 從零搭建webpack4+react+typescript+eslint腳手架(一)
• 從零搭建webpack4+react+typescript+eslint腳手架(二)
• 從零搭建webpack4+react+typescript+eslint腳手架(三)
• 從零搭建webpack4+react+typescript+eslint腳手架(四)
• 從零搭建webpack4+react+typescript+eslint腳手架(五)
• 從零搭建webpack4+react+typescript+eslint腳手架(六)