fix: exclude the .snakemake folder from the watcher and searches

[irm-codebase]

Adds a few settings to avoid explosive searches (#37).

I believe the API will merge these values without overriding existing ones (see here).

configurationDefaults should modify the default configuration without adding user-seen options.

I have omitted python.analysis.exclude because any changes will overwrite existing settings. This seems to be unavoidable, until the python extension uses a more sensible approach to this setting.

Word of caution: I am not versed in VSCode extensions!
So please check carefully before merging.

Summary by CodeRabbit

• New Features
  • Improved file watching by excluding certain internal directories, reducing unnecessary background activity.
  • Enhanced search results by automatically omitting specified directories, leading to more relevant results.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request modifies the package.json file by adding a new configurationDefaults section under the existing contributes key. The update configures two properties: files.watcherExclude to ignore any files within the "/.snakemake/" directory for file watching, and search.exclude to omit the "**/.snakemake" directory from search results.

Changes

File	Change Summary
package.json	- Added configurationDefaults under the contributes key - Configured files.watcherExclude with { "**/.snakemake/**": true } - Configured search.exclude with { "**/.snakemake": true }

---

📜 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 a057009 and a1b008c.

📒 Files selected for processing (1)

• package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• package.json

---

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

package.json (1)

27-29: Glob Pattern Consideration for search.exclude
The glob pattern used for search.exclude is "**/.snakemake", which may work as intended. However, consider whether appending a trailing wildcard (e.g., "**/.snakemake/**") might more reliably exclude all nested files within the folder. This change depends on the desired exclusion depth.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 24d7afc and a057009.

📒 Files selected for processing (1)

• package.json (1 hunks)

🔇 Additional comments (1)

package.json (1)

23-30: Clear Addition of Configuration Defaults
The new configurationDefaults section under contributes is correctly defined and structured. It will effectively exclude the .snakemake directory from file watching and searches. Please ensure that these defaults merge with any existing user settings as specified by the VSCode API documentation.

[johanneskoester]

Thanks a lot! @Hocnonsense could you confirm whether this works as intended?

[Hocnonsense]

Sure. I've test it on my computer. With these lines, texts in files inside .snakemake will not be reported.

in vscode debug window	and you can force search in .snakemake/ folder