在前端开发中，JavaScript 是必不可少的一部分。而 JavaScript 代码的质量与合理性则对项目的成功与否有着非常重要的影响。为了提高代码的可读性、可维护性和可扩展性，在开发中通常都会采用良好的代码规范来约束代码质量。
而 JSHint 就是一个非常流行的 JavaScript 静态代码检查工具，可以根据指定的代码规范对 JavaScript 代码进行检查，帮助开发者发现代码潜在的问题并提出建议。JSHint 既可以在命令行中运行，也可以在开发工具中集成使用。
而对于喜欢用 CoffeeScript 开发的开发者来说，这里推荐一个 NPM 包 coffee-jshint，支持在 CoffeeScript 代码中使用 JSHint 规范，对其进行检查和提供代码提示。下面我们将介绍该包的详细使用教程。
安装
coffee-jshint 包支持在全局和项目本地环境中使用，由于我们通常是在项目中使用它，所以我们可以在项目根目录中通过 NPM 安装：
--- ------- ------------- ----------
配置
安装完成后，在项目根目录中添加一个 jshint.json 的配置文件来进行 JSHint 规则的配置，该文件至少需要定义 options 选项，关于更多选项的说明可以参考 JSHint 官方文档。
示例代码如下：
-
---------- -
------ ------
-------- -----
--------- -----
------------ --
-------- -----
--------- -----
---------------- -----
-------- -----
--------- --
---------- -----
----------- --
------------ --
---------------- ---
--------- -----
-------- -----
------- -----
---------- -----
--------- -----
-------- -----
----------- ------
----------- ---------
--------- -----
-------- -----
--------- -----
---------- -----
---------- -
--------- -----
---- -----
---- -----
---------- ----
-
--
---------- ----------------
-上述配置文件定义了一些常用的 JSHint 规则，比如需要加上分号、比较操作符必须是 === 、 !== 等等。其中 globals 选项定义了全局变量，这对于界定代码中的符号具有很大的帮助。
使用
在项目中安装和配置完成后，我们就可以在命令行中使用满足 JSHint 规则的 CoffeeScript 进行代码编写了。我们可以使用以下命令来对文件夹进行检查：
------------- ---------------------
也可以对单个文件进行检查：
------------- --------------------------
除了通过命令行进行检查外，我们还可以在代码编辑器中集成 coffee-jshint 包，使得编辑器在我们编写代码时就会进行静态检查，帮助我们提高开发效率并避免一些常见的错误。
以下是一个使用 coffee-jshint 的示例代码：
- -------------- - -- ----- --- - -- ------------ --------
在上面的代码中，我们使用了 $() 方法，它由全局变量 jQuery 提供。在 jshint.json 文件中，我们已经声明了这个变量，并且开启了对全局变量的检查。而 foo() 方法则在 $() 方法调用之前被调用，如果没有使用 use strict 来声明严格运行模式，这段代码就不会抛出异常。但在使用 coffee-jshint 检查时，它提醒我们：
----------------------- ---- - --- - --- -- --- --------
通过静态检查，我们可以避免这样的潜在问题发生。
结束语
coffee-jshint 包提供了在 CoffeeScript 中使用 JSHint 的能力，使得我们可以在编写 CoffeeScript 代码时遵循一系列代码规范来进行编写，提高代码的可维护性和可读性。通过它，我们可以避免在代码中插入不必要的错误和潜在的问题，最终提升代码质量和开发效率。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/79100