synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

chore: solidity vscode settings #3145

Closed ChiTimesChi closed 2 months ago

ChiTimesChi commented 2 months ago

Description Adds a reasonable minimum set of settings for Solidity extension within VSCode and its forks.

Reasoning behind having settings files in the monorepo as well as in the packages: it's more convenient to use the package directory as workspace, when the changes are limited to that package. I have found turning off monoRepoSupport in this case to be helpful.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve the addition and modification of .vscode/settings.json files across multiple directories to configure the Visual Studio Code environment for Solidity development. Key updates include setting "JuanBlanco.solidity" as the default formatter for Solidity files, changing the Solidity formatter from "prettier" to "forge," and specifying mono-repo support settings. These adjustments aim to standardize the development environment for Solidity projects.

Changes

Files Change Summary
.vscode/settings.json Added default formatter "JuanBlanco.solidity"; changed Solidity formatter from "prettier" to "forge"; added mono-repo support set to true.
packages/contracts-core/.vscode/settings.json Added settings.json; set default formatter to "JuanBlanco.solidity" and "forge"; mono-repo support set to false.
packages/contracts-rfq/.vscode/settings.json Added settings.json; set default formatter to "JuanBlanco.solidity" and "forge"; mono-repo support set to false.
packages/solidity-devops/.vscode/settings.json Added settings.json; set default formatter to "JuanBlanco.solidity" and "forge"; mono-repo support set to false.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant VSCode
    participant SolidityFormatter

    Developer->>VSCode: Edit Solidity file
    VSCode->>SolidityFormatter: Format code using JuanBlanco.solidity
    SolidityFormatter-->>VSCode: Return formatted code
    VSCode-->>Developer: Display formatted code

Poem

🐰 In the garden of code, where Solidity blooms,
A formatter named Juan brings light to the rooms.
With forge by its side, the structure is neat,
In a world of monorepos, our tasks are complete!
Hopping through changes, we celebrate cheer,
For a tidy codebase, we hold dear! 🌼


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.

[!TIP]

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 code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).
codecov[bot] commented 2 months ago

Codecov Report

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

Project coverage is 41.33930%. Comparing base (89907ce) to head (9049299). Report is 35 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3145 +/- ## =================================================== + Coverage 37.94554% 41.33930% +3.39376% =================================================== Files 418 459 +41 Lines 24240 25685 +1445 Branches 82 330 +248 =================================================== + Hits 9198 10618 +1420 - Misses 14303 14328 +25 Partials 739 739 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3145/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/3145/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.96267% <ø> (ø)` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3145/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `98.26990% <ø> (?)` | | 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.

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9049299
Status: ✅  Deploy successful!
Preview URL: https://2bb189c3.sanguine-fe.pages.dev
Branch Preview URL: https://chore-solidity-vscode-settin.sanguine-fe.pages.dev

View logs