跳转至主内容
Version: 28.0

Jest 平台工具

你可以自由选择Jest的特定功能,并独立使用这些包。 下面是可用的软件包列表:

jest-changed-files

用于识别 git/hg 存储库中已修改文件的工具。 导出两个函数:

  • getChangedFilesForRoots 返回一个resolved状态的Promise,此Promise包含修改文件和仓库信息。
  • findRepos 返回一个resolved状态的Promise,此Promise包含指定路径的一组仓库数据。

例子

const {getChangedFilesForRoots} = require('jest-changed-files');

// 打印出当前目录最后修改过的一组文件
getChangedFilesForRoots(['./'], {
lastCommit: true,
}).then(result => console.log(result.changedFiles));

获取更多信息,请关注jest-changed-files中的 Readme

jest-diff

数据更改的可视化工具。 输出一个函数,两个任何类型的值输入该函数后,返回一个“较易读”的字符串来展现其区别。

例子

const {diff} = require('jest-diff');

const a = {a: {b: {c: 5}}};
const b = {a: {b: {c: 6}}};

const result = diff(a, b);

// 打印两个值的差异
console.log(result);

jest-docblock

提取和解析 JavaScript 文件顶部注释的工具, 导出各种函数来操作注释块内的数据。

例子

const {parseWithComments} = require('jest-docblock');

const code = `
/**
* This is a sample
*
* @flow
*/

console.log('Hello World!');
`;

const parsed = parseWithComments(code);

// 打印一个包含两个属性的对象: comments and pragmas.
console.log(parsed);

获取更多关于jest-docblock 的信息,请阅读 readme file.

jest-get-type

用于识别任何 JavaScript 值的原始类型的模块, 模块导出了一个可以识别传入参数类型并将类型以字符串作为返回值的函数。

例子

const {getType} = require('jest-get-type');

const array = [1, 2, 3];
const nullValue = null;
const undefinedValue = undefined;

// prints 'array'
console.log(getType(array));
// prints 'null'
console.log(getType(nullValue));
// prints 'undefined'
console.log(getType(undefinedValue));

jest-validate

用于验证用户提交的配置的工具。 导出一个要传入两个参数的函数:一个是用户的配置,另一个是包含示例配置和其他选项的对象。 该函数返回一个具有两个属性的对象:

  • hasDeprecationWarnings,布尔值,提示你提交的配置是否有弃用警告
  • isValid, 布尔值, 提示配置是否正确

例子

const {validate} = require('jest-validate');

const configByUser = {
transform: '<rootDir>/node_modules/my-custom-transform',
};

const result = validate(configByUser, {
comment: ' Documentation: http://custom-docs.com',
exampleConfig: {transform: '<rootDir>/node_modules/babel-jest'},
});

console.log(result);

关于 jest-validate 更多的信息可以查看 readme file

jest-worker

用于任务并行化的模块。 导出一个 Worker 类,传入 Node.js 的路径,可以让你调用模块导出的方法,就像是这个类的方法一样,返回一个承诺,当指定的方法在分支进程里执行完成的时候就会解析。

例子

heavy-task.js
module.exports = {
myHeavyTask: args => {
// 长时间运行的CPU密集型任务
},
};
main.js
async function main() {
const worker = new Worker(require.resolve('./heavy-task.js'));

// 传入不同参数并行运行两个任务
const results = await Promise.all([
worker.myHeavyTask({foo: 'bar'}),
worker.myHeavyTask({bar: 'foo'}),
]);

console.log(results);
}

main();

关于 jest-worker 更多的信息可以查看 readme file

pretty-format

导出一个将任何 JavaScript 值转换为可读的字符串的函数。 天生就支持所有 JavaScript 类型,可以通过用户自定义插件来拓展针对特定应用的类型。

例子

const {format: prettyFormat} = require('pretty-format');

const val = {object: {}};
val.circularReference = val;
val[Symbol('foo')] = 'foo';
val.map = new Map([['prop', 'value']]);
val.array = [-0, Infinity, NaN];

console.log(prettyFormat(val));

关于 pretty-format 更多的信息可以查看 readme file