You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 5, 2024. It is now read-only.
An opinionated Jest matcher that generates, validates, and versions JSON Schemas for your APIs.
🚀 Quick start
Add dependency
yarn add --dev jest-schema-matcher
Set global variable SHOULD_UPDATE_SCHEMAS in your jest's global config
// jest.config.jsmodule.exports={
...
globals: {SHOULD_UPDATE_SCHEMAS: true,// If true, schemas will be written/updated}}
Add the matcher to your tests
test('Check against schema',()=>{constobject={username: 'test_user_a124',password: 'fixtures_password',}expect(object).toMatchSchema('schemaName')/** * 1. If SHOULD_UPDATE_SCHEMAS === true: * Will create a new schema or update existing schema in same path as test file. * E.g. If test path is `.../__tests__/sample.tests.js` * Then schema will be created in `.../__tests__/schemas/schemaName.json` * --or-- * If SHOULD_UPDATE_SCHEMAS === false: * Will infer a new schema and recommend schema changes if the saved schema could be improved. *//** 2. Will validate `object` against saved schema.*/})
About
An opinionated Jest matcher that generates strict JSON schemas as it validates objects.