文档部分调整

Author: cloudyan

.eslintrc.js

@@ -2,17 +2,18 @@
 // JS 书写规范
 // http://eslint.org
 // http://standardjs.com/rules.html
-//
+// 具体规范参见文档[javascript-style-guide](https://github.com/webcoding/javascript-style-guide/blob/master/docs)
+
 // 配置参看 [config-eslint.md](https://github.com/webcoding/javascript-style-guide/blob/master/docs/config-eslint.md)
 
-// NOTE: 在新项目中使用 error 级别，在老项目中使用 warning 级别
+// NOTE: 兼容性设定，放置在项目根目录，同时支持 ES5、ES6 便于切换
 
 module.exports = {
   root: true,
   parser: 'babel-eslint',
   installedESLint: true,
   parserOptions: {
-    ecmaVersion: 6,
+    // ecmaVersion: 6,
     sourceType: 'module',
   },
   globals: {
@@ -23,20 +24,19 @@ module.exports = {
     // 处理 html 文件内 js 代码规范等
     '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: 'webcoding/configurations/airbnb/es5',
   // ES6 推荐规范
   extends: 'airbnb',
-  // extends: 'defaults/configurations/airbnb/es6',
+  // extends: 'webcoding/configurations/airbnb/es6',
 
   // add your custom rules here
   rules: {
     // 行尾分号，默认配置always，要求在行末加上分号，standard 配置强制不带
-    semi: ['error', "never"],
+    semi: ['error', 'never'],
     // 多行模式必须带逗号，单行模式不能带逗号
     'comma-dangle': ['error', 'always-multiline'],
-    // "max-len": ['error', 120],
+    // 'max-len': ['error', 120],
     // 禁止使用 console debugger
     // 'no-console': 1,
     // 'no-debugger': 1,

docs/config-eslint.md

@@ -5,16 +5,29 @@
 
 > 为什么选用 `.eslintrc.js` 后缀名？因为 `.json` 没法加注释，格式要求比较严格，而 `.eslintrc` 格式在 vscode 中默认做 json 处理了，其中的注释 # 就显示为了异常，所以统一使用 js 格式，通用了
 
+NOTE: 可扩展需求
+
+- eslint-plugin-html  html 内 js 规范
+- eslint-plugin-react react 规范
+- eslint-plugin-jsx-a11y JSX 代码段内应用 AST 检查器
+- eslint-plugin-promise 回调函数使用最佳实践
+- eslint-plugin-vue 支持 vue 文件
+
 ## 项目配置，安装 ESLint 依赖
 
 可以安装到全局，全部共用
 
 ```
 // ES6 推荐使用 airbnb
 npm install -g eslint eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-airbnb
+// 之后设置
+extend: 'airbnb',
+
 
-// 如果使用 standardjs(仅仅涉及 ES5)
-npm install -g eslint-config-standard eslint-plugin-standard eslint-plugin-promise
+// ES5 推荐使用 airbnb/es5（）
+npm install -g eslint eslint-config-webcoding
+// 之后设置
+extend: 'webcoding/configurations/airbnb/es5',
 ```
 
 

docs/es5.eslintrc.js

@@ -2,40 +2,42 @@
 // 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
+// 具体规范参见文档[javascript-style-guide](https://github.com/webcoding/javascript-style-guide/blob/master/docs)
 
-// NOTE: 在新项目中使用 error 级别，在老项目中使用 warning 级别
+// 配置参看 [config-eslint.md](https://github.com/webcoding/javascript-style-guide/blob/master/docs/config-eslint.md)
+
+// NOTE: 兼容性设定，放置在项目根目录，同时支持 ES5、ES6 便于切换
 
 module.exports = {
   root: true,
   parser: 'babel-eslint',
+  installedESLint: true,
   parserOptions: {
-    ecmaVersion: 6,
+    // ecmaVersion: 6,
     sourceType: 'module',
   },
   globals: {
     Vue: false,
   },
 
   plugins: [
+    // 处理 html 文件内 js 代码规范等
     '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: 'webcoding/configurations/airbnb/es5',
+  // ES6 推荐规范
   // extends: 'airbnb',
-  extends: 'defaults/configurations/airbnb/es5',
+  // extends: 'webcoding/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,

docs/es6_zh-cn_v3.md

@@ -1477,10 +1477,10 @@ Other Style Guides
 
 
 <a name="iterators-and-generators"></a>
-## Iterators and Generators 迭代器 & 生成器
+## Iterators and Generators
 
   <a name="iterators--nope"></a><a name="11.1"></a>
-  - [11.1](#iterators--nope) 不要使用 iterators。使用高阶函数例如 `map()` 和 `reduce()` 替代 `for-in` or `for-of`。
+  - [11.1](#iterators--nope) 不要使用迭代器 iterators。使用高阶函数例如 `map()` 和 `reduce()` 替代 `for-in` or `for-of`。
   eslint: [`no-iterator`](http://eslint.org/docs/rules/no-iterator.html) [`no-restricted-syntax`](http://eslint.org/docs/rules/no-restricted-syntax)
 
     > 为什么? 这加强了我们不变的规则。处理纯函数的回调值更易读，这比它带来的副作用更重要。
@@ -1520,7 +1520,7 @@ Other Style Guides
     ```
 
   <a name="generators--nope"></a><a name="11.2"></a>
-  - [11.2](#generators--nope) 现在还不要使用生成器 generators。
+  - [11.2](#generators--nope) 现在还不要使用 generators。
 
     > 为什么? 因为它们现在还没法很好地编译到 ES5。 (译者注：目前(2016/03) Chrome 和 Node.js 的稳定版本都已支持 generators)