Use flags for coverage at the package level

[rajivpo]

Description

• Use of nyc which is a wrapper around mocha for coverage
• use of flags for codecov to enable package-level coverage badges and reporting

Additional context
Future pull requests will serve to actually improve coverage of the typescript packages.

Metadata

• Cleaner version of Add coverage to packages beyond contracts #1297

[changeset-bot]

🦋 Changeset detected

Latest commit: 21b17ed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@eth-optimism/batch-submitter	Patch
@eth-optimism/core-utils	Patch
@eth-optimism/data-transport-layer	Patch
@eth-optimism/message-relayer	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[codecov-commenter]

Codecov Report

Merging #1412 (21b17ed) into develop (1f1fff9) will decrease coverage by 10.15%.
The diff coverage is 83.75%.

@@             Coverage Diff              @@
##           develop    #1412       +/-   ##
============================================
- Coverage    86.05%   75.90%   -10.16%     
============================================
  Files           49       81       +32     
  Lines         1936     3017     +1081     
  Branches       307      463      +156     
============================================
+ Hits          1666     2290      +624     
- Misses         270      727      +457     

Flag	Coverage Δ
batch-submitter	60.91% <87.83%> (?)
contracts	86.05% <100.00%> (?)
core-utils	61.22% <0.00%> (?)
data-transport-layer	37.86% <ø> (?)
message-relayer	72.22% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...thereum/OVM/predeploys/OVM_L2ToL1MessagePasser.sol	100.00% <ø> (ø)
packages/core-utils/src/watcher.ts	4.00% <0.00%> (ø)
...ubmitter/src/batch-submitter/tx-batch-submitter.ts	44.29% <57.14%> (ø)
...ackages/batch-submitter/src/utils/tx-submission.ts	88.46% <88.46%> (ø)
...h-submitter/src/batch-submitter/batch-submitter.ts	83.15% <100.00%> (ø)
...itter/src/batch-submitter/state-batch-submitter.ts	73.68% <100.00%> (ø)
packages/batch-submitter/src/index.ts	100.00% <100.00%> (ø)
.../batch-submitter/src/transaction-chain-contract.ts	81.81% <100.00%> (ø)
packages/batch-submitter/src/utils/index.ts	100.00% <100.00%> (ø)
...c-ethereum/libraries/standards/L2StandardERC20.sol	100.00% <100.00%> (ø)
... and 32 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0f13375...21b17ed. Read the comment docs.

[rajivpo]

It appears that codecov isn't pushing the update despite the github action being completed (https://codecov.io/gh/ethereum-optimism/optimism/commit/64b6f5481c9be1391ad12db41f92d4a01079fde6/graphs). Pushed a changeset commit to see if a re-run will help.

[rajivpo]

So looks like it's getting all the relevant coverage, but failing to post some of it via the github codecov-commenter user

[rajivpo]

As per this url, it should show the badges as per the coverage on master in the readme, but it doesn't quite exist yet. If it would be helpful, I can change this branch for the time being so results in are viewable in the READMEs of this PR

[tynes]

So looks like it's getting all the relevant coverage, but failing to post some of it via the github codecov-commenter user

Its possible this isn't happening because of github permissions, sometimes there are issues with PRs coming in from people outside of the org

[tynes]

Thank you for this work!

[tynes]

If you squash this into a single commit, this is good to merge

[rajivpo]

awesome sounds good