add package metadata - Githubissues

trajan0x commented 2 months ago

Description

add npm package metadata

Summary by CodeRabbit

New Features
- Added repository metadata to multiple packages, improving discoverability and integration with package management tools.
Bug Fixes
- Updated repository URLs to remove the .git suffix for clarity and consistency across various packages.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve the addition and modification of the "repository" field in the package.json files across multiple packages within the project. Each update specifies the type of repository as "git," provides the GitHub URL, and indicates the directory path for the respective package. These adjustments improve the metadata associated with each package, facilitating easier access to the source code repository.

Changes

File Path	Change Summary
`docs/bridge/package.json`	Added `"repository": { "type": "git", "url": "git+https://github.com/synapsecns/sanguine", "directory": "docs/bridge" }`
`packages/contracts-core/package.json`	Modified repository URL and added `"directory": "packages/contracts-core"` to the `repository` section.
`packages/contracts-rfq/package.json`	Added `"repository": { "type": "git", "url": "git+https://github.com/synapsecns/sanguine", "directory": "packages/contracts-rfq" }`
`packages/coverage-aggregator/package.json`	Added `"repository": { "type": "git", "url": "git+https://github.com/synapsecns/sanguine", "directory": "packages/coverage-aggregator" }`
`packages/explorer-ui/package.json`	Added `"repository": { "type": "git", "url": "git+https://github.com/synapsecns/sanguine", "directory": "packages/explorer-ui" }`
`packages/rest-api/package.json`	Added `"repository": { "type": "git", "url": "git+https://github.com/synapsecns/sanguine", "directory": "packages/rest-api" }`
`packages/sdk-router/package.json`	Modified repository URL and added `"directory": "packages/sdk-router"` to the `repository` section.
`packages/solidity-devops/package.json`	Modified repository URL and added `"directory": "packages/solidity-devops"` to the `repository` section.
`packages/synapse-constants/package.json`	Added `"repository": { "type": "git", "url": "git+https://github.com/synapsecns/sanguine", "directory": "packages/synapse-constants" }`
`packages/synapse-interface/package.json`	Added `"repository": { "type": "git", "url": "git+https://github.com/synapsecns/sanguine", "directory": "packages/synapse-interface" }`
`packages/widget/package.json`	Modified repository URL from `"git+https://github.com/synapsecns/sanguine.git"` to `"git+https://github.com/synapsecns/sanguine"` and added `"directory": "packages/widget"`

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PackageManager
    participant GitHub

    User->>PackageManager: Request package metadata
    PackageManager->>GitHub: Fetch repository information
    GitHub-->>PackageManager: Return repository details
    PackageManager-->>User: Provide package metadata with repository info

🐇 "In the code, a hop and a skip,
New paths for packages, a joyful trip.
With GitHub links shining bright,
Metadata now feels just right!
A rabbit's cheer for each new line,
Hop along, all will be fine!" 🐇

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `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 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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

Early access features: enabled

We are currently testing the following features in early access: - **OpenAI `o1` for code reviews**: OpenAI's new o1 model is being tested for generating code suggestions in code reviews. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 41.35997%. Comparing base (377a7fa) to head (2656bb6). Report is 143 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3140 +/- ## =================================================== + Coverage 38.23421% 41.35997% +3.12575% =================================================== Files 423 459 +36 Lines 24363 25677 +1314 Branches 119 330 +211 =================================================== + Hits 9315 10620 +1305 - Misses 14309 14318 +9 Partials 739 739 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3140/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/3140/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `91.15914% <ø> (+0.19646%)` | :arrow_up: | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3140/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `98.26990% <ø> (+8.95692%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.