Skip to content

Commit

Permalink
docs: add note about lcov
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulRBerg committed Feb 24, 2025
1 parent cad9d58 commit c743189
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,19 +180,28 @@ Run the tests:
$ forge test
```

### Test Coverage

Generate test coverage and output result to the terminal:

```sh
$ bun run test:coverage
```

### Test Coverage Report

Generate test coverage with lcov report (you'll have to open the `./coverage/index.html` file in your browser, to do so
simply copy paste the path):

```sh
$ bun run test:coverage:report
```

> [!NOTE]
>
> This command requires you to have [`lcov`](https://github.com/linux-test-project/lcov) installed on your machine. On
> macOS, you can install it with Homebrew: `brew install lcov`.
## Related Efforts

- [foundry-rs/forge-template](https://github.com/foundry-rs/forge-template)
Expand Down

0 comments on commit c743189

Please sign in to comment.