ESLint | wepack+vue+vscode的一站式ESLint配置

最近用webpack4 ( 非vue-cli ) 搭建了一個vue項目惠勒,因為要和多人協(xié)作完成,所以配置了eslint漆羔。因為網(wǎng)上的教程都有點過時了剿干,讓我踩了坑婆芦,這里提供的是 2019/5/2 的最新配置方法怕磨,并且還提供了vscode 的 ESLint + Prettier + Vetur 擴展配置喂饥,以便于更好地支持eslint。

適用對象:webpack4 + vue2 以及 vscode使用者

webpack 配置

安裝依賴

總依賴列表, 你可以復(fù)制進package.json, 然后用 npm install 安裝肠鲫。

devDependencies:{
    "babel-eslint": "^10.0.1",
    "eslint": "^5.16.0",
    "eslint-config-standard": "^12.0.0",
    "eslint-friendly-formatter": "^4.0.1",
    "eslint-loader": "^2.1.2",
    "eslint-plugin-html": "^5.0.3",
    "eslint-plugin-import": "^2.17.2",
    "eslint-plugin-node": "^8.0.1",
    "eslint-plugin-promise": "^4.1.1",
    "eslint-plugin-standard": "^4.0.0",
    "eslint-plugin-vue": "^5.2.2",
}

package.json 配置

為了添加一個 lint 命令员帮,用來檢測語法錯誤,npm run lint 就可以使用导饲。

"scripts": {
    "build": "webpack --mode=production --config build/webpack.base.conf.js",
    "dev": "NODE_ENV=development webpack-dev-server --config build/webpack.base.conf.js",
    "lint": "eslint --ext .js,.vue src" // 添加這一行
  },

webpack.config.js 配置

對js文件和vue文件啟用eslint檢查捞高,由于enforce是 'pre' ,所以它會在編譯前檢查帜消。
注意resolve('src') 的resolve函數(shù)需要自己定義棠枉,其實就是根目錄下的src文件。

rules:[
  ···
  {
    test: /\.(js|vue)$/,
    use: {
      loader: 'eslint-loader',
      options: {
        formatter: require('eslint-friendly-formatter') // 默認的錯誤提示方式
      }
    },
    enforce: 'pre', // 編譯前檢查
    include: [resolve('src')]
  },
]

.eslintrc.js 配置

這是eslint的主要配置文件泡挺,之前我踩的坑也是因為這里的配置經(jīng)常出錯。當然命浴,在未來可能我這個配置也會過時娄猫,推薦大家多查看下官方文檔:https://vuejs.github.io/eslint-plugin-vue/user-guide/#usage

可以將下面對內(nèi)容完整復(fù)制進根目錄下創(chuàng)建的 .eslintrc.js 文件。

module.exports = {
  root: true,
  env: {
    browser: true
  },
  extends: ['standard', 'plugin:vue/recommended'], 
  parserOptions: {
    parser: 'babel-eslint',
    sourceType: 'module'
  },
  plugins: ['vue', 'html'],
  // 對vue文件取消了縮進檢查
  overrides: [
    {
      files: ['*.vue'],
      rules: {
        indent: 'off'
      }
    }
  ],
  rules: {
    // allow paren-less arrow functions
    'arrow-parens': 0,
    // allow async-await
    'generator-star-spacing': 0,
    // allow debugger during development
    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
    'no-irregular-whitespace': [
      'error',
      {
        skipComments: true,
        skipTemplates: true
      }
    ],
    'no-unused-vars': ['warn']
  }
}

.eslintignore 配置

該文件主要是讓eslint忽略這些文件夾下的語法檢查生闲,可以是dist目錄下媳溺,build 目錄下的js文件。

同樣碍讯,可以將下面對內(nèi)容完整復(fù)制進根目錄下創(chuàng)建的 .eslintignore 文件悬蔽。

build/*.js
dist/*.js
src/assets/js/*.js

.editorconfig

這是我個人推薦加的配置文件,如果你只需要eslint可以不加捉兴。用來告訴編輯器你的項目一些規(guī)則比如代碼縮進蝎困。
同樣,你可以復(fù)制然后放在根目錄下創(chuàng)建的 .editorconfig 文件

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

webpack的配置到此結(jié)束啦倍啥,下面介紹vscode的配置禾乘。


vscode

這里不廢話直接放配置文件,先在擴展那里安裝ESLint + Prettier + Vetur 這三個插件虽缕,然后按 ctrl+shift+t 打開 setting.json 就可以往里面貼配置啦始藕。

{
  // tab 大小為2個空格
  "editor.tabSize": 2,
  // 100 列后換行
  "editor.wordWrapColumn": 100,
  // 保存時格式化
  "editor.formatOnSave": true,
  // prettier 設(shè)置強制單引號
  "prettier.singleQuote": true,
  // prettier 去分號
  "prettier.semi": false,
  // prettier 開啟eslint規(guī)范
  "prettier.eslintIntegration": true,
  // prettier 在vue文件禁用
  "prettier.disableLanguages": ["vue"],
  // 設(shè)置 eslint 保存時自動修復(fù)
  "eslint.autoFixOnSave": true, // try
  // eslint 檢測文件類型
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    {
      "language": "html",
      "autoFix": true
    },
    {
      "language": "vue",
      "autoFix": true
    }
  ],
  // vetur 的自定義設(shè)置
  "vetur.format.defaultFormatterOptions": {
    "prettyhtml": {
      "printWidth": 100,
      "singleQuote": false
    },
    "prettier": {
      "singleQuote": true,
      "proseWrap": "never",
      "printWidth": 100
    }
  },
  // 選擇 vue 文件中 template 的格式化工具
  "vetur.format.defaultFormatter.html": "none",
  "vetur.format.defaultFormatter.js": "vscode-typescript",
  "vetur.format.defaultFormatter.ts": "prettier",
  "vetur.format.defaultFormatter.css": "prettier",
  "vetur.format.defaultFormatter.postcss": "prettier",
  "vetur.format.defaultFormatter.scss": "prettier",
  // 文件自動保存
  "files.autoSave": "afterDelay",
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  // 括號前加空格
  "javascript.format.insertSpaceBeforeFunctionParenthesis": true
}

創(chuàng)作不易,有需要幫助的留言氮趋,覺得有用的請點贊哦~??

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末伍派,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子剩胁,更是在濱河造成了極大的恐慌诉植,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,884評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件摧冀,死亡現(xiàn)場離奇詭異倍踪,居然都是意外死亡系宫,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,347評論 3 385
  • 文/潘曉璐 我一進店門建车,熙熙樓的掌柜王于貴愁眉苦臉地迎上來扩借,“玉大人,你說我怎么就攤上這事缤至〕弊铮” “怎么了?”我有些...
    開封第一講書人閱讀 157,435評論 0 348
  • 文/不壞的土叔 我叫張陵领斥,是天一觀的道長嫉到。 經(jīng)常有香客問我,道長月洛,這世上最難降的妖魔是什么何恶? 我笑而不...
    開封第一講書人閱讀 56,509評論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮嚼黔,結(jié)果婚禮上细层,老公的妹妹穿的比我還像新娘。我一直安慰自己唬涧,他們只是感情好疫赎,可當我...
    茶點故事閱讀 65,611評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著碎节,像睡著了一般捧搞。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上狮荔,一...
    開封第一講書人閱讀 49,837評論 1 290
  • 那天胎撇,我揣著相機與錄音,去河邊找鬼轴合。 笑死创坞,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的受葛。 我是一名探鬼主播题涨,決...
    沈念sama閱讀 38,987評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼总滩!你這毒婦竟也來了纲堵?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,730評論 0 267
  • 序言:老撾萬榮一對情侶失蹤闰渔,失蹤者是張志新(化名)和其女友劉穎席函,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體冈涧,經(jīng)...
    沈念sama閱讀 44,194評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡茂附,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,525評論 2 327
  • 正文 我和宋清朗相戀三年正蛙,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片营曼。...
    茶點故事閱讀 38,664評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡乒验,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出蒂阱,到底是詐尸還是另有隱情锻全,我是刑警寧澤,帶...
    沈念sama閱讀 34,334評論 4 330
  • 正文 年R本政府宣布录煤,位于F島的核電站鳄厌,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏妈踊。R本人自食惡果不足惜了嚎,卻給世界環(huán)境...
    茶點故事閱讀 39,944評論 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望响委。 院中可真熱鬧新思,春花似錦、人聲如沸赘风。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,764評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽邀窃。三九已至,卻和暖如春假哎,著一層夾襖步出監(jiān)牢的瞬間瞬捕,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,997評論 1 266
  • 我被黑心中介騙來泰國打工舵抹, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留肪虎,地道東北人。 一個月前我還...
    沈念sama閱讀 46,389評論 2 360
  • 正文 我出身青樓惧蛹,卻偏偏與公主長得像扇救,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子香嗓,可洞房花燭夜當晚...
    茶點故事閱讀 43,554評論 2 349

推薦閱讀更多精彩內(nèi)容