Skip to content

Conversation

@Bill-hbrhbr
Copy link
Collaborator

@Bill-hbrhbr Bill-hbrhbr commented Mar 22, 2025

Description

Currently, our cmake linter tool gersemi complains as follows:

Warning: unknown command 'catch_discover_tests' used at: ...

We silence this warning by adding related Catch2 cmake modules to .gersemirc.

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

  • No functionality change. Linting warning message disappears now.

Summary by CodeRabbit

  • Chores
    • Enhanced clarity of configuration settings by updating the definitions key to a multi-line format.
    • Introduced an additional dependency in the gersemi task to support parsing of third-party CMake modules during linting.

@Bill-hbrhbr Bill-hbrhbr requested a review from a team as a code owner March 22, 2025 07:17
@coderabbitai
Copy link

coderabbitai bot commented Mar 22, 2025

Walkthrough

The .gersemirc YAML configuration file has been modified by converting the definitions value from a single-line string into a native multi-line list. The original entry "CMake/ystdlib-cpp-helpers.cmake" is retained while a new entry "build/deps/Catch2/Catch2-src/extras/Catch.cmake" has been added. Additionally, the taskfiles/lint-cmake.yaml file has been updated to include a new dependency ":deps:install-all" in the gersemi task to facilitate the parsing of third-party CMake modules during linting.

Changes

File Change Summary
.gersemirc Updated the definitions key from a single-line string to a multi-line YAML list, retaining the original entry and adding a new Catch2 entry.
taskfiles/lint-cmake.yaml Added dependency ":deps:install-all" in task gersemi to enable parsing of third-party CMake modules for linting.

Suggested reviewers

  • davidlion
  • LinZhihao-723

📜 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 b05fd1f and 21670e5.

📒 Files selected for processing (1)
  • taskfiles/lint-cmake.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: lint-check (ubuntu-24.04)
🔇 Additional comments (1)
taskfiles/lint-cmake.yaml (1)

45-46: Dependency Addition Verification

The new dependency ":deps:install-all" is correctly added to the deps section of the gersemi task. This change should enable proper parsing of third-party CMake modules (such as Catch2), thereby silencing the linting warning regarding the unknown command 'catch_discover_tests'. The inline comment clearly explains the purpose of this dependency.


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

@Bill-hbrhbr Bill-hbrhbr changed the title fix(lint): Register Catch2 CMake modules as Gersemi definitions for proper CMake function parsing and linting. fix(lint): Register Catch2 and custom CMake modules with Gersemi. Mar 24, 2025
@Bill-hbrhbr Bill-hbrhbr merged commit 894bd14 into y-scope:main Mar 24, 2025
10 checks passed
@Bill-hbrhbr Bill-hbrhbr deleted the silence-catch-discover-test-warning branch March 24, 2025 04:11
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