npm 包 approvals 使用教程
npm 是目前最受欢迎的包管理工具之一，它可以让我们快速地安装和更新依赖项。使用 npm 包来加速前端开发也越来越普遍。而这篇文章将介绍一种在 JavaScript 项目中使用的 npm 包——approvals 的使用方法。
approvals 是一个 java 中著名的库，而其 JavaScript 版本的 API 与 Java 版本类似，只不过适用于 JavaScript 环境。它提供了一个简单的接口，让您很容易地在单元测试中生成和更新文件内容，然后用这些内容自动批准或拒绝更改。
一、安装
首先，打开您的命令行，进入项目根目录，使用 npm 安装 approvals：
npm install approvals --save-dev
安装完成后，您可以在该项目中使用 approvals。
二、使用
approvals 提供了一个简单的 API，可以帮助您方便地生成和更新文件内容。下面我们将介绍一些常用的 API。
- verify
verify 用于比较两个文本字符串并验证它们是否匹配。 失败的情况下，它将记录差异，并保留新值以供查看。
示例代码：
-- -------------------- ---- ------- ----- --------- - --------------------- ----- --------- - --------------------- ---------- - -------------- - --- -- ----------- ----------------------- ------- ------ --------- -- --展开代码
执行后会输出以下结果：
1) Verify Failure detected in Hello World Received value does not match approved value Received had additional lines: Hello World!
可以看到，我们的测试失败了，输出的信息很详细，告诉我们，期望的值应该是 "Hello World!"，但是我们传入的字符串却是 "Hello World"，因此测试失败了。
- verifyAsJSON
verifyAsJSON 将 JavaScript 对象转换为 JSON，并将其用于验证。 它适用于比较简单的数据结构。
示例代码：
-- -------------------- ---- ------- ----- --------- - --------------------- ----- --------- - --------------------- ---------- - -------------- - --- ----- ---- - - -- -- -- -- -- - -- -- ----------- ---------------------------- --- -- -- -- -- ---- -- --展开代码
执行后会输出以下结果：
1) VerifyAsJSON Failure detected in {"a":1,"b":2,"c":3} Received value does not match approved value Expected: {"a":1,"b":3,"c":3} Received: {"a":1,"b":2,"c":3}
在这个例子中，期望的对象是 {a: 1, b: 3, c: 3}，但是我们传入的对象却是 {a: 1, b: 2, c: 3}，导致测试失败。
- verifyWithReporter
verifyWithReporter 与 verify 相似，不同之处在于它不会记录差异，而是使用指定的报告程序打印出差异。 这对于需要手动检查差异的情况非常有用。
示例代码：
-- -------------------- ---- ------- ----- --------- - --------------------- ----- --------- - --------------------- ---------- - -------------- - --- -- ------------------ -------- ----------------------------------- ------- ------ -------- ------------ ------------- --------- --------- -- - -------------------- -------------- --------- ------------------ ---------------------- ------------ ----------------------- ---展开代码
执行后会输出以下结果：
actual: path-to-actual-file, approved: path-to-approved-file received: Hello World, approved:Hello World!
这个例子中，我们使用了自定义的 reporter 函数，它会在测试失败时打印一些信息，以供手动检查。
- verifyFile
verifyFile 允许您加载文件并使用 verify 来比较它们。
示例代码：
-- -------------------- ---- ------- ----- --------- - --------------------- ----- --------- - --------------------- ---------- - -------------- - --- ----- ---------- - ---------------------- ----- ------------ - ------------------------ -- ---- -------------------------------- --------------展开代码
执行后会输出以下结果：
1) VerifyFile Failure detected in path-to-actual-file Received value does not match approved value Expected: Hello World! Received: Hello World
这个例子中，我们传入了两个文件路径，然后使用 verifyFile 检查它们的区别。
三、总结
可以看到，approvals 提供了一些简单但功能强大的 API，帮助我们方便地生成和更新文件内容，并自动批准或拒绝更改。对于前端自动化测试，使用这个包可以大大减少开发者的工作量，提高效率。
希望通过这篇文章的介绍，您能够更好地了解和使用这个 npm 包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/80497
