chore: add yarn coverage to generate coverage report

[lumtis]

All in the PR title

yarn coverage

Summary by CodeRabbit

• New Features

  • Added code coverage functionality to the project build process.

• Chores

  • Updated .gitignore to exclude coverage-related files.
  • Enhanced build and test scripts in package.json for improved testing and coverage reporting.

[skosito]

just 2 small comments

[coderabbitai]

Walkthrough

The recent updates enhance code coverage reporting and streamline testing in the Hardhat project. By incorporating the solidity-coverage package into the configuration and build scripts, the project can now generate detailed coverage reports. Additionally, type handling for mainnet and testnet data is improved. These changes bolster testing capabilities without altering the public interface.

Changes

File	Change Summary
.gitignore	Added entries for coverage folder and coverage.json.
hardhat.config.ts	Imported the solidity-coverage package to enable code coverage functionality.
package.json	Updated build script to include npx hardhat coverage; modified test script to directly use npx hardhat test.
scripts/generate_addresses_types.ts	Ensured mainnet and testnet data are properly typed as arrays before merging.

Poem

Amidst the lines of code, so bright,
A rabbit hops with pure delight,
Coverage now, it leaps and bounds,
With every test, true code resounds.
No data lost, in types we trust,
Our blockchain dreams escape the dust.
🐇✨🚀

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

scripts/generate_addresses_types.ts (1)

Line range hint 21-21: Replace isNaN with Number.isNaN for more reliable type checks.

The current use of isNaN might lead to unintended type coercions. Using Number.isNaN ensures that the value being checked is of type number, providing more reliable checks.

- const isNumeric = uniqueValues.every((value) => !isNaN(Number(value)));
+ const isNumeric = uniqueValues.every((value) => !Number.isNaN(Number(value)));

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c485353 and d90e9f7.

Files selected for processing (4)

• .gitignore (1 hunks)
• hardhat.config.ts (1 hunks)
• package.json (1 hunks)
• scripts/generate_addresses_types.ts (1 hunks)

Files skipped from review due to trivial changes (2)

• .gitignore
• hardhat.config.ts

Additional context used

Path-based instructions (1)

scripts/generate_addresses_types.ts (1)

Pattern scripts/**: Review the scripts for best practices.

Biome

scripts/generate_addresses_types.ts

[error] 21-21: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead. (lint/suspicious/noGlobalIsNan)

See the MDN documentation for more details.
Unsafe fix: Use Number.isNaN instead.

Additional comments not posted (2)

package.json (2)

79-79: Good addition of the coverage script.

This script enhances the developer's ability to generate and view coverage reports, aligning with the PR's objectives to improve code quality monitoring.

---

86-86: Simplified test script is a good improvement.

Directly using npx hardhat test simplifies the testing process and aligns with modern best practices for script simplicity and directness.