Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

jest-test-gen

egm01211.5kMIT1.4.3TypeScript support: included

Generator of jest unit test with all imports mocked and tests stub for every class and function exported

jest, unit test generator, test generator, mocks, testing, jest generator, es6 classes, functions, export parsing, typescript, tsx

readme

JestTestGen

badgenpm badgenpm

🚀 Try jest-test-gen as a VS Code Extension

The VS Code extension is the fastest way to generate a unit test file from a source file directly from the IDE

Install jest-test-gen Extension

About

Automates creation of initial unit test files taking dependencies into account.

Parsing and test generation is avaialable for the following exports:

  • Typescript typed React class components 🆕
  • Typescript typed Functional components 🆕
  • React Functional components 🆕
  • React Class based components 🆕
  • ES6 Classes default export or named exports
  • Exported named functions and arrow functions
  • Exported POJOs with methods
  • Async functions and methods

This tool will take a js/ts file as input and generate a jest unit test file next to it with all imports mocked and tests stubs for every class method and function exported.

This project is inspired and started as a fork of jasmine-unit-test-generator

Preview

Basic ES6 Class example:

Basic

React Component example:

ReactComponent

Usage

Installation

run npm i -g jest-test-gen

Basic Usage

run jest-test-gen <path-to-file>

Development

It's probably best to:

  • add an input file in spec/fixtures folder test.js
  • add a snapshot test for the input spec in integration.spec.ts
  • verify that the snapshot is actually the wanted test output before commiting the updated snapshot.

Alternavely, you can:

  • run npm link
  • run npm run build:dev
  • run jest-test-gen <option> in your project of choice

Release

run npm run build run npm publish

changelog

Changelog

v1.4.2

  • 15 add support for export as syntax

    Thanks @yiminghe

v1.4.2

  • 14 fix non arrow function assignement expression parsing Thanks @yiminghe

v1.4.0

  • 6 add an option --fileSuffix to specify a custom generated file name suffix Thanks @eliorivero

v1.3.2

  • return test output filename from run() function

v1.3.0

  • 2 support for ts and tsx components with prop types parsing

  • 5 add an option --outputDir to specify a custom output directory relative to the cwd() or absolute path

v1.1.0

  • 3 Support for static methods in classes

  • 4 .toBeDefined instead of (or in addition to) .toBeTruthy

  • 6 migrate tests from jasmine to Jest, makes a lot of sense for this project

v1.0.0

  • Adds support for parsing React class + functional components to generate snapshot test

v0.0.6

  • more output format tweaks

v0.0.5

  • enhancements to output format

v0.0.4

  • Fixes to output format
  • added debug for logging in dev

v0.0.3

list typescript as dependency

v0.0.2

Update docs

v0.0.1

Initial release