Skip to content

fix: prettier-config #1846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 23, 2025
Merged

fix: prettier-config #1846

merged 1 commit into from
Jan 23, 2025

Conversation

tractorss
Copy link
Contributor

@tractorss tractorss commented Jan 23, 2025

PR-Codex overview

This PR updates the prettier-config/index.js file to enhance the configuration for Prettier, specifically for Solidity files. It introduces a new parser and modifies the format for the plugins array.

Detailed summary

  • Added parser: "solidity-parse" to the options.
  • Changed plugins from using require to a string format: plugins: ["prettier-plugin-solidity"].

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features
    • Added support for Solidity file parsing in the Prettier configuration
  • Chores
    • Updated plugin declaration format for Solidity formatting

Copy link
Contributor

coderabbitai bot commented Jan 23, 2025

Walkthrough

The pull request modifies the Prettier configuration file to add support for Solidity file parsing. The changes include introducing a specific parser for .sol files and updating the plugin declaration syntax for the Solidity plugin. This configuration adjustment aims to improve code formatting capabilities for Solidity smart contract files.

Changes

File Change Summary
prettier-config/index.js - Added parser: "solidity-parse" for *.sol files
- Updated plugin declaration from require("prettier-plugin-solidity") to "prettier-plugin-solidity"

Poem

🐰 A Rabbit's Ode to Solidity's Grace

In config's realm, a change takes flight,
Solidity's parser shines so bright
Prettier's magic, now refined
With plugins neatly intertwined
Code formatting, a bunny's delight! 🧑‍💻

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for kleros-v2-university ready!

Name Link
🔨 Latest commit 45daa0e
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/6791f93ebc46100009a45a3b
😎 Deploy Preview https://deploy-preview-1846--kleros-v2-university.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for kleros-v2-neo ready!

Name Link
🔨 Latest commit 45daa0e
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/6791f93e5c5b510008ee7287
😎 Deploy Preview https://deploy-preview-1846--kleros-v2-neo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit 45daa0e
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/6791f93e3daf4500080362ac
😎 Deploy Preview https://deploy-preview-1846--kleros-v2-testnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codeclimate bot commented Jan 23, 2025

Code Climate has analyzed commit 45daa0e and detected 0 issues on this pull request.

View more on Code Climate.

@tractorss tractorss requested a review from jaybuidl January 23, 2025 08:10
Copy link

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3f05ab and 45daa0e.

📒 Files selected for processing (1)
  • prettier-config/index.js (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-neo
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-neo
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-neo
  • GitHub Check: Redirect rules - kleros-v2-university
  • GitHub Check: Header rules - kleros-v2-university
  • GitHub Check: Pages changed - kleros-v2-university
  • GitHub Check: SonarCloud
  • GitHub Check: dependency-review
  • GitHub Check: contracts-testing
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
prettier-config/index.js (1)

Line range hint 16-23: LGTM! Well-structured Solidity formatting configuration.

The configuration includes all necessary formatting rules for Solidity files with appropriate values that align with standard conventions.

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for kleros-v2-testnet-devtools ready!

Name Link
🔨 Latest commit 45daa0e
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/6791f93e05e77a00081ecd75
😎 Deploy Preview https://deploy-preview-1846--kleros-v2-testnet-devtools.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@alcercu alcercu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@alcercu alcercu added this pull request to the merge queue Jan 23, 2025
Merged via the queue into dev with commit 0bbec16 Jan 23, 2025
27 checks passed
@jaybuidl jaybuidl deleted the fix/prettier-config branch May 19, 2025 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants