一种写 JavaScript 更合理的代码风格。

命名规范

• 避免单字母的名字。用你的命名来描述功能。 eslint: id-length

  // bad
  function q() {
    // ...
  }
  
  // good
  function query() {
    // ...
  }

• 在命名对象、函数和实例时使用驼峰命名法（camelCase）。 eslint: camelcase

  // bad
  const OBJEcttsssss = {}
  const this_is_my_object = {}
  function c() {}
  
  // good
  const thisIsMyObject = {}
  function thisIsMyFunction() {}

• 缩略词和缩写都必须是全部大写或者全部小写。

  为什么？因为名字是为了可读性，不是为了满足计算机算法。

  // bad
  import SmsContainer from './containers/SmsContainer'
  
  // bad
  const HttpRequests = [
    // ...
  ]
  
  // good
  import SMSContainer from './containers/SMSContainer'
  
  // good
  const HTTPRequests = [
    // ...
  ]
  
  // also good
  const httpRequests = [
    // ...
  ]
  
  // best
  import TextMessageContainer from './containers/TextMessageContainer'
  
  // best
  const requests = [
    // ...
  ]

• husky：工程化的根基，可以在进行 git 操作的时候，对 git 提供的一系列钩子进行拦截并执行相应的操作。例如对代码进行校验等。
• commitlint：代码的提交规范检验。可以对代码的 commit 内容进行校验，确保团队中的 commit 保持规范化，方便团队协作和快速定位问题。
• Lint-staged：前端文件过滤工具。代码的格式化工具肯定会涉及到文件系统，一般工具会先读取文件，格式化操作后重新写入。这个工具可以将 git 代码暂存区文件过滤出来，仅仅对被 committed 的文件进行处理。
• eslint：代码校验工具。eslint 不多介绍了，规范代码格式的工具，保证代码不出现一些低级错误。
• prettier：代码格式化工具。eslint 仅对代码中有问题的地方进行修改，不改动代码风格。而 prettier 是一款代码格式化工具，可以保证团队的代码风格一致。
• stylelint：代码校验工具。eslint 是 js 代码的格式规范工具，那 stylelint 则是 css 代码的格式规范工具，引入 stylelint 可以规范 css 代码的格式。

一种写JavaScript更合理的代码风格。

Note: 本指南假设你使用了 Babel, 并且要求你使用 babel-preset-airbnb 或者其他同等资源。 并且假设你在你的应用中安装了 shims/polyfills ，使用airbnb-browser-shims 或者相同功能。

1. 是什么？
   1. 一个 npm 包，可以对代码风格和基础语法作检查，实时报错提示
2. 好处
   1. 解决代码风格不统一的问题
   2. 还可以检测到一些基础语法错误

先看效果

以这个为例，在代码中我们定义了一个 This 的常量，但是在代码中并没有使用到它，这是违反 eslint 规则的，因此这里马上就被 IDE 识别出来并且标红提示。平时使用过 eslint 的小伙伴应该知道，如果是一些小问题（例如字符串应该用单引号而不是双引号）这种问题，在保存代码时可以被 auto fix 掉，但是上面例子的这个问题，因为涉及到一个变量/常量，eslint 是不会擅自将其删掉来修改这个问题的。所以如果我们使用 eslint --fix 修复的话，eslint 会报错让我们自行修改。我们可以利用这个错误，来防止没有通过 eslint 的代码被 commit。