|
|
|
@ -71,8 +71,6 @@ testrpc is set to run on, e.g: |
|
|
|
|
+ **norpc**: {Boolean} When true, solidity-coverage will not launch its own testrpc instance. This |
|
|
|
|
can be useful if you are running tests using a different vm like the |
|
|
|
|
[`sc-forks` version of `pyethereum`](https://github.com/sc-forks/pyethereum). (Default: false). |
|
|
|
|
+ **isTruffle**: {Boolean}: Set to false if your project does not have a migrations folder or a |
|
|
|
|
`truffle.js` config file. |
|
|
|
|
+ **dir**: {String} : By default, solidity-coverage looks for a `contracts` folder in your root |
|
|
|
|
directory. `dir` allows you to define a relative path from the root directory to the contracts |
|
|
|
|
folder. A `dir` of `./secretDirectory` would tell solidity-coverage to look for `./secretDirectory/contracts` |
|
|
|
@ -116,10 +114,7 @@ your tests actually reach all the conditional branches in your code. It can be f |
|
|
|
|
|
|
|
|
|
**WARNING**: This utility is in development and its accuracy is unknown. If you |
|
|
|
|
find discrepancies between the coverage report and your suite's behavior, please open an |
|
|
|
|
[issue](https://github.com/sc-forks/solidity-coverage/issues). The purpose of |
|
|
|
|
the following examples is to help you install solidity-coverage in your own project and evaluate the |
|
|
|
|
coverage of your own tests. The reports below are **not** meaningful analyses of the |
|
|
|
|
the past or present state of any project's testing regime. |
|
|
|
|
[issue](https://github.com/sc-forks/solidity-coverage/issues). |
|
|
|
|
|
|
|
|
|
+ **metacoin**: The default truffle project |
|
|
|
|
+ [HTML reports](https://sc-forks.github.io/metacoin/) |
|
|
|
|