Skip to content
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

ci(clang-format): Update to clang-format v19 (and the corresponding yscope-dev-utils) and apply the corresponding formatting changes (fixes #545). #658

Merged
merged 2 commits into from
Jan 11, 2025

Conversation

LinZhihao-723
Copy link
Member

@LinZhihao-723 LinZhihao-723 commented Jan 9, 2025

Description

This PR updates yscope-dev-utils to the latest commit so that clang-format v19 config can be used. It also updates clang-format version to v19 in the linter dependency to format C++ code using the latest clang-format pypi release.

Validation performed

  • Ensure workflows all passed.

Summary by CodeRabbit

Release Notes

  • Style

    • Standardized method signature formatting across multiple components
    • Removed unnecessary semicolons from constructors
    • Improved code readability by adjusting line breaks in function declarations
  • Dependency Updates

    • Upgraded clang-format version requirement to >=19.1.6
  • Subproject Updates

    • Updated tools/yscope-dev-utils subproject reference

These changes primarily focus on code style consistency and minor dependency management, with no significant functional modifications to the codebase.

Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request introduces a comprehensive set of formatting changes across multiple components of the codebase. These modifications primarily focus on improving code readability by adjusting method signatures, constructor definitions, and function declarations. The changes are purely stylistic and do not alter the underlying functionality, logic, or control flow of the code. The most common modifications include removing unnecessary semicolons, consolidating or breaking method signatures across lines, and ensuring consistent formatting across different files and classes.

Changes

File/Component Change Summary
Method Signatures Reformatted across multiple files to improve readability, including moving return types to new lines or consolidating signatures
Constructor Definitions Removed unnecessary semicolons in various classes
Dependency Management Updated clang-format version requirement from ~18.1 to >=19.1.6
Subproject Reference Updated tools/yscope-dev-utils subproject commit

Sequence Diagram

Since the changes are primarily formatting-related and do not introduce new functionality or modify control flow, a sequence diagram is not applicable in this case.


📜 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 33aeb99 and 6875aa9.

📒 Files selected for processing (2)
  • components/core/src/clp/ffi/ir_stream/ir_unit_deserialization_methods.cpp (9 hunks)
  • components/core/tests/test-ffi_KeyValuePairLogEvent.cpp (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • components/core/tests/test-ffi_KeyValuePairLogEvent.cpp
  • components/core/src/clp/ffi/ir_stream/ir_unit_deserialization_methods.cpp
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: centos-stream-9-static-linked-bins
  • GitHub Check: ubuntu-jammy-static-linked-bins
  • GitHub Check: centos-stream-9-dynamic-linked-bins
  • GitHub Check: ubuntu-focal-static-linked-bins
  • GitHub Check: ubuntu-jammy-dynamic-linked-bins
  • GitHub Check: ubuntu-focal-dynamic-linked-bins
  • GitHub Check: build-macos (macos-14, false)
  • GitHub Check: build-macos (macos-14, true)
  • GitHub Check: lint-check (ubuntu-latest)
  • GitHub Check: build-macos (macos-13, false)
  • GitHub Check: lint-check (macos-latest)
  • GitHub Check: build-macos (macos-13, true)

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.

@LinZhihao-723 LinZhihao-723 merged commit 403b3da into y-scope:main Jan 11, 2025
21 checks passed
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.

2 participants