chore: solidity vscode settings #3145
Conversation
- use `forge fmt` as formatter in Solidity extension
WalkthroughThe changes involve the addition and modification of Changes
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
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
Tip Early access features: enabledWe are currently testing the following features in early access:
Note:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Deploying sanguine-fe with
|
| 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (4)
- .vscode/settings.json (2 hunks)
- packages/contracts-core/.vscode/settings.json (1 hunks)
- packages/contracts-rfq/.vscode/settings.json (1 hunks)
- packages/solidity-devops/.vscode/settings.json (1 hunks)
Files skipped from review due to trivial changes (2)
- packages/contracts-core/.vscode/settings.json
- packages/contracts-rfq/.vscode/settings.json
Additional comments not posted (4)
packages/solidity-devops/.vscode/settings.json (2)
5-5: Confirm 'forge' Formatter Is Available and Configured CorrectlySetting
"solidity.formatter": "forge"configures the Solidity extension to use 'forge' as the formatter. Ensure that 'forge' is installed and properly set up in the development environment to avoid any formatting discrepancies.
3-3: Ensure 'JuanBlanco.solidity' Extension Is InstalledThe setting
"editor.defaultFormatter": "JuanBlanco.solidity"specifies that the default formatter for Solidity files should be the one provided by the Juan Blanco Solidity extension. To prevent formatting issues, verify that this extension is installed in the development environment.You can run the following script to check if the extension is installed:
.vscode/settings.json (2)
3-5: Set Default Formatter for Solidity FilesAdding the
[solidity]section with"editor.defaultFormatter": "JuanBlanco.solidity"ensures consistent formatting of Solidity files across the project using the Juan Blanco extension. This is a good practice for maintaining code style consistency.
22-22: Update Solidity Formatter to 'forge'Changing
"solidity.formatter"to"forge"standardizes the use of 'forge' as the formatter for Solidity files in the project. Confirm that all team members have 'forge' installed to maintain consistent formatting.
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
monoRepoSupportin this case to be helpful.Summary by CodeRabbit
New Features
Bug Fixes