Skip to content

feat(clang-tidy): Disable function cognitive-complexity check for code inside macros.#44

Merged
LinZhihao-723 merged 2 commits into
y-scope:mainfrom
LinZhihao-723:clang-tidy-update
Apr 30, 2025
Merged

feat(clang-tidy): Disable function cognitive-complexity check for code inside macros.#44
LinZhihao-723 merged 2 commits into
y-scope:mainfrom
LinZhihao-723:clang-tidy-update

Conversation

@LinZhihao-723

@LinZhihao-723 LinZhihao-723 commented Apr 30, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

The function cognitive complexity check will expand the macro and count everything inside the macro, which could easily break the default threshold. We've seen this in many catch2 test cases caused by catch2's REQUIRE macro.

In addition, our recently introduced macro, YSTDLIB_ERROR_HANDLING_TRYX, will also cause a similar issue where the complexity threshold can be easily broken.

As a result of our offline discussion, we decided to disable the cognitive complexity check for the code inside the macro.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • Tested offline to ensure it works.

Summary by CodeRabbit

  • Chores
    • Updated lint configuration to improve handling of cognitive complexity checks by ignoring macros.

@LinZhihao-723 LinZhihao-723 requested a review from a team as a code owner April 30, 2025 17:46
@coderabbitai

coderabbitai Bot commented Apr 30, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

A modification was made to the clang-tidy lint configuration file, specifically adding a new option under CheckOptions. The option readability-function-cognitive-complexity.IgnoreMacros was set to true, instructing clang-tidy to disregard macros when evaluating the cognitive complexity of functions. No other configuration or code changes were introduced.

Changes

File(s) Change Summary
exports/lint-configs/.clang-tidy Added readability-function-cognitive-complexity.IgnoreMacros: true to CheckOptions section with a comment explaining its necessity for macro-heavy codebases.
📜 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 6b8da52 and bea5806.

📒 Files selected for processing (1)
  • exports/lint-configs/.clang-tidy (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • exports/lint-configs/.clang-tidy

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

kirkrodrigues
kirkrodrigues reviewed Apr 30, 2025
View reviewed changes
Comment thread exports/lint-configs/.clang-tidy Outdated
@LinZhihao-723 @kirkrodrigues
Update exports/lint-configs/.clang-tidy
bea5806 
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
kirkrodrigues
kirkrodrigues approved these changes Apr 30, 2025
View reviewed changes

@kirkrodrigues kirkrodrigues left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For the PR title, how about:

feat(clang-tidy): Disable function cognitive-complexity check for code inside macros.

@LinZhihao-723 LinZhihao-723 changed the title feat(clang-tidy): Ignore code inside macros for function cognitive complexity check. feat(clang-tidy): Disable function cognitive-complexity check for code inside macros. Apr 30, 2025
@LinZhihao-723 LinZhihao-723 merged commit 56740d3 into y-scope:main Apr 30, 2025
1 check passed
@LinZhihao-723 LinZhihao-723 mentioned this pull request May 1, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kirkrodrigues kirkrodrigues kirkrodrigues approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@LinZhihao-723 @kirkrodrigues