@0x/dev-utils 中文文档教程
Dev utils
Dev utils 在 0x 项目和包之间共享
Configuration
一些环境变量可能被设置为改变创建的 web3 提供者/实例的行为。
VERBOSE_GANACHE: boolean. Enables verbose Ganache logging. Every request/response payload. Slightly slower, but useful for testing.
SOLIDITY_COVERAGE: boolean. If set - adds coverage subprovider which intercepts all calls/transactions and can be later used to compute code coverage.
布尔环境变量应为 true
或 false
。 如果未设置,则默认为 false
。
Install
yarn add @0x/dev-utils
如果您的项目在 TypeScript 中,请将以下内容添加到您的 tsconfig.json
:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
Troubleshooting
如果您仍然看到 TS类型错误抱怨缺少 DOM 类型,例如 Response
:
error TS2304: Cannot find name 'Response'.
然后您需要将 dom
库显式添加到 tsconfig.json
中的编译器选项。 默认包含 dom
库,但自定义 lib
选项可能会导致它被删除。
"compilerOptions": {
"lib": [..., "dom"],
Contributing
我们欢迎来自更广泛社区的改进和修复! 要报告此包中的错误,请在此存储库中创建一个问题。
请在开始之前阅读我们的贡献指南。
Install dependencies
如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们:
yarn config set workspaces-experimental true
然后安装依赖
yarn install
Build
项 要构建此包和它所依赖的所有其他 monorepo 包,请从 monorepo 根目录运行以下命令:
PKG=@0x/dev-utils yarn build
或持续重建关于改变:
PKG=@0x/dev-utils yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
Dev utils
Dev utils to be shared across 0x projects and packages
Configuration
Some env variables might be set to change the behaviour of created web3 providers/instances.
VERBOSE_GANACHE: boolean. Enables verbose Ganache logging. Every request/response payload. Slightly slower, but useful for testing.
SOLIDITY_COVERAGE: boolean. If set - adds coverage subprovider which intercepts all calls/transactions and can be later used to compute code coverage.
Boolean env variables should be either true
or false
. Defaults to false
if not set.
Install
yarn add @0x/dev-utils
If your project is in TypeScript, add the following to your tsconfig.json
:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
Troubleshooting
If you are still seeing TS type errors complaining about missing DOM types such as Response
:
error TS2304: Cannot find name 'Response'.
Then you need to explicitly add the dom
lib to your compiler options in tsconfig.json
. The dom
library is included by default, but customizing the lib
option can cause it to be dropped.
"compilerOptions": {
"lib": [..., "dom"],
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/dev-utils yarn build
Or continuously rebuild on change:
PKG=@0x/dev-utils yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test