jest-codemods

Codemods for migrating test files to Jest

jest-codemods 👾

Codemods that simplify migrating JavaScript and TypeScript test files from AVA, Chai, Expect.js (by Automattic), Expect@1.x (by mjackson), Jasmine, Mocha, proxyquire, Should.js and Tape to Jest.

Codemods are small programs that help you automate changes to your codebase. Think of them as search and replace on steroids.

We made jest-codemods so you can try out Jest on your existing codebase. We strive to make the migration as smooth as possible, but some manual intervention and tweaks to your tests are to be expected.

Usage (CLI)

To use the interactive CLI run

$ npx jest-codemods

If you do not have npx installed, you can install the jest-codemods command globally by running npm install -g jest-codemods.

For more options

$ npx jest-codemods --help

    Usage:      npx jest-codemods <path> [options]

    Examples:   npx jest-codemods src
                npx jest-codemods src/**/*.test.js

    Options:
      -f, --force       Bypass Git safety checks and force codemods to run
      -d, --dry         Dry run (no changes are made to files)

To transform all test files in a directory run jest-codemods . in your terminal.

Notice the console output for errors, manual intervention and tweaks might be required.

Usage (jscodeshift)

To make the process as simple as possible, we recommend the jest-codemods CLI that wraps the jscodeshift executable. But you can also run the transformations directly using jscodeshift.

$ npm install -g jscodeshift
$ npm install jest-codemods
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/ava.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/chai-assert.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/chai-should.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/expect-js.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/expect.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/jasmine-globals.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/jasmine-this.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/mocha.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/should.js test-folder
$ jscodeshift -t node_modules/jest-codemods/dist/transformers/tape.js test-folder

Test environment: Jest on Node.js or other

If you're using Jest as your test runner and executing tests on Node.js, you'll want to use the default option when prompted. In this case, jest-codemods assumes that global values such as expect and jest are provided and will not require() them explicitly.

If, however, you are using a different test runner or executing Jest tests in a browser, you may need to choose the option with explicit require() calls.

In the second case, after running jest-codemods, you might need to install a few dependencies:

yarn add --dev expect jest-mock

npm install --save-dev expect jest-mock

Transformations

If possible import / require statements determine if any transformation are carried out. The original code quoting style is preserved. Warnings are made if packages are used that are incompatible with Jest.

Inspiration

Thanks to avajs/ava-codemods for inspiration and original CLI setup.

The Mocha and Chai assert support began its life at paularmstrong/mocha-to-jest-codemod.

Chai Should/Expect came from AlexJuarez/chai-to-jasmine.

Links

Contributing

To get started, run:

yarn

When developing:

yarn verify  # (build/lint/test)
yarn build
yarn lint
yarn test
yarn test:cov
yarn test:watch

License

MIT

Repository

skovhus/jest-codemods


上一篇:is-git-clean
下一篇:cool-path

相关推荐

  • 顶级测试框架Jest指南:跑通一个完美的程序,就是教出一群像样的学生

    facebook三大项目:yarn jest metro,有横扫宇宙之势。 这个项目的宗旨为:减少测试一个项目所花费的时间成本和认知成本。 ——其实,它在让你当一个好老师。

    2 年前
  • 详解如何在项目中使用jest测试react nati

    目前Javascript的测试工具很多,但是针对React的测试策略,Facebook推出的ReactJs标配测试工具是Jest.Jest的官网地址:https://facebook.github.i...

    3 年前
  • 自动化测试工具Jest的使用(持续更新)

    入门 官方文档 安装 npm init -y npm i @babel/core @babel/preset-env jest@24.8.0 -D配置 //添加.babelrc { ...

    7 个月前
  • 第十二集: 从零开始实现一套pc端vue的ui组件库( jest单元测试 )

    第十二集: 从零开始实现( jest单元测试 ) 1.聊聊测试     本次我会与大家分享一下我学测试时候记的笔记知识以及本次项目里面做的几个测试. 前端代码的单元测试与集成测试属于雷声大雨点小, 很...

    1 年前
  • 用 Jest 进行 JavaScript 测试(2019)

    作者:Valentino Gagliardi 翻译:疯狂的技术宅 原文:https://www.valentinog.com/bl... 未经允许严禁转载 测试是什么意思? 在技​​术术语中测试意...

    1 年前
  • 用 Jest 和 Enzyme 测试 React I

    原文地址: medium.com/codeclan/te… 译文地址:github.com/xiao-T/note… 本文版权归原作者所有,翻译仅用于学习。 这篇文章将会介绍如何设置并使用 J...

    5 个月前
  • 提高代码质量——使用Jest和Sinon给已有的代码添加单元测试

    概述 在日常的功能开发中,我们的代码测试都依赖于自己或者QA进行测试。这些操作不仅费时费力,而且还依赖开发者自身的驱动。在开发一些第三方依赖的库时,我们也没有办法给第三方提供完整的代码质量报告。

    2 年前
  • 在 ts + Jest 单元测试中 debugging

    1、背景 代码是 TS 写的 所测功能无 UI 界面,且出现 bug 初步定位到是循环体内部问题,功能较为复杂 用 console 式 debug 效率太低,需要打断点式调试 在 Jest 单测中...

    1 年前
  • 在 Angular 中引入 Jest 进行单元测试

    为什么要从 Karma 迁移到 Jest 用 Karma 在项目中遇到了坑 最近新换了一个项目,去的时候项目已经做了两个月了,因为前期赶功能,没有对单元测试做要求,CI/CD 的时候也没有强制跑单元测...

    2 年前
  • 单元测试与单元测试框架 Jest

    什么是单元测试? 测试是一种验证我们的代码是否可以按预期工作的手段。 被测试的对象可以是我们程序的任何一个组成部分。大到一个分为多步骤的下单流程,小到代码中的一个函数。

    2 年前

官方社区

扫码加入 JavaScript 社区