https://github.com/offen/schemaify

Browserify transform for compiling JSON schemas at build time using AJV
https://github.com/offen/schemaify

ajv browserify-transform json-schema

Last synced: 4 days ago
JSON representation

Browserify transform for compiling JSON schemas at build time using AJV

• Host: GitHub
• URL: https://github.com/offen/schemaify
• Owner: offen
• License: mit
• Created: 2020-07-16T13:32:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-24T20:09:56.000Z (9 months ago)
• Last Synced: 2024-05-01T09:46:07.228Z (7 months ago)
• Topics: ajv, browserify-transform, json-schema
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# schemaify

Browserify transform for compiling JSON schemas at build time using AJV and `ajv-pack`

## Installation

The package is released to npm as `@offen/schemaify`:

```

npm install @offen/schemaify -D

```

## Usage

In the default configuration, the transform is applied to all files with a `.schema` extension. The transformed module will export the packed AJV `validate` function.

In your application:

```js

var validateFoo = require('./foo.schema')

var ok = validateFoo({ foo: true })

if (!ok) {

  console.log(validateFoo.errors)

  throw new Error('Foo did not validate')

}

```

When bundling:

```js

var browserify = require('browserify')

var b = browserify()

b.add('app.js')

b.transform('@offen/schemaify')

b.bundle(function (err, src) {

  // consume bundle

})

```

### Defining schemas

Schemas are expected to be defined in JSON format and saved as `.schema` files:

```json

{

  "type": "string",

  "maxLength": 128

}

```

## Options

The transform accepts the following options as its 2nd arguments:

### `secure`

By default, `schemaify` only compiles ["secure" schemas][secure]. This can be disabled by passing `secure: false` to the transform.

[secure]: https://github.com/ajv-validator/ajv/tree/521c3a53f15f5502fb4a734194932535d311267c#security-considerations

### `matcher`

By default, `schemaify` only compiles files with a `.schema` extension. If you have different requirements you can pass a Regexp string to `matcher` for the transform to use.

**Important caveat**: Due to the way that Browserify handles JSON files, you currently __cannot use `.json` files__ for storing your schemas, as this would make these files subject to another set of rules that would conflict with.

## Releasing a new version

New versions can be released using `npm version `. Make sure you are authenticated against the `@offen` scope with npm.

## License

Copyright 2020 Frederik Ring - Available under the MIT License