在前端开发中，代码的可维护性和规范性对于项目的成功与否至关重要。而 written-hound 这个 npm 包就是针对代码规范性检查的一个工具，利用静态分析的方式来进行代码的检测和提示，让代码更加规范且易于维护。
安装 written-hound
使用 npm 进行安装，命令如下：
--- ------- -- -------------
此时，written-hound 就已经安装成功了。
使用 written-hound
使用 written-hound 也非常简单，只需要在终端中进入到目标代码所在的目录，然后输入以下命令：
------------- ----
这个操作会在当前目录下生成一个 .written-hound.yml 的配置文件，用户可以在该文件中进行相应的配置，比如选择检查的规则和检查的路径等等。
例如，我们可以在 .written-hound.yml 文件中配置以下规则：
- ------------------
---------
--------
- ---------
--------
- --------------------
------
--------- --
--------- --上述配置中，patterns 字段定义了需要检查的文件路径，exclude 字段则定义了不需要检查的文件路径。rules 字段中则定义了使用的规则，此处我们选择了 eslint 和 typescript 检查规则。
此外，written-hound 还提供了一些可用的规则，如 JSHint，stylelint 等等。用户可以根据自己的需求进行相应的选择和配置。
检查代码
配置完成之后，我们就可以使用 written-hound 对代码进行检查了。只需要执行以下命令即可：
------------- ----
此时，written-hound 会开始对指定的代码进行检测，当检测出有一些不符合规范的代码时，它会直接在终端中输出错误提示信息，例如：
--------------------------- --- ----- ------- ----- ------- --- -------- ------ ------------------- --- ----- -------- ----------- -- - ------ --- ----- - ------
上述错误提示信息中，第一行指明了出现问题的文件路径，接下来的两行则给出了具体的错误提示内容。
如果检测中没有出现错误提示信息，则表示代码符合要求，可以放心部署。
总结
written-hound 作为一个代码规范性检查的 npm 包，确实非常方便和实用。通过静态分析的方式，它可以检测出许多代码规范问题，并可以根据用户的实际需求进行相应的配置，更加灵活智能。同时，written-hound 也提供了详细的文档和示例代码，让用户更加容易地学会使用和配置。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600573a481e8991b448e99e3