diff options
| author | Leonid Logvinov <logvinov.leon@gmail.com> | 2019-01-18 02:47:24 +0800 |
|---|---|---|
| committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2019-01-18 02:59:35 +0800 |
| commit | 1c9fb5f65f86d5df3eb3db26032f91451fc87e1b (patch) | |
| tree | 2bea10af5986125101d86c9ad87a4deecb35a9e9 | |
| parent | 5816279d68a2926025d54d007f04020052c46e9b (diff) | |
| download | dexon-sol-tools-1c9fb5f65f86d5df3eb3db26032f91451fc87e1b.tar.gz dexon-sol-tools-1c9fb5f65f86d5df3eb3db26032f91451fc87e1b.tar.zst dexon-sol-tools-1c9fb5f65f86d5df3eb3db26032f91451fc87e1b.zip | |
Add notes about istanbul and Geth to website docs
| -rw-r--r-- | packages/website/md/docs/sol_coverage/usage.md | 8 | ||||
| -rw-r--r-- | packages/website/md/docs/sol_profiler/usage.md | 8 | ||||
| -rw-r--r-- | packages/website/md/docs/sol_trace/usage.md | 2 |
3 files changed, 18 insertions, 0 deletions
diff --git a/packages/website/md/docs/sol_coverage/usage.md b/packages/website/md/docs/sol_coverage/usage.md index 9f9913d28..d194f8abd 100644 --- a/packages/website/md/docs/sol_coverage/usage.md +++ b/packages/website/md/docs/sol_coverage/usage.md @@ -64,3 +64,11 @@ await coverageSubprovider.writeCoverageAsync(); ``` This will create a `coverage.json` file in a `coverage` directory. This file has an [Istanbul format](https://github.com/gotwarlost/istanbul/blob/master/coverage.json.md) - so you can use it with any of the existing Istanbul reporters. + +```bash +yarn add -D istanbul +istanbul report html +open coverage/index.html +``` + +Use [Geth](https://github.com/ethereum/go-ethereum) as a backing node. We recommend using our [Devnet Docker container](https://hub.docker.com/r/0xorg/devnet) which sets up a Geth node for testing purposes. Ganache support is a [work in progress](https://github.com/0xProject/0x-monorepo/issues/1520). diff --git a/packages/website/md/docs/sol_profiler/usage.md b/packages/website/md/docs/sol_profiler/usage.md index f9bab7ebf..0fbc31bc1 100644 --- a/packages/website/md/docs/sol_profiler/usage.md +++ b/packages/website/md/docs/sol_profiler/usage.md @@ -64,3 +64,11 @@ await profilerSubprovider.writeProfilerOutputAsync(); ``` This will create a `coverage.json` file in a `coverage` directory. This file has an [Istanbul format](https://github.com/gotwarlost/istanbul/blob/master/profiler.json.md) - so you can use it with any of the existing Istanbul reporters. + +```bash +yarn add -D istanbul +istanbul report html +open coverage/index.html +``` + +Use [Geth](https://github.com/ethereum/go-ethereum) as a backing node. We recommend using our [Devnet Docker container](https://hub.docker.com/r/0xorg/devnet) which sets up a Geth node for testing purposes. Ganache support is a [work in progress](https://github.com/0xProject/0x-monorepo/issues/1520). diff --git a/packages/website/md/docs/sol_trace/usage.md b/packages/website/md/docs/sol_trace/usage.md index e794d0f73..d117a0faf 100644 --- a/packages/website/md/docs/sol_trace/usage.md +++ b/packages/website/md/docs/sol_trace/usage.md @@ -58,3 +58,5 @@ provider.start(); ``` Now when you run your tests, it should print out stack traces when encountering an error. + +Use [Geth](https://github.com/ethereum/go-ethereum) as a backing node. We recommend using our [Devnet Docker container](https://hub.docker.com/r/0xorg/devnet) which sets up a Geth node for testing purposes. Ganache support is a [work in progress](https://github.com/0xProject/0x-monorepo/issues/1520). |