從0到1使用VUE-CLI3開發實戰(六)：這是一個有程式碼潔癖的專案

周小肆發表於2019-01-26

一個小故事

一天我路過一座橋，碰巧看見一個人想跳河自殺。我跑過去對他大喊道：“別跳，別死啊。” “為什麼不讓我跳？”他說。 “因為還有很多東西值得我們活下去啊。” “有嗎？比如說？” “呃……你做什麼工作？” “前端工程師。” 我說：“我也是！瞧，有共同點了吧。你是使用JavaScript還是TypeScript？” “JavaScript。” “我也是。字串用單引號也可以用雙引號？” “雙引號。” “去死吧！你這個異教徒人渣！”我一把將他推下橋去。

故事權且供大家一樂，實際開發過程中，關於程式碼風格，我們很難區分誰對誰錯，不同的人有不同偏好，唯有強制要求才能規避爭論。

新手程式設計師對自己沒有程式碼規範要求，就會出現同一個專案不同地方的程式碼風格都無法保持一致，時間久了回頭看自己程式碼都覺得慘不忍睹，所以程式設計師對哪怕自己不收拾打扮，對程式碼卻都有極高的審美要求。

在最開始我們用vue-cli來初始化專案的時候，已經給我們提供了程式碼檢查及格式化工具，今天我們就來看看如何配置Eslint+prettier。

Eslint+Prettier配置

什麼是ESlint？

ESLint 是一個開源的 JavaScript 程式碼檢查工具，由 Nicholas C. Zakas 於2013年6月建立。程式碼檢查是一種靜態的分析，常用於尋找有問題的模式或者程式碼，並且不依賴於具體的編碼風格。對大多數程式語言來說都會有程式碼檢查，一般來說編譯程式會內建檢查工具。

JavaScript 是一個動態的弱型別語言，在開發中比較容易出錯。因為沒有編譯程式，為了尋找 JavaScript 程式碼錯誤通常需要在執行過程中不斷除錯。像 ESLint 這樣的可以讓程式設計師在編碼的過程中發現問題而不是在執行的過程中。

ESLint 的初衷是為了讓程式設計師可以建立自己的檢測規則。ESLint 的所有規則都被設計成可插入的。ESLint 的預設規則與其他的外掛並沒有什麼區別，規則本身和測試可以依賴於同樣的模式。為了便於人們使用，ESLint 內建了一些規則，當然，你可以在使用過程中自定義規則。

ESLint 使用 Node.js 編寫，這樣既可以有一個快速的執行環境的同時也便於安裝。

什麼是Prettier?

Prettier的中文意思是“漂亮的、機靈的”，也是一個流行的程式碼格式化工具的名稱，它能夠解析程式碼，使用你自己設定的規則來重新列印出格式規範的程式碼。

Prettier具有以下幾個有優點：

可配置化
支援多種語言
整合多數的編輯器
簡潔的配置項

實戰配置

vue-cli3已經將大部分配置工作做好了，我們只需要在.eslintrc.js檔案中新增我們的規則即可，我把大部分規則及其含義都寫在了我的配置檔案中，大家可以直接看程式碼參考：

module.exports = {
  root: true,
  env: {
    node: true
  },
  extends: ["plugin:vue/essential", "@vue/prettier"],
  rules: {
    "no-console": process.env.NODE_ENV === "production" ? "error" : "off",
    "no-debugger": process.env.NODE_ENV === "production" ? "error" : "off",
    "prettier/prettier": [
      "error",
      {
        // tab縮排大小,預設為2
        "tabWidth": 2,
        // 使用tab縮排，預設false
        "useTabs": false,
        // 使用分號, 預設true
        "semi": false,
        // 使用單引號, 預設false(在jsx中配置無效, 預設都是雙引號)
        "singleQuote": true,
        // 行尾逗號,預設none,可選 none|es5|all
        // es5 包括es5中的陣列、物件
        // all 包括函式物件等所有可選
        "trailingComma": 'none',
        // 物件中的空格 預設true
        // true: { foo: bar }
        // false: {foo: bar}
        "bracketSpacing": true,
        // JSX標籤閉合位置 預設false
        // false: <div
        //          className=""
        //          style={{}}
        //       >
        // true: <div
        //          className=""
        //          style={{}} >
        "jsxBracketSameLine": false,
        // 箭頭函式引數括號 預設avoid 可選 avoid| always
        // avoid 能省略括號的時候就省略 例如x => x
        // always 總是有括號
        "arrowParens": 'always'
      }
    ],
    "no-alert": 0, //禁止使用alert confirm prompt
    "no-array-constructor": 2, //禁止使用陣列構造器
    "no-bitwise": 0, //禁止使用按位運算子
    "no-caller": 1, //禁止使用arguments.caller或arguments.callee
    "no-catch-shadow": 2, //禁止catch子句引數與外部作用域變數同名
    "no-class-assign": 2, //禁止給類賦值
    "no-cond-assign": 2, //禁止在條件表示式中使用賦值語句
    "no-console": 0, //禁止使用console
    "no-const-assign": 2, //禁止修改const宣告的變數
    "no-constant-condition": 2, //禁止在條件中使用常量表示式 if(true) if(1)
    "no-continue": 0, //禁止使用continue
    "no-control-regex": 2, //禁止在正規表示式中使用控制字元
    "no-debugger": 2, //禁止使用debugger
    "no-delete-var": 2, //不能對var宣告的變數使用delete操作符
    "no-div-regex": 1, //不能使用看起來像除法的正規表示式/=foo/
    "no-dupe-keys": 2, //在建立物件字面量時不允許鍵重複 {a:1,a:1}
    "no-dupe-args": 2, //函式引數不能重複
    "no-duplicate-case": 2, //switch中的case標籤不能重複
    "no-else-return": 2, //如果if語句裡面有return,後面不能跟else語句
    "no-empty": 2, //塊語句中的內容不能為空
    "no-empty-character-class": 2, //正規表示式中的[]內容不能為空
    "no-empty-label": 0, //禁止使用空label
    "no-eq-null": 2, //禁止對null使用==或!=運算子
    "no-eval": 1, //禁止使用eval
    "no-ex-assign": 2, //禁止給catch語句中的異常引數賦值
    "no-extend-native": 2, //禁止擴充套件native物件
    "no-extra-bind": 2, //禁止不必要的函式繫結
    "no-extra-boolean-cast": 2, //禁止不必要的bool轉換
    "no-extra-parens": 2, //禁止非必要的括號
    "no-extra-semi": 2, //禁止多餘的冒號
    "no-fallthrough": 1, //禁止switch穿透
    "no-floating-decimal": 2, //禁止省略浮點數中的0 .5 3.
    "no-func-assign": 2, //禁止重複的函式宣告
    "no-implicit-coercion": 1, //禁止隱式轉換
    "no-implied-eval": 2, //禁止使用隱式eval
    "no-inline-comments": 0, //禁止行內備註
    "no-inner-declarations": [2, "functions"], //禁止在塊語句中使用宣告（變數或函式）
    "no-invalid-regexp": 2, //禁止無效的正規表示式
    "no-invalid-this": 2, //禁止無效的this，只能用在構造器，類，物件字面量
    "no-irregular-whitespace": 2, //不能有不規則的空格
    "no-iterator": 2, //禁止使用__iterator__ 屬性
    "no-label-var": 2, //label名不能與var宣告的變數名相同
    "no-labels": 2, //禁止標籤宣告
    "no-lone-blocks": 2, //禁止不必要的巢狀塊
    "no-lonely-if": 2, //禁止else語句內只有if語句
    "no-loop-func": 1, //禁止在迴圈中使用函式（如果沒有引用外部變數不形成閉包就可以）
    "no-mixed-requires": [0, false], //宣告時不能混用宣告型別
    "no-mixed-spaces-and-tabs": [2, false], //禁止混用tab和空格
    "linebreak-style": [0, "windows"], //換行風格
    "no-multi-spaces": 1, //不能用多餘的空格
    "no-multi-str": 2, //字串不能用\換行
    "no-multiple-empty-lines": [1, {
      "max": 2
    }], //空行最多不能超過2行
    "no-native-reassign": 2, //不能重寫native物件
    "no-negated-in-lhs": 2, //in 操作符的左邊不能有!
    "no-nested-ternary": 0, //禁止使用巢狀的三目運算
    "no-new": 1, //禁止在使用new構造一個例項後不賦值
    "no-new-func": 1, //禁止使用new Function
    "no-new-object": 2, //禁止使用new Object()
    "no-new-require": 2, //禁止使用new require
    "no-new-wrappers": 2, //禁止使用new建立包裝例項，new String new Boolean new Number
    "no-obj-calls": 2, //不能呼叫內建的全域性物件，比如Math() JSON()
    "no-octal": 2, //禁止使用八進位制數字
    "no-octal-escape": 2, //禁止使用八進位制轉義序列
    "no-param-reassign": 2, //禁止給引數重新賦值
    "no-path-concat": 0, //node中不能使用__dirname或__filename做路徑拼接
    "no-plusplus": 0, //禁止使用++，--
    "no-process-env": 0, //禁止使用process.env
    "no-process-exit": 0, //禁止使用process.exit()
    "no-proto": 2, //禁止使用__proto__屬性
    "no-redeclare": 2, //禁止重複宣告變數
    "no-regex-spaces": 2, //禁止在正規表示式字面量中使用多個空格 /foo bar/
    "no-restricted-modules": 0, //如果禁用了指定模組，使用就會報錯
    "no-return-assign": 1, //return 語句中不能有賦值表示式
    "no-script-url": 0, //禁止使用javascript:void(0)
    "no-self-compare": 2, //不能比較自身
    "no-sequences": 0, //禁止使用逗號運算子
    "no-shadow": 2, //外部作用域中的變數不能與它所包含的作用域中的變數或引數同名
    "no-shadow-restricted-names": 2, //嚴格模式中規定的限制識別符號不能作為宣告時的變數名使用
    "no-spaced-func": 2, //函式呼叫時 函式名與()之間不能有空格
    "no-sparse-arrays": 2, //禁止稀疏陣列， [1,,2]
    "no-sync": 0, //nodejs 禁止同步方法
    "no-ternary": 0, //禁止使用三目運算子
    "no-trailing-spaces": 1, //一行結束後面不要有空格
    "no-this-before-super": 0, //在呼叫super()之前不能使用this或super
    "no-throw-literal": 2, //禁止丟擲字面量錯誤 throw "error";
    "no-undef": 1, //不能有未定義的變數
    "no-undef-init": 2, //變數初始化時不能直接給它賦值為undefined
    "no-undefined": 2, //不能使用undefined
    "no-unexpected-multiline": 2, //避免多行表示式
    "no-underscore-dangle": 1, //識別符號不能以_開頭或結尾
    "no-unneeded-ternary": 2, //禁止不必要的巢狀 var isYes = answer === 1 ? true : false;
    "no-unreachable": 2, //不能有無法執行的程式碼
    "no-unused-expressions": 2, //禁止無用的表示式
    "no-unused-vars": [2, {
      "vars": "all",
      "args": "after-used"
    }], //不能有宣告後未被使用的變數或引數
    "no-use-before-define": 2, //未定義前不能使用
    "no-useless-call": 2, //禁止不必要的call和apply
    "no-void": 2, //禁用void操作符
    "no-var": 0, //禁用var，用let和const代替
    "no-warning-comments": [1, {
      "terms": ["todo", "fixme", "xxx"],
      "location": "start"
    }], //不能有警告備註
    "no-with": 2, //禁用with

    "array-bracket-spacing": [2, "never"], //是否允許非空陣列裡面有多餘的空格
    "arrow-parens": 0, //箭頭函式用小括號括起來
    "arrow-spacing": 0, //=>的前/後括號
    "accessor-pairs": 0, //在物件中使用getter/setter
    "block-scoped-var": 0, //塊語句中使用var
    "brace-style": [1, "1tbs"], //大括號風格
    "callback-return": 1, //避免多次呼叫回撥什麼的
    "camelcase": 2, //強制駝峰法命名
    "comma-dangle": [2, "never"], //物件字面量項尾不能有逗號
    "comma-spacing": 0, //逗號前後的空格
    "comma-style": [2, "last"], //逗號風格，換行時在行首還是行尾
    "complexity": [0, 11], //迴圈複雜度
    "computed-property-spacing": [0, "never"], //是否允許計算後的鍵名什麼的
    "consistent-return": 0, //return 後面是否允許省略
    "consistent-this": [2, "that"], //this別名
    "constructor-super": 0, //非派生類不能呼叫super，派生類必須呼叫super
    "curly": [2, "all"], //必須使用 if(){} 中的{}
    "default-case": 0, //switch語句最後必須有default
    "dot-location": 0, //物件訪問符的位置，換行的時候在行首還是行尾
    "dot-notation": [0, {
      "allowKeywords": true
    }], //避免不必要的方括號
    "eol-last": 0, //檔案以單一的換行符結束
    "eqeqeq": 2, //必須使用全等
    "func-names": 0, //函式表示式必須有名字
    "func-style": [0, "declaration"], //函式風格，規定只能使用函式宣告/函式表示式
    "generator-star-spacing": 0, //生成器函式*的前後空格
    "guard-for-in": 0, //for in迴圈要用if語句過濾
    "handle-callback-err": 0, //nodejs 處理錯誤
    "id-length": 0, //變數名長度
    "indent": [2, 2], //縮排風格
    "init-declarations": 0, //宣告時必須賦初值
    "key-spacing": [0, {
      "beforeColon": false,
      "afterColon": true
    }], //物件字面量中冒號的前後空格
    "lines-around-comment": 0, //行前/行後備注
    "max-depth": [0, 4], //巢狀塊深度
    "max-len": [0, 80, 4], //字串最大長度
    "max-nested-callbacks": [0, 2], //回撥巢狀深度
    "max-params": [0, 3], //函式最多隻能有3個引數
    "max-statements": [0, 10], //函式內最多有幾個宣告
    "new-cap": 2, //函式名首行大寫必須使用new方式呼叫，首行小寫必須用不帶new方式呼叫
    "new-parens": 2, //new時必須加小括號
    "newline-after-var": 2, //變數宣告後是否需要空一行
    "object-curly-spacing": [0, "never"], //大括號內是否允許不必要的空格
    "object-shorthand": 0, //強制物件字面量縮寫語法
    "one-var": 0, //連續宣告
    "operator-assignment": [0, "always"], //賦值運算子 += -=什麼的
    "operator-linebreak": [2, "after"], //換行時運算子在行尾還是行首
    "padded-blocks": 0, //塊語句內行首行尾是否要空行
    "prefer-const": 0, //首選const
    "prefer-spread": 0, //首選展開運算
    "prefer-reflect": 0, //首選Reflect的方法
    "quotes": [1, "single"], //引號型別 `` "" ''
    "quote-props": [0, "always"], //物件字面量中的屬性名是否強制雙引號
    "radix": 2, //parseInt必須指定第二個引數
    "id-match": 0, //命名檢測
    "require-yield": 0, //生成器函式必須有yield
    "semi": [0, "always"], //語句強制分號結尾
    "semi-spacing": [0, {
      "before": false,
      "after": true
    }], //分號前後空格
    "sort-vars": 0, //變數宣告時排序
    "space-after-keywords": [0, "always"], //關鍵字後面是否要空一格
    "space-before-blocks": [0, "always"], //不以新行開始的塊{前面要不要有空格
    "space-before-function-paren": [0, "always"], //函式定義時括號前面要不要有空格
    "space-in-parens": [0, "never"], //小括號裡面要不要有空格
    "space-infix-ops": 0, //中綴操作符周圍要不要有空格
    "space-return-throw-case": 0, //return throw case後面要不要加空格
    "space-unary-ops": [0, {
      "words": true,
      "nonwords": false
    }], //一元運算子的前/後要不要加空格
    "spaced-comment": 0, //註釋風格要不要有空格什麼的
    "strict": 2, //使用嚴格模式
    "use-isnan": 2, //禁止比較時使用NaN，只能用isNaN()
    "valid-jsdoc": 0, //jsdoc規則
    "valid-typeof": 2, //必須使用合法的typeof的值
    "vars-on-top": 2, //var必須放在作用域頂部
    "wrap-iife": [2, "inside"], //立即執行函式表示式的小括號風格
    "wrap-regex": 0, //正規表示式字面量用小括號包起來
    "yoda": [2, "never"] //禁止尤達條件
  },
  parserOptions: {
    parser: "babel-eslint"
  }
};
複製程式碼

小結

小肆是處女座，處女座的程式碼潔癖有多嚴重你們知道的吧?不在專案開始前把程式碼規範先做好，專案直接進行不下去了呀。使用了eslint-prettier之後，不論我寫程式碼時多麼行(luan)雲（qi)流(ba)水(zao)，一按儲存，跟開了十級美顏似的，自信心暴增啊！如果你和小肆一樣，記得點好看呦。

前置閱讀：

從0到1使用VUE-CLI3開發實戰（四）: Axios封裝
2019-02-16
VueiOS封裝
從0到1使用VUE-CLI3開發實戰(五):模組化VUEX及使用vuetify
2019-01-25
Vue
node專案從0到1實戰
2022-02-15
vscode + prettier 專治程式碼潔癖（一）
2018-02-06
VSCode
從無到有構建vue實戰專案（六）
2019-07-21
Vue
從0到1，開發一個動畫庫(1)
2018-01-29
動畫
如何成為有程式碼潔癖的程式設計師？
2013-10-24
程式設計師
QQ日跡Omi實戰開發，從0到1
2017-07-17
《從0到1搭建一個IM專案》專案初始化
2022-12-28
從0到1，開發一個動畫庫(2)
2018-01-30
動畫
從0到1完成nutch分散式爬蟲專案實戰
2019-01-08
分散式爬蟲
從0到1使用Kubernetes系列（六）：資料持久化實戰
2019-04-10
持久化
React+webpack從0到1開發一個todoMvc（一）
2017-12-13
ReactWebMVC
從0到1使用kubebuiler開發operator
2022-05-19
UI
程式碼潔癖系列（八）：迭代的原則
2019-02-27
Flutter 開發從 0 到 1（五）原始碼
2020-11-16
Flutter原始碼
Vue3 全家桶，從 0 到 1 實戰專案，新手有福了
2021-12-23
Vue
React+webpack從0到1開發一個todoMvc（二）
2017-12-13
ReactWebMVC
React+webpack從0到1開發一個todoMvc（四）
2017-12-13
ReactWebMVC
React+webpack從0到1開發一個todoMvc（三）
2017-12-13
ReactWebMVC
從0到1編寫一個指令碼引擎
2022-04-20
指令碼
從0到1上線一個微信小程式
2019-03-01
微信小程式
webpack4.X 實戰（二）：從0開始搭建一個簡單的前端專案
2019-02-26
Web前端
從0到1開發實戰手機站（二）：Git提交規範配置
2019-01-25
Git
從0到1編寫一個JS指令碼引擎
2022-04-27
JS指令碼
如何理解敏捷開發的從0到1
2021-11-05
敏捷
iOS專案開發實戰——使用程式碼實現頁面跳轉
2015-08-21
iOS
Python專案開發實戰1
2017-05-12
Python
從 0 到 1 再到 100, 搭建、編寫、構建一個前端專案
2018-12-06
前端
APP 開發從 0 到 1（一）需求與準備
2020-07-05
APP
ChainDesk :從 0 到 1-Hyperledger Fabric 開發精要（一）
2019-02-18
AI
專案0到1的一些感想
2018-09-02
從0到1，滴滴DB自動化運維是這樣實踐的
2018-05-07
運維
從0到1開發一個小程式cli腳手架（一）--建立頁面/元件模版篇
2019-07-18
元件
從程式碼到部署微服務實戰（一）
2021-01-10
微服務
從0到1開發一個小程式cli腳手架（二）--版本釋出/管理篇
2019-08-05
從0開發一個iOS企業級專案效果介紹
2019-01-03
iOS
從0到1實現一個簡單計算器
2021-02-06