Skip to content

Conversation

@CoMPaTech
Copy link
Member

@CoMPaTech CoMPaTech commented Jun 19, 2025

Summary by CodeRabbit

  • Chores
    • Updated linting and formatting commands to improve file coverage.
    • Added appdata_folder to the list of ignored files and directories.
    • Updated changelog to document maintenance related to linting.
  • Style
    • Improved detection and formatting of files for code style checks.

@CoMPaTech CoMPaTech self-assigned this Jun 19, 2025
@CoMPaTech CoMPaTech added the bug Something isn't working label Jun 19, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jun 19, 2025

Walkthrough

The updates modify how Ruff linting and formatting commands target files in both GitHub Actions and a shell script, switching from directory-based to file-based patterns. The .gitignore is updated to exclude appdata_folder, and the changelog is updated to document the maintenance change.

Changes

File(s) Change Summary
.github/workflows/verify.yml, scripts/tests_and_coverage.sh Modified Ruff lint and format commands to use file wildcards (plugwise_usb/*, tests/*) instead of directories.
.gitignore Added appdata_folder to ignored files/directories.
CHANGELOG.md Added entry noting the maintenance update for Ruff reporting.

Possibly related PRs

  • Catch up #170: Also modifies .github/workflows/verify.yml and Ruff command usage, focusing on action versions, environment variables, and invocation style.

Suggested labels

github-actions

Suggested reviewers

  • bouwew

Poem

A rabbit hopped through code so neat,
Tweaked Ruff commands for a tidy feat.
With wildcards now, the checks run true,
And appdata_folder—git won’t pursue!
The changelog notes this maintenance cheer,
For code that’s clean, the path is clear!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch rufffix

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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 auto-generate unit tests to generate unit tests 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 or @coderabbitai title 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.

@sonarqubecloud
Copy link

Copy link

@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: 0

🧹 Nitpick comments (3)
CHANGELOG.md (1)

8-8: Include the PR number for consistency.

The new entry is missing its PR reference. For clarity and traceability, prefix this line with #268, e.g.:

- - PR Maintenance chores Fix ruff reporting locally
+ - PR [#268](https://github.com/plugwise/python-plugwise-usb/pull/268): Maintenance chores Fix ruff reporting locally
.github/workflows/verify.yml (1)

88-88: Quote glob patterns and align with local script.

To satisfy ShellCheck and ensure ruff itself handles glob expansion, quote the patterns and use the same directory-targeting convention as in scripts/tests_and_coverage.sh. For example:

- ruff check plugwise_usb/* tests/*
+ ruff check "plugwise_usb/*" "tests/."
...
- ruff format plugwise_usb/* tests/*
+ ruff format "plugwise_usb/*" "tests/*"

This both silences SC2086 warnings and unifies CI with local lint commands.

Also applies to: 93-93

scripts/tests_and_coverage.sh (1)

68-68: Quote glob patterns and match workflow.

Wrap the glob arguments in quotes to avoid ShellCheck warnings and align with the CI workflow:

-    ruff check plugwise_usb/* tests/.  # Does need the /* otherwise apparently skips __init__.py's
+    ruff check "plugwise_usb/*" "tests/."
...
-    ruff format plugwise_usb/* tests/*
+    ruff format "plugwise_usb/*" "tests/*"

Consider using tests/.* or tests/* consistently in both local and CI scripts to include __init__.py.

Also applies to: 71-71

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 96d0a78 and 10ac6d3.

📒 Files selected for processing (4)
  • .github/workflows/verify.yml (1 hunks)
  • .gitignore (1 hunks)
  • CHANGELOG.md (1 hunks)
  • scripts/tests_and_coverage.sh (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.7)
.github/workflows/verify.yml

91-91: shellcheck reported issue in this script: SC2086:info:5:91: Double quote to prevent globbing and word splitting

(shellcheck)


91-91: shellcheck reported issue in this script: SC2086:info:6:14: Double quote to prevent globbing and word splitting

(shellcheck)


91-91: shellcheck reported issue in this script: SC2086:info:8:17: Double quote to prevent globbing and word splitting

(shellcheck)

🔇 Additional comments (1)
.gitignore (1)

19-19: Appropriate addition to ignore local data folder.

Adding appdata_folder will prevent committing local application data. This aligns with existing ignore patterns.

@CoMPaTech CoMPaTech closed this Jun 19, 2025
@CoMPaTech CoMPaTech deleted the rufffix branch June 19, 2025 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants