Skip to content

fix: removing breaking line in formatter#1124

Merged
kolipakakondal merged 1 commit into
masterfrom
IEP-1404
Feb 19, 2025
Merged

fix: removing breaking line in formatter#1124
kolipakakondal merged 1 commit into
masterfrom
IEP-1404

Conversation

@sigmaaa

@sigmaaa sigmaaa commented Jan 21, 2025

Copy link
Copy Markdown
Collaborator

Description

Please include a summary of the change and which issue is fixed.

Fixes # (IEP-XXX)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • ESP-IDF Version:
  • OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

  • Component 1
  • Component 2

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • Style
    • Updated project code formatting configuration
    • Simplified constructor initializer formatting rules
    • Adjusted access modifier indentation settings

@coderabbitai

coderabbitai Bot commented Jan 21, 2025

Copy link
Copy Markdown

Walkthrough

The pull request modifies the .clang-format-project configuration file in the Espressif IDF Core project. The changes involve removing specific lines related to constructor initializer formatting and potentially adjusting the access modifier indentation. These modifications simplify the formatting rules for constructor initializers and may slightly change how access modifiers are displayed in the code.

Changes

File Change Summary
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/.clang-format-project Removed PackConstructorInitializers and BreakConstructorInitializers lines, potentially modified AccessModifierOffset

Possibly related PRs

Suggested reviewers

  • AndriiFilippov
  • kolipakakondal
  • alirana01

Poem

🐰 Clang-format, oh so neat,
Lines of code now trim and sweet
Initializers dance with grace
Modifiers find their perfect space
A rabbit's code styling delight! 🧹✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 04b99d1 and 426484f.

📒 Files selected for processing (1)
  • bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/.clang-format-project (0 hunks)
💤 Files with no reviewable changes (1)
  • bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/.clang-format-project
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: build_macos

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
🪧 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 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.

@kolipakakondal kolipakakondal left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM.

Hi @AndriiFilippov PackConstructorInitializers property is removed considering it's supported only from LLVM 19 and what we have latest from espressif is LLVM 18. Please see how the code formatting is impacted with this or without.

@AndriiFilippov

AndriiFilippov commented Feb 10, 2025

Copy link
Copy Markdown
Collaborator

@sigmaaa @kolipakakondal hi !

Tested under:
OS - Mac arm64
ESP-IDF: v5.4

it reduce readability for sure, specially for long initializer lists.
it could lead to merge conflicts if different branches follow different styles (If one branch follows the previous formatting (NextLineOnly) and another follows the new rule (removed NExtLineOnly), like if user has auto-format enabled (which applies the new rule), he might unintentionally reformat old code. Git will see this as a change to the same line.
This makes merging harder because Git treats it as conflicting edits.

Otherwise, LGTM. No functionality degradation found.

@sigmaaa sigmaaa linked an issue Feb 16, 2025 that may be closed by this pull request
@kolipakakondal kolipakakondal added this to the v3.3.0 milestone Feb 19, 2025
@kolipakakondal kolipakakondal merged commit 6effae2 into master Feb 19, 2025
@kolipakakondal kolipakakondal deleted the IEP-1404 branch February 19, 2025 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Espressif IDE created an invalid .clang-format file (IEP-1404)

3 participants