@0x/json-schemas 中文文档教程
@0x/json-schemas
包含与 0x 相关的 json 模式
Read the Documentation.
Installation
yarn add @0x/json-schemas
导入
import { SchemaValidator, ValidatorResult, schemas } from '@0x/json-schemas';
或者
var schemas = require('@0x/json-schemas').schemas;
如果您的项目使用 TypeScript,请将以下内容添加到您的 tsconfig.json
:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
Contributing
我们欢迎来自更广泛社区的改进和修复! 要报告此包中的错误,请在此存储库中创建一个问题。
请在开始之前阅读我们的贡献指南。
Install dependencies
如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们:
yarn config set workspaces-experimental true
然后安装依赖
yarn install
Build
项 要构建此包和它所依赖的所有其他 monorepo 包,请从 monorepo 根目录运行以下命令:
PKG=@0x/json-schemas yarn build
或持续重建关于改变:
PKG=@0x/json-schemas yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
@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