@aarondewes/wp-jest-console 中文文档教程

Question

Jest Console

自定义 Jest 匹配器 控制台 对象来测试 WordPress 中的 JavaScript 代码。

此包将 console.error、console.info、console.log 和 console.warn 函数转换为模拟和跟踪他们的电话。 每当测试代码调用上述 console 方法之一时，它还会强制使用相关匹配器之一。 这意味着当 console.error 时，您需要使用 .toHaveErrored() 或 .toHaveErroredWith( arg1, arg2, ... ) 断言 得到执行，并在调用console.info、console.log或console.warn时使用相应的方法。 否则你的测试将失败！ 这是一个有意识的设计决策，有助于在以下情况下检测弃用警告 重构代码时升级依赖库或更小的错误。

Installation

安装模块：

npm install @wordpress/jest-console --save-dev

注意：此包需要 Node.js 12.0.0 或更高版本。 它与旧版本不兼容。

Setup

最简单的设置是使用 Jest 的 setupFilesAfterEnv 配置选项：

"jest": {
  "setupFilesAfterEnv": [
    "@wordpress/jest-console"
  ]
},

Usage

.toHaveErrored()

使用 .toHaveErrored 确保调用 console.error 函数。

例如，假设您有一个 drinkAll( flavor ) 函数，可以让您喝下所有可用的饮料。 您可能想检查函数是否为 'octopus' 调用了 console.error，因为 'octopus' 风味确实 很奇怪，为什么会有章鱼味的东西？ 您可以使用此测试套件做到这一点：

describe( 'drinkAll', () => {
    test( 'drinks something lemon-flavored', () => {
        drinkAll( 'lemon' );
        expect( console ).not.toHaveErrored();
    } );

    test( 'errors when something is octopus-flavored', () => {
        drinkAll( 'octopus' );
        expect( console ).toHaveErrored();
    } );
} );

.toHaveErroredWith( arg1, arg2, ... )

使用 .toHaveErroredWith 确保 console.error 函数被调用 具体论据。

例如，假设您有一个 drinkAll( flavor ) 函数，让您喝下所有可用的饮料。 您可能想检查函数调用 console.error 是否带有针对 'octopus' 的特定消息，因为 'octopus' 味道真的很奇怪，为什么会有章鱼味的东西？ 为确保这有效，您可以编写：

describe( 'drinkAll', () => {
    test( 'errors with message when something is octopus-flavored', () => {
        drinkAll( 'octopus' );
        expect( console ).toHaveErroredWith(
            'Should I really drink something that is octopus-flavored?'
        );
    } );
} );

.toHaveInformed()

使用 .toHaveInformed 确保调用 console.info 函数。

与 .toHaveErrored() 几乎相同的用法。

.toHaveInformedWith( arg1, arg2, ... )

使用 .toHaveInformedWith 确保调用了 console.info 函数 具体论据。

与 .toHaveErroredWith() 几乎相同的用法。

.toHaveLogged()

使用 .toHaveLogged 确保调用了 console.log 函数。

与 .toHaveErrored() 几乎相同的用法。

.toHaveLoggedWith( arg1, arg2, ... )

使用 .toHaveLoggedWith 确保调用了 console.log 函数 具体论据。

与 .toHaveErroredWith() 几乎相同的用法。

.toHaveWarned()

使用 .toHaveWarned 确保 console.warn 函数被调用。

与 .toHaveErrored() 几乎相同的用法。

.toHaveWarnedWith( arg1, arg2, ... )

使用 .toHaveWarneddWith 确保调用了 console.warn 函数 具体论据。

与 .toHaveErroredWith() 几乎相同的用法。