4689f20b86
* Move zero_ex.json_schemas to its own package * Support ALL the schemas * Stop installing packages as editable * HACK: cp files because CircleCI isn't * Add example usage to sra_client README * Tweak special case: only strip Schema as suffix * Correct doc titles * Clarify what kind of support ticket was raised. * Correct inconsistencies in JSON schema names In both ref ID's and file names. * Add entry point for validation of JSON strings
@0x/json-schemas
Contains 0x-related json schemas
Read the Documentation.
Installation
yarn add @0x/json-schemas
Import
import { SchemaValidator, ValidatorResult, schemas } from '@0x/json-schemas';
or
var schemas = require('@0x/json-schemas').schemas;
If your project is in TypeScript, add the following to your tsconfig.json:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
Contributing
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
Please read our contribution guidelines before getting started.
Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/json-schemas yarn build
Or continuously rebuild on change:
PKG=@0x/json-schemas yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test