在前端测试中，我们经常会使用断言语句来验证代码的正确性。而 Chai 是一个非常流行的断言库，其中 should 风格使用起来非常自然和美观。默认情况下，Chai 库的 should 风格中的断言语句的提示信息非常清晰和详细，但有些时候我们可能需要自定义断言语句的提示信息，以便更准确地反馈代码的错误。本文将介绍如何在 Chai 库的 should 风格中自定义断言语句的提示信息。
为什么需要自定义断言语句的提示信息
默认情况下，Chai 库的 should 风格中的断言语句已经非常详细和准确了，例如：
const value = 10;
value.should.be.a('number');
value.should.equal(10);
value.should.not.equal(20);
value.should.be.above(9);
value.should.be.below(11);但有些时候，我们可能需要更加准确和详细的提示信息，例如：
const order = { id: 1, customer: 'John' };
order.should.have.property('id');
order.should.have.property('customer').that.is.a('string');上面的代码中，如果对象 order 没有属性 'id' 或属性 'customer' 的类型不是字符串，应该如何提示用户呢？默认情况下，Chai 库的 should 风格只是简单地报出错误信息 'expected [object Object] to have property [id|customer]' 或 'expected [object Object].[customer] to be a string'，这些信息可能无法完全反映出问题的本质。
因此，我们需要自定义断言语句的提示信息，以便更加准确地告诉用户哪些属性缺失、类型错误等问题。
自定义断言语句的提示信息
在 Chai 库的 should 风格中，我们可以使用 chainable properties 来自定义断言语句的提示信息。例如：
const order = { id: 1, customer: 'John' };
order.should.have.property('id', 'The order should have an "id" property');
order.should.have.property('customer').that.is.a('string', 'The "customer" property should be a string');上面的代码中，我们使用了 'have.property' 和 'is.a' 等 chainable properties 来自定义断言语句的提示信息。如果对象 order 没有属性 'id' 或属性 'customer' 的类型不是字符串，Chai 库的 should 风格将会提示自定义的错误信息 'The order should have an "id" property' 或 'The "customer" property should be a string'。
除了使用 chainable properties，我们还可以使用自定义的 AssertionError 类来自定义断言语句的提示信息。例如：
-- -------------------- ---- -------
----- ----- - - --- -- --------- ------ --
--------------------------------- - -------- ------ ---- -
------------
--------------- --- ----------
--- -- --------- ------------ -- ---- -------- ----------
--
--
-------------------------------------- -------- ----- -
------------
------ --------- --- ---------
--- -- --------- ------------ -- -- - -------
--
---
--------------------------- ---- ----- ------ ---- -- ---- -----------
--------------------------------- ---- ----- ------ ---- - ---------- -------- ---- -- - -------------------------------- ---------- -------- ------ -- - ---------上面的代码中，我们先自定义了一个 'property' 方法，用来判断对象是否有指定的属性，并提供一个默认的错误信息 'expected [object Object] to have property "{name}"'。然后，我们使用 addMethod 方法添加了一个 'stringType' 方法，用来判断对象是否是字符串类型，并提供一个默认的错误信息 'expected {this._obj} to be a string'。最后，我们使用自定义的 'property' 方法和 'stringType' 方法来自定义断言语句的提示信息。
总结
Chai 库的 should 风格是一个非常方便和美观的断言库，它能够帮助我们轻松高效地验证代码的正确性。通过自定义断言语句的提示信息，我们可以更准确地反映代码的问题，提高测试的可靠性和精确性。在实际使用中，我们可以根据具体的需求来选择使用 chainable properties 还是自定义 AssertionError 类，以便更好地适应不同的测试场景和需求。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6483de5a48841e989431878e