Instrument SDK (and CLI?) code coverage (on codecov) in CI tests - Githubissues

hyperlane-xyz / hyperlane-monorepo

The home for Hyperlane core contracts, sdk packages, and other infrastructure

https://hyperlane.xyz

Other

295 stars 322 forks source link

Instrument SDK (and CLI?) code coverage (on codecov) in CI tests #3299

Open yorhodes opened 7 months ago

yorhodes commented 7 months ago

Problem

Codecov currently only tracks the solidity smart contract code. We would like to track the coverage of the other packages.

Solution

We should use istanbul to instrument javascript tests across the SDK and CLI packages. Codecov should track the coverage of the instrumented tests.

Nice to Have

[ ] Add a badge to the README of the SDK and CLI packages to show the coverage percentage.
[ ] Instrument the CLI e2e tests somehow? (I'm not sure if this is possible)

Check out

https://docs.codecov.com/docs/javascript-bundle-analysis

yorhodes commented 5 months ago

https://yargs.js.org/2016/02/13/yargs-4.html I see mention of reporter config here