Jasmine 是一款流行的 JavaScript 测试框架，它内置了丰富的 Matchers 来支持各种测试场景。然而有时候我们需要自定义 Matcher 并且在测试结果中输出更加详细的信息。这时候就可以使用 npm 包 jasmine-custom-message。本文将介绍如何使用这个包来提高测试的准确性和可读性。
安装
首先需要安装 npm 包 jasmine-custom-message。可以通过以下命令来安装：
npm install jasmine-custom-message --save-dev
这个包依赖于 Jasmine 2.0 或更高版本，所以请确保你的项目中已经安装了正确版本的 Jasmine。
使用
使用 jasmine-custom-message 很简单，只需要在你的项目中引入该包并且使用它提供的函数即可。
下面我们假设我们想要测试一个名叫 add 的函数，它接收两个参数并返回它们的和。我们可以编写一个简单的测试用例来检查它的行为，如下所示：
describe('add function', function() {
it('should add two numbers', function() {
expect(add(1, 2)).toBe(3);
expect(add(2, 3)).toBe(5);
});
});这个测试用例很简单，它只测试了 add 函数的基本行为。但是如果测试结果失败时，我们只能看到一个模糊的错误信息，如下所示：
Expected 3 to be 4. Expected 5 to be 6.
很明显，这个错误信息并不包含太多有用的信息。我们需要一些自定义信息来帮助我们更加精确地定位错误原因。
自定义 Matcher
首先我们需要定义一个自定义 Matcher 来输出更加详细的信息。可以通过以下方法来创建一个 Matcher：
-- -------------------- ---- -------
---------------------
---------------- ---------- -
------ -
-------- ---------------- --------- -------- -
--- ------ - ---
----------- - ------ --- ---------
--------------- -
-------------- - --------- - - ------ - - --- -- ----- - - ---------
- ---- -
-------------- - --------- - - ------ - - -- ----- - - -------- - -- - - --------
-
------ -------
-
--
-
---这段代码定义了一个 Matcher 叫做 toAddTwoNumbers，它接收三个参数：actual 表示实际值，expected 表示期望值，message 表示自定义的信息。该 Matcher 的工作原理很简单，它只是比较实际值和期望值是否相等，并输出自定义信息。
有了这个自定义 Matcher，我们就可以在测试用例中使用它了。修改之前的测试用例，添加自定义信息，如下所示：
describe('add function', function() {
it('should add two numbers', function() {
expect(add(1, 2)).toAddTwoNumbers(3, "1 + 2 should equal 3");
expect(add(2, 3)).toAddTwoNumbers(5, "2 + 3 should equal 5");
});
});使用自定义 Matcher 时需要注意，Matcher 名称需要以 to 开头，并且需要定义一个 compare 函数返回一个带有 pass 和 message 两个属性的对象。
使用 jasmine-custom-message
现在我们可以使用 jasmine-custom-message 来输出自定义信息了。只需要在 beforeEach 函数中调用一次即可，如下所示：
beforeEach(function() {
jasmine.addMatchers(jasmineCustomMessage.matchers);
});这个函数将全局的 Matchers 替换为 jasmine-custom-message 提供的 Matchers，以便我们使用自定义信息。
现在我们重新运行测试用例，就能看到更加详细的错误信息了，如下所示：
Expected 3 to equal 4: 1 + 2 should equal 3 Expected 5 to equal 6: 2 + 3 should equal 5
这个错误信息包含了期望值、实际值和自定义信息，能够帮助我们更加准确地定位错误原因。
总结
本文介绍了如何使用 npm 包 jasmine-custom-message 来输出自定义信息，提高测试的准确性和可读性。通过自定义 Matcher 和 jasmine-custom-message，我们可以输出更加详细的错误信息，更加准确地定位错误原因。代码示例和注释详细，可以作为学习和参考的资料。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/72490