开始上手
使用 yarn 安装 Jest︰
或使用 :
注意:Jest 的文档统一使用 yarn
命令,不过您也可以使用 npm
。 您可以在此处的 Yarn 文档了解 yarn
与npm
之间的差异。
举个例子,我们先写一个两数相加的函数。 首先,创建 sum.js
文件︰
function sum(a, b) {
return a + b;
}
module.exports = sum;
然后,创建名为 sum.test.js
的文件。 此文件中将包含我们的实际测试︰
const sum = require('./sum');
test('adds 1 + 2 to equal 3', () => {
});
随后,将下列配置内容添加到您的 package.json
:
{
"scripts": {
"test": "jest"
}
}
最后,运行 yarn test
或 npm run test
,测试后 Jest 将打印以下信息:
您刚刚完成了您的首个 Jest 测试!
此测试使用 expect
和 toBe
来测试两值是否一致。 要了解 Jest 能进行的更多测试,请参阅章节。
你可以通过命令行直接运行Jest(前提是jest已经处于你的环境变量 PATH
中,例如通过 yarn global add jest
或 npm install jest --global
安装的Jest) ,并为其指定各种有用的配置项。
jest my-test --notify --config=config.json
如果你愿意了解更多关于通过命令行运行 jest
的内容,请继续阅读 Jest CLI 选项 页面。
更多配置
基于您的项目,Jest将向您提出几个问题,并将创建一个基本的配置文件,每个选项都有一个简短的说明:
jest --init
如果需要使用 Babel,可以通过 yarn
来安装所需的依赖。
yarn add --dev babel-jest @babel/core @babel/preset-env
可以在工程的根目录下创建一个babel.config.js
文件用于配置与你当前Node版本兼容的Babel:
babel.config.js
module.exports = {
presets: [['@babel/preset-env', {targets: {node: 'current'}}]],
};
Babel的配置取决于具体的项目使用场景 ,可以查阅 来获取更多详细的信息。
**Jest与Babel的协同**
若 process.env.NODE_ENV
未设置,Jest将把它设置为 'test'
。你可以用 if
语句设置Jest执行的编译配置。例如:
babel.config.js
module.exports = {
transform: {},
};
**Babel 6 支持**
Jest放弃了对Babel 6的支持。我们强烈建议你升级至拥有丰富生态的Babel 7。然而,若你不想升级至Babel 7,保持使用jest@23抑或使用jest@24 + babel-jest@23,展示如下:
"babel-core": "^6.26.3",
"babel-jest": "^23.6.0",
"babel-preset-env": "^1.7.0",
"jest": "^24.0.0"
}
我们通常建议你使用相同版本的各个Jest模块,但你也可以使用上述的Babel6并锁定版本的方式。
Jest 可以用于使用 webpack 来管理资源、 样式和编译的项目中。 webpack 与其他工具相比多了一些独特的挑战。 参考 来开始起步。
Parcel是一个类似于Webpack的零配置管理资源及样式的构建工具。Jest可以在Parcel构建的项目中使用。可以去Parcel官网 尝试一下。 Refer to the official to get started.
Jest可以通过Babel支持TypeScript。 首先,在项目中正确的使用Babel。 其次,使用Yarn或者Npm安装 @babel/preset-typescript
yarn add --dev @babel/preset-typescript
你需要添加@babel/preset-typescript
的预设到babel.config.js
.
babel.config.js
module.exports = {
presets: [
['@babel/preset-env', {targets: {node: 'current'}}],
'@babel/preset-typescript',
],
};
不过,在配合使用TypeScript与Babel时,仍然有一些 。 因为Babel对Typescrip的支持是纯编译形式(无类型校验),因此Jest在运行测试时不会对它们进行类型检查。 如果需要类型校验,可以改用ts-jest,也可以单独运行TypeScript编译器 (或作为构建过程的一部分)。
您可能还想为所使用的Jest版本安装@ types / jest模块。 使用TypeScript编写测试时,这将有助于提供完整的键入内容。