項(xiàng)目規(guī)則

.gitignore 規(guī)則

忽略上傳到 git 的文件

  • # 代表注釋
  • 匹配模式前 / 代表項(xiàng)目根目錄
  • 匹配模式最后加 / 代表是目錄,如果文件和文件夾名字相同時(shí)候有用
  • 匹配模式前加 ! 代表取反
  • * 代表任意個(gè)字符
  • 匹配任意一個(gè)字符
  • ** 匹配多級(jí)目錄

.npmignore

忽略上傳到 npm 的文件

規(guī)則和 .gitignore 類似。

如果項(xiàng)目里面沒有 .npmignore 文件,則會(huì)讀取 .gitignore

.editorconfig

editorconfig 文檔

代碼風(fēng)格的配置,為了讓項(xiàng)目在不同的編輯器、IDE 中代碼風(fēng)格一樣。

eslint

eslint 中文網(wǎng)

規(guī)范 JavaScript 書寫規(guī)范,讓代碼風(fēng)格統(tǒng)一。

    //全局安裝 eslint
npm intall -g eslint

    //初始化一個(gè) eslintrc
eslint --init

eslintrc 的配置例子

module.exports = {
    "env": {
        "node": true,
        "commonjs": true,
        "es6": true
    },
    "extends": "eslint:recommended",
    "rules": {
        "indent": [
            "error",
            4
        ],
        "linebreak-style": [
            "error",
            "unix"
        ],
        "quotes": [
            "error",
            "single"
        ],
        "semi": [
            "error",
            "always"
        ]
    }
};

自動(dòng)化檢查 eslint

package.json 中添加自定義 script 指令

"scripts": {
        "test": "echo \"Error: no test specified\" && exit 1",
        "fix": "eslint --fix .",
        "lint": "eslint ."
    },

使用 pre-commit 工具,在 git commit 之前檢測(cè) eslint ,檢測(cè)不通過則 commit 失敗

安裝 pre-commit

npm install pre-commit --save-dev

package.json 中添加配置項(xiàng)

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "fix": "eslint --fix .",
    "lint": "eslint ."
},
"pre-commit": [
    "fix",
    "lint"
],

這樣,如果 eslint 檢測(cè)不能通過,就會(huì) commit 失敗

.eslintignore

忽略進(jìn)行 eslint 檢查的文件,規(guī)則和 .gitignore 類似。

?著作權(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)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

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

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,555評(píng)論 19 139
  • ESLint 配置 ESlint 被設(shè)計(jì)為完全可配置的,這意味著你可以關(guān)閉每一個(gè)規(guī)則而只運(yùn)行基本語(yǔ)法驗(yàn)證,或混合和...
    靜默虛空閱讀 41,848評(píng)論 3 14
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,273評(píng)論 6 342
  • Hello,大家好,今天給大家繼續(xù)講解排序系列??赡苡屑?xì)心的"鳥友"會(huì)問,你不是講解排序嗎?怎么今天的主題是...
    Leon_Geo閱讀 354評(píng)論 0 1
  • 他不愛名車。 他不愛美女。 他不愛金錢。 對(duì)他而言,世上只有一種有意義的存在,叫“hello world”。這是什...
    柒零_閱讀 548評(píng)論 4 2

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