一个好的检查(linting)工具可以确保一个项目遵循编码规范。
让我们来看看四种流行替代方案的特性和优缺点:JSLint , JSHint , JSCS 和 ESLint 。
JSLint
JSLint 是其中最老的工具。在2002年 Douglas Crockford 开发了该工具,根据其经验,强制使用 JavaScript 语言中精粹部分。如果你同意这些精粹,JSLint 能成为一个好的工具 —— 现在就可以马上安装,直接使用。
JSLint 的缺点是不能配置 或者 扩展。你根本无法禁掉多余的功能,并且很多缺少文档。官方文档不是很友好,例如,它缺少如何将其集成到编辑器的信息。
优点
- 参数配置完成,可以直接使用(如果您赞同其执行规则的话)
缺点
- JSLint 没有配置文件,如果想改变参数设置,那就存在问题
- 有限的配置选项,许多规则不能禁掉
- 无法添加自定义规则
- 没有规则文档
- 很难弄清楚哪个规则引起的错误
JSHint
JSHint 是一个可配置的 JSLint 版本( JSLint 的一个 fork )。 您可以配置每个规则,并将其放入配置文件,这使得 JSHint 更加容易使用于更大的项目。 JSHint 对于每个规则还有很友好的文档,所以可以准确知道每个规则的作用。将其集成到编辑器也是简单的。
JSHint 的一个小缺点是它有一个松散的默认配置。 这意味着在你使用它之前,需要做一些设置。和 ESLint 相比,你想要知道更改哪些规则来启用或禁用某些错误消息是,JSHint 比较困难。
优点
- 大多是设置可以配置
- 支持配置文件,在大项目中容易使用
- 已经支持许多类库,像jQuery、QUnit、NodeJS、Mocha等
- 支持基本的ES6
缺点
- 很难知道哪个规则导致错误
- 有两种类型的选项 :强制选项和松散选项。使得配置有些混乱
- 不支持自定义规则
JSCS
JSCS?不同于其他,如果你不给它一个配置文件 或 告诉它一个配置项,JSCS 不会做任何事情。你可以从他们的网站下载配置,所以这不是一个大问题,而且它有很多预设,比如 jQuery 编码风格预设和 Google 预设。
它有90多个不同的规则,通过插件可以创建自定义规则。 JSCS 还支持自定义报告器,这使得它可以更容易与需要以特定格式输入的工具集成。
JSCS是一个代码风格检查器。 这意味着它只捕获与代码格式化相关的问题,不会报告潜在的错误或错误。 因此,与其他工具相比缺少灵活性,但如果你需要强制执行一个特定的编码风格,JSCS 可以做得很好。
优点
- 支持自定义报告,更容易与其他工具集成
- 如果你遵循一种可用的编码风格,预设和现成的配置文件可以使设置变得容易
- 在报告中存在标记包含规则名字,所以很容易找出哪个规则导致哪个错误
- 可以使用自定义插件来扩展
缺点
- 仅检查编码风格的违例。JSCS 不能检查潜在存在的 bug ,比如未使用的变量,或者偶然的全局变量等等。
- 四个工具中最慢,但是在使用中不是一个问题
ESLint
ESLint 是这四个中最新出的一个。它被设计成易于扩展,附带大量的自定义规则,并且很容易以插件的形式安装更多规则。它给出了简洁的输出,但是在默认情况下包含了规则名,因此您总是可以知道哪些规则导致了错误消息。
ESLint 文档可能会有一点影响或遗漏。规则列表易于遵循,并被分组到逻辑类别中,但是配置指令在某些地方有些混乱。不过,它确实提供了编辑器集成、插件和示例的链接。
优点
- 灵活:任何规则都可以开启或关闭,并且有些规则有些额外配置项
- 很容易扩展,并有许多可用的插件
- 易于理解的输出
- 包含了在其他检查器中不可用的规则,使得 ESLint 在错误检查上更有用
- 支持 ES6 ,唯一支持 JSX 的工具
- 支持自定义报告
缺点
- 需要一些配置
- 速度慢,但不是主要问题
我的推荐
在这4个工具中,我的选择是 ESLint 。JSHint 是严格和不可配置的,而 JSHint 缺少扩展机制。 如果仅仅用于编码风格检查,JSCS 是一个不错的选择,但是 ESLint 不仅可以进行代码风格的检查,而且可以检查代码中的 bug 和其他问题。
如果使用ES6(或 ES2015 ,因为他们似乎正在调用它),ESLint 也是明智的选择。在上面提到的工具中,ESLint 对 ES6 支持的最广泛。
如果你像尝试 ESLint ,我已经创建了一个 5 步快速入门指南。让你入门变得非常容易。 你可以 从我的网站下载ESLint 5步快速入门指南。
JSHint 是第二选择。如果不需要 ESLint 的高级功能,JSHint 会在正确配置后捕获大量问题。JSCS 拥有大量的可用规则,如果你不需要除了编码风格检查(缩进,大括号等)以外的其他检查,它将是一个最好的选择。
我非常犹豫去推荐 JSLint 。其他工具做同样地事情,但是不强制用户遵守这些规则。唯一的例外是你碰巧同意那些强制规则,在这种情况下,那是值得深入研究的。
检验工具是解决问题的好方法,但是它只能发现其规则匹配的许多错误。对于一个更安全的 bug 自动捕获来说,我建议使用单元测试。代码复查也可以用于此目的。
你和你的团队是如何保障代码质量的呢?
原文链接:https://www.sitepoint.com/comparison-javascript-linting-tools/