讓 Code review 再也不會出現 Coding Style 的問題

  1. 讓 Code review 再也不會出現 Coding Style 的問題
    1. 原生 JS
      1. 安裝
      2. 設定
      3. 執行
    2. 和 webpack 一起用 prettier
      1. 安裝
      2. webpack 設定

讓 Code review 再也不會出現 Coding Style 的問題

用 prettier 當作整理程式碼的工具,希望可以在每一次操作 git commit 之前,一定可以跑過一次。
用 husky 可以 package.json 加上 git hook 。

原生 JS

安裝

prettier[1]

$ npm install --save-dev --save-exact prettier

husky[2]

$ npm install husky@next --save-dev

設定

package.json
加上 prettier 的指令
加上 husky 的設定

{
  //..."",
  "scripts": {
    //...
    "prettier": "prettier --write *.js && git add -u"
  },
  "husky": {
    "hooks": {
      "pre-commit": "npm run prettier"
    }
  }
  //...
}

其中 prettier --write *.js && git add -u 指令,是本文的重點呀!
prettier --write *.js 主要是提供 prettier 一個放置 .js 檔的路徑

執行

$ git commit -m "some message"

就會執行 prettier 並且覆寫回原本的檔案。
讓你的 Coding style 保持一致!!

和 webpack 一起用 prettier

使用 prettier-loader[3]

不要使用下列這些舊選擇

安裝

npm install prettier-loader --save-dev

webpack 設定

webpack.config.js

module.exports = {
  // ...
  module: {
    rules: [{
    test: /\.js$/,
    exclude : /(node_modules)/,
    include: [resolve('src')],
    enforce: "pre",
    use: [
      loader: "prettier-loader"
    }]
  }]
};

.prettierrc

{
  tabWidth: 4,
  trailingComma: 'all'
}

  1. prettier ↩︎

  2. husky ↩︎

  3. prettier-loader ↩︎