# json-schema-mocker

> Never hardcode mock data again, generate it from schemas instead!

Latest version **1.1.0** (published 2019-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install json-schema-mocker
pnpm add json-schema-mocker
yarn add json-schema-mocker
bun add json-schema-mocker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-10-16 |
| First published | 2019-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marc Cataford |
| Maintainers | mcataford |
| Keywords | schema, mock, mock data, mocker, json schema, test, test data |

## Links

- npm: https://www.npmjs.com/package/json-schema-mocker
- Repository: https://github.com/mcataford/json-schema-mocker
- Homepage: https://github.com/mcataford/json-schema-mocker#readme
- Issues: https://github.com/mcataford/json-schema-mocker/issues
- npm.io page: https://npm.io/package/json-schema-mocker

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2019-10-16
- 0.0.0 — 2019-10-16

## README

# json-schema-mocker

## Overview & motivation

Hardcoding mock data is the devil's plaything. As your code evolves and grows, it's easy for its test suites to drift away from the real state of the your application. All it takes is forgetting to update your mock data alongside your schemas and suddenly, your tests are all invalid.

`json-schema-mocker` removes the need for hardcoded mock data by generating schema-compliant mock data on the fly based on your JSON Schema. This way, you can focus on what the mock data should __be like__ instead of __what it is__.

## Installing

```
yarn add json-schema-mocker -D
```

or

```
npm install json-schema-mocker --save-dev
```

## Usage

```
// Adjust the import for the fact that this isn't yet published on NPM.
import MockGenerator from 'json-schema-mocker'

describe('My cool testsuite', () => {
    const myGenerator = new MockGenerator()
    it('Even cooler testcase', () => {
        const mySchema = { ... }
        const myMockData = myGenerator.buildMock(mySchema)

        // Use your mock data knowing it matches your schema!
    })
})
```

## Feature roadmap

### Types

#### Numeric types

- [x] `type`
- [x] `maximum`
- [x] `minimum`
- [x] `multipleOf`
- [x] `exclusiveMinimum` (Extrema are always exclusive)
- [x] `exclusiveMaximum` (Extrema are always exclusive)

#### Object

- [x] `type`
- [x] `properties`
- [ ] `additionalProperties`
- [ ] `required`
- [ ] `propertyNames.pattern`
- [ ] `minProperties`
- [ ] `maxProperties`
- [ ] `dependencies`
- [ ] `patternProperties`

#### Array

- [x] `type`
- [x] `items`
- [x] `items` (tuple validation)
- [x] `minItems`
- [x] `maxItems`
- [ ] `uniqueItems`

#### Boolean

- [x] `type`

#### Null

- [x] `type`

#### String

- [x] `type`
- [ ] `pattern`
- [x] `maxLength`
- [x] `minLength`
- [ ] `format`

---
_Source: https://npm.io/package/json-schema-mocker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
