https://github.com/form8ion/jest-scaffolder
opinionated scaffolder for Jest
https://github.com/form8ion/jest-scaffolder
Last synced: about 2 months ago
JSON representation
opinionated scaffolder for Jest
- Host: GitHub
- URL: https://github.com/form8ion/jest-scaffolder
- Owner: form8ion
- License: mit
- Created: 2020-05-27T06:07:15.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T17:32:18.000Z (about 2 months ago)
- Last Synced: 2025-05-06T18:40:06.220Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://npm.im/@form8ion/jest-scaffolder
- Size: 10.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - jest-scaffolder
README
# jest-scaffolder
opinionated scaffolder for [Jest](https://jestjs.io)
[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
![SLSA Level 2][slsa-badge]
[![Codecov][coverage-badge]][coverage-link]
[![OpenSSF Scorecard][ossfScorecard-badge]][ossfScorecard-link]
## Table of Contents
* [Usage](#usage)
* [Installation](#installation)
* [Features](#features)
* [Example](#example)
* [Import](#import)
* [Execute](#execute)
* [Contributing](#contributing)
* [Dependencies](#dependencies)
* [Verification](#verification)
## Usage
[![MIT license][license-badge]][license-link]
[![npm][npm-badge]][npm-link]
[![Try @form8ion/jest-scaffolder on RunKit][runkit-badge]][runkit-link]
![node][node-badge]
### Installation
```sh
$ npm install @form8ion/jest-scaffolder --save-prod
```
### Features
* Includes [jest-when](https://www.npmjs.com/package/jest-when) since the mocks
built into [Jest](https://jestjs.io) [do not enable conditional returns](https://github.com/facebook/jest/issues/6180)
and can encourage behavior that relies on side effects
### Example
#### Import
```javascript
import {scaffold} from '@form8ion/jest-scaffolder';
```
#### Execute
```javascript
(async function example() {
await scaffold({projectRoot: process.cwd()});
}());
```
## Contributing
[![PRs Welcome][PRs-badge]][PRs-link]
[![Conventional Commits][commit-convention-badge]][commit-convention-link]
[![Commitizen friendly][commitizen-badge]][commitizen-link]
[![semantic-release][semantic-release-badge]][semantic-release-link]
[![Renovate][renovate-badge]][renovate-link]
### Dependencies
```sh
$ nvm install
$ npm install
```
### Verification
```sh
$ npm test
```
[PRs-link]: http://makeapullrequest.com
[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[commit-convention-link]: https://conventionalcommits.org
[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
[commitizen-link]: http://commitizen.github.io/cz-cli/
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[semantic-release-link]: https://github.com/semantic-release/semantic-release
[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release
[renovate-link]: https://renovatebot.com
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
[license-link]: LICENSE
[license-badge]: https://img.shields.io/github/license/form8ion/jest-scaffolder.svg?logo=opensourceinitiative
[npm-link]: https://www.npmjs.com/package/@form8ion/jest-scaffolder
[npm-badge]: https://img.shields.io/npm/v/@form8ion/jest-scaffolder?logo=npm
[runkit-link]: https://npm.runkit.com/@form8ion/jest-scaffolder
[runkit-badge]: https://badge.runkitcdn.com/@form8ion/jest-scaffolder.svg
[github-actions-ci-link]: https://github.com/form8ion/jest-scaffolder/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
[github-actions-ci-badge]: https://img.shields.io/github/actions/workflow/status/form8ion/jest-scaffolder/node-ci.yml.svg?branch=master&logo=github
[slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg
[coverage-link]: https://codecov.io/github/form8ion/jest-scaffolder
[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/jest-scaffolder?logo=codecov
[ossfScorecard-link]: https://securityscorecards.dev/viewer/?uri=github.com/form8ion/jest-scaffolder
[ossfScorecard-badge]: https://api.securityscorecards.dev/projects/github.com/form8ion/jest-scaffolder/badge
[node-badge]: https://img.shields.io/node/v/@form8ion/jest-scaffolder?logo=node.js