blob: 0a63ac06ece7fce65f1cd6c02073beb7cab22e41 (
plain) (
tree)
|
|
## @0xproject/sol-cov
A Solidity code coverage tool.
### Read the [Documentation](https://0xproject.com/docs/sol-cov).
## Installation
```bash
yarn add @0xproject/sol-cov
```
**Import**
```javascript
import { CoverageSubprovider } from '@0xproject/sol-cov';
```
or
```javascript
var CoverageSubprovider = require('@0xproject/sol-cov').CoverageSubprovider;
```
## 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](../../CONTRIBUTING.md) before getting started.
### Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
```bash
PKG=@0xproject/sol-cov yarn build
```
Or continuously rebuild on change:
```bash
PKG=@0xproject/sol-cov yarn watch
```
### Clean
```bash
yarn clean
```
### Lint
```bash
yarn lint
```
### Run Tests
```bash
yarn test
```
|
