eslint 配置

Author: cloudyan

.eslintrc

@@ -0,0 +1,46 @@
+
+// JS 书写规范
+// http://eslint.org
+// http://standardjs.com/rules.html
+//
+// @dependencies 安装到全局，就不用每个项目单独安装了
+// npm install -g eslint eslint-plugin-import
+// standard: npm install -g eslint-config-standard eslint-plugin-standard eslint-plugin-promise
+// airbnb: npm install -g eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-airbnb
+
+// NOTE: 在新项目中使用 error 级别，在老项目中使用 warning 级别
+
+module.exports = {
+  root: true,
+  parser: 'babel-eslint',
+  installedESLint: true,
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+  },
+  globals: {
+    Vue: false,
+  },
+
+  plugins: [
+    'html',
+  ],
+  // https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style
+  // https://github.com/feross/eslint-config-standard/blob/master/eslintrc.json
+  // extends: 'standard',
+  // ES6 推荐规范
+  extends: 'airbnb',
+  // extends: 'defaults/configurations/airbnb/es6',
+
+  // add your custom rules here
+  rules: {
+    // 行尾分号，默认配置always，要求在行末加上分号，standard 配置强制不带
+    semi: ['error', "never"],
+    // 多行模式必须带逗号，单行模式不能带逗号
+    'comma-dangle': ['error', 'always-multiline'],
+    // "max-len": ['error', 120],
+    // 禁止使用 console debugger
+    // 'no-console': 1,
+    // 'no-debugger': 1,
+  },
+}

.eslintrc.js

@@ -1,3 +1,8 @@
-node_modules/*
+# /node_modules/* and /bower_components/* ignored by default
+
+# Ignore built files except build/index.js
+build/*
+!build/build-test.js
+
 **/vendor/*.js
 dist/

docs/.eslintignore

@@ -0,0 +1,39 @@
+
+# 配置使用
+
+拷贝 [.eslintrc.js](../.eslintrc.js) 到项目根目录
+
+> 为什么选用 `.eslintrc.js` 后缀名？因为 `.json` 没法加注释，格式要求比较严格，而 `.eslintrc` 格式在 vscode 中默认做 json 处理了，其中的注释 # 就显示为了异常，所以统一使用 js 格式，通用了
+
+## 项目配置，安装 ESLint 依赖
+
+可以安装到全局，全部共用
+
+```
+// ES6 推荐使用 airbnb
+npm install -g eslint eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-airbnb
+
+// 如果使用 standardjs(仅仅涉及 ES5)
+npm install -g eslint-config-standard eslint-plugin-standard eslint-plugin-promise
+```
+
+
+## 编辑器配置
+
+### Atom
+
+```
+编辑器要安装 linter-eslint 插件
+配置 .eslintrc filePath 为 .eslintrc.js
+勾选选项 Use global ESLint installation
+```
+
+### VSCode
+
+```
+编辑器要安装 eslint 插件
+编辑器增加全局配置
+  "eslint.options": {
+    "configFile": "./.eslintrc.js"
+  },
+```

docs/.eslintrc

@@ -0,0 +1,43 @@
+
+// JS 书写规范
+// http://eslint.org
+// http://standardjs.com/rules.html
+//
+// @dependencies 安装到全局，就不用每个项目单独安装了
+// standard: npm install -g eslint-config-standard eslint-plugin-standard eslint-plugin-promise
+// airbnb: npm install -g eslint eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-airbnb
+
+// NOTE: 在新项目中使用 error 级别，在老项目中使用 warning 级别
+
+module.exports = {
+  root: true,
+  parser: 'babel-eslint',
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+  },
+  globals: {
+    Vue: false,
+  },
+
+  plugins: [
+    'html',
+  ],
+  // https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style
+  // https://github.com/feross/eslint-config-standard/blob/master/eslintrc.json
+  // extends: 'standard',
+  // ES5 推荐规范
+  // extends: 'airbnb',
+  extends: 'defaults/configurations/airbnb/es5',
+
+  // add your custom rules here
+  rules: {
+    // 行尾分号，默认配置always，要求在行末加上分号，standard 配置强制不带
+    semi: ['error', 'never'],
+    // 多行模式必须带逗号，单行模式不能带逗号
+    'comma-dangle': ['error', 'always-multiline'],
+    // 禁止使用 console debugger
+    // 'no-console': 1,
+    // 'no-debugger': 1,
+  },
+}

docs/config-eslint.md

@@ -2,7 +2,7 @@
 // ES6 代码规范练习场
 
 // 为便于测试，关闭部分规则检测
-/* eslint no-unused-vars: 0 */
+/* eslint no-unused-vars: 0, no-console: 0, prefer-const: 0, */
 
 // [类型](#types)
 // 使用 let const 替代 var

docs/es5.eslintrc

@@ -28,17 +28,7 @@ NOTE: 本文对[Airbnb JavaScript Style Guide](https://github.com/airbnb/javascr
 
 ## Usage
 
-```
-# 安装依赖到全局，就不用每个项目单独安装了
-# standard: npm install -g eslint-config-standard eslint-plugin-standard eslint-plugin-promise
-# airbnb: npm install -g eslint eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-airbnb
-
-# 最新项目推荐使用 airbnb，目前稍有改动，[ES6 规则配置 .eslintrc](.eslintrc)
-
-# 老旧项目，可以使用 [ES5 规则配置 .eslintrc](es5.eslintrc)
-
-# 将 ES6配置 放置在项目根目录，如果有老旧项目同时维护，可以将 ES5配置 放在全局。
-```
+参见[config-eslint](./config-eslint.md)
 
 NOTE: 使用规范最好的方式，就是配置好，直接用，然后各种问题就出来了