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

feat(ignore): Add Rust default ignores #318

Merged
merged 2 commits into from
Jan 27, 2025
Merged

Conversation

boralg
Copy link
Contributor

@boralg boralg commented Jan 26, 2025

This PR adds Rust-specific patterns to the default ignore list.

Checklist

  • Run npm run test
  • Run npm run lint

Copy link
Contributor

coderabbitai bot commented Jan 26, 2025

📝 Walkthrough

Walkthrough

The pull request introduces four new entries to the defaultIgnoreList configuration in the src/config/defaultIgnore.ts file, specifically targeting Rust projects. The new entries include patterns to ignore the Cargo.lock file, the Cargo.toml.orig file, the target directory, and files with the .rs.bk extension. The overall structure and comments in the list remain unchanged, with the new entries appended at the end, preserving the organization of ignored files and directories. This change updates the default ignore list to include additional patterns relevant to Rust project configurations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant Config

    User->>System: Initiate project setup
    System->>Config: Load defaultIgnoreList
    Config-->>System: Return defaultIgnoreList
    System->>User: Display ignored files and directories
Loading

📜 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 185b907 and 127c81a.

📒 Files selected for processing (1)
  • src/config/defaultIgnore.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/config/defaultIgnore.ts
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: Test (macos-latest, 23.x)
  • GitHub Check: Test (macos-latest, 22.x)
  • GitHub Check: Test (macos-latest, 21.x)
  • GitHub Check: Test (windows-latest, 23.x)
  • GitHub Check: Test (windows-latest, 22.x)
  • GitHub Check: Test (windows-latest, 21.x)
  • GitHub Check: Test (windows-latest, 20.x)
  • GitHub Check: Test (windows-latest, 19.x)
  • GitHub Check: Build and run (windows-latest, 23.x)
  • GitHub Check: Test (windows-latest, 18.x)
  • GitHub Check: Test (windows-latest, 18.0.0)
  • GitHub Check: Test (ubuntu-latest, 23.x)
  • GitHub Check: Test (ubuntu-latest, 22.x)
  • GitHub Check: Test coverage
  • GitHub Check: Analyze (javascript-typescript)

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

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)
src/config/defaultIgnore.ts (1)

135-138: LGTM! Consider adding more Rust-specific patterns.

The added Rust ignore patterns follow the established format and are properly documented. However, there are a few more common Rust-specific patterns that might be worth considering.

Consider adding these additional common Rust ignore patterns:

  // Essential Rust-related entries
  '**/Cargo.lock',
  '**/Cargo.toml.orig',
+ '**/debug/**',           // Debug build artifacts
+ '**/target/release/**',  // Release build artifacts
+ '**/*.rs.bk',           // Rust backup files
+ '**/rust-toolchain',    // Local toolchain override file
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3662384 and 8100d17.

📒 Files selected for processing (1)
  • src/config/defaultIgnore.ts (1 hunks)

src/config/defaultIgnore.ts Show resolved Hide resolved
@yamadashy
Copy link
Owner

Hi, @boralg !
Thank you for the PR!
I hadn't noticed that we were missing these Rust patterns! This is a great catch, thank you for bringing this up.

The changes look good to me!

I'll merge this. Thanks for contributing to Repomix! 🎉

Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.14%. Comparing base (97519ed) to head (127c81a).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #318      +/-   ##
==========================================
+ Coverage   90.12%   90.14%   +0.01%     
==========================================
  Files          48       48              
  Lines        2471     2475       +4     
  Branches      514      514              
==========================================
+ Hits         2227     2231       +4     
  Misses        244      244              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yamadashy yamadashy merged commit f3bc06f into yamadashy:main Jan 27, 2025
53 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jan 27, 2025
2 tasks
@yamadashy
Copy link
Owner

@boralg
We have successfully released version 0.2.24, which includes your changes.
https://github.com/yamadashy/repomix/releases/tag/v0.2.24

Thank you for your contribution! We appreciate your efforts and look forward to your continued support!

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