aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-cov/README.md
blob: 466595f4e54e5a4f2a8ba7a887172f5ecec23b3b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
## @0xproject/sol-cov

A Solidity code coverage tool.

### Read the [Documentation](0xproject.com/docs/sol-cov).

## Installation

```bash
npm install @0xproject/sol-cov --save
```

**Import**

```javascript
import { CoverageSubprovider } from '@0xproject/sol-cov';
```

or

```javascript
var CoverageSubprovider = require('@0xproject/sol-cov').CoverageSubprovider;
```

## Contributing

We strongly encourage the community to help us make improvements. 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
```

### Lint

```bash
yarn lint
```