Skip to content

chore: update clippy to check only internal code, not deps#433

Merged
LuisUrrutia merged 2 commits into
mainfrom
ci-clippy-improvements
Aug 26, 2025
Merged

chore: update clippy to check only internal code, not deps#433
LuisUrrutia merged 2 commits into
mainfrom
ci-clippy-improvements

Conversation

@zeljkoX

@zeljkoX zeljkoX commented Aug 26, 2025

Copy link
Copy Markdown
Collaborator

Summary

This PR updates pre commit clippy command to avoid checking external deps

Testing Process

Checklist

  • Add a reference to related issues in the PR description.
  • Add unit tests if applicable.

Summary by CodeRabbit

  • Chores
    • Updated pre-commit linting to run workspace-focused checks, improving consistency across the project.
    • Limits linting to relevant targets and excludes external dependencies to speed up developer workflows.
    • No functional or user-facing changes; build and runtime behavior remain unchanged.

@zeljkoX zeljkoX requested review from a team as code owners August 26, 2025 08:15
@coderabbitai

coderabbitai Bot commented Aug 26, 2025

Copy link
Copy Markdown

Walkthrough

Updated the pre-commit clippy hook to lint the workspace's library and binary targets only, using --no-deps, instead of --all-targets --all-features; -D warnings remains.

Changes

Cohort / File(s) Summary of Changes
Pre-commit Lint Config
.pre-commit-config.yaml, ./.pre-commit-config.yaml
Replaced clippy invocation cargo clippy --all-targets --all-features -- -D warnings with cargo clippy --workspace --lib --bins -- --no-deps -D warnings, narrowing lint scope to workspace libs/bins and excluding dependencies.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my nose at lint anew,
From every crate to chosen few.
Libs and bins now pass my hops,
Dependencies stay out of hops.
A tidy burrow, warnings few 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ci-clippy-improvements

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
.pre-commit-config.yaml (1)

31-31: Confirm whether excluding tests is intentional

You replaced “all targets” with --lib --bins, which stops linting tests/examples/benches. If the intent was only “don’t lint external deps” while keeping internal test coverage, consider --all-targets plus --no-deps:

-        entry: cargo clippy --workspace --lib --bins -- --no-deps -D warnings
+        entry: cargo clippy --workspace --all-targets -- --no-deps -D warnings
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 467c25b and 1e9c677.

📒 Files selected for processing (1)
  • .pre-commit-config.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: boostsecurity - boostsecurityio/semgrep-pro
  • GitHub Check: Redirect rules - openzeppelin-relayer
  • GitHub Check: Header rules - openzeppelin-relayer
  • GitHub Check: Pages changed - openzeppelin-relayer
  • GitHub Check: Analyze (rust)

Comment thread .pre-commit-config.yaml Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
.pre-commit-config.yaml (2)

31-31: Optional: include unit tests (and examples) while still ignoring deps

If you want Clippy to also cover internal tests/examples without touching dependencies, add --tests (and optionally --examples). This keeps the “no deps” guarantee but increases coverage of our own code.

-        entry: cargo clippy --workspace --lib --bins -- --no-deps -D warnings
+        entry: cargo clippy --workspace --lib --bins --tests --examples -- --no-deps -D warnings

31-31: Optional: broaden coverage on pre-push only

To keep pre-commit fast but catch cfg-gated code paths, consider a second hook limited to the pre-push stage with --all-features (still with --no-deps). Example:

       - id: clippy
         name: clippy
-        entry: cargo clippy --workspace --lib --bins -- --no-deps -D warnings
+        entry: cargo clippy --workspace --lib --bins -- --no-deps -D warnings
         pass_filenames: false
         language: system
+        stages: [pre-commit]
+
+      - id: clippy-pre-push-all-features
+        name: clippy (pre-push, all features)
+        entry: cargo clippy --workspace --lib --bins --all-features -- --no-deps -D warnings
+        pass_filenames: false
+        language: system
+        stages: [pre-push]
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1e9c677 and 6caecf1.

📒 Files selected for processing (1)
  • .pre-commit-config.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: boostsecurity - boostsecurityio/semgrep-pro
  • GitHub Check: Analyze (rust)
🔇 Additional comments (1)
.pre-commit-config.yaml (1)

31-31: LGTM: Clippy now targets only internal code and ignores deps

--workspace --lib --bins scopes to our crates, and passing -- --no-deps -D warnings ensures dependencies aren’t linted while still failing on warnings. Matches the PR objective.

@LuisUrrutia LuisUrrutia merged commit 1b3943f into main Aug 26, 2025
23 checks passed
@LuisUrrutia LuisUrrutia deleted the ci-clippy-improvements branch August 26, 2025 09:20
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 26, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants