kruziikrel13/quickshell

Fork 0

rewrite following better practices from several example repositories #11

Merged

Kruziikrel13 merged 50 commits from rebuild into master

2025-08-08 11:58:58 +10:00

Kruziikrel13 commented

2025-08-08 11:57:28 +10:00

(Migrated from github.com)

I think this fixes #7 and #4

Summary by CodeRabbit

New Features
- Introduced a modular bar with components for OS icon, workspaces, active client, clock, Spotify integration, network, audio, and system tray.
- Added global UI constants for sizing, fonts, and colors.
- Implemented a dynamic background image loader for multi-screen setups.
- Added Spotify integration for displaying track info and controlling playback.
- Provided new styled icon and text components for consistent UI.
Bug Fixes
- Improved network status detection to support simultaneous Wi-Fi and Ethernet connections.
- Enhanced system information parsing for better OS detection.
Refactor
- Replaced and consolidated appearance and configuration settings into a new global singleton.
- Streamlined language server configuration and internal imports.
Chores
- Added environment, formatting, and shell configuration files.
- Updated version control and Git LFS settings.
Removals
- Deleted legacy bar, media controls, power menu, on-screen display, and related components.
- Removed old appearance, configuration, and widget files in favor of new modular design.

I think this fixes #7 and #4  ## Summary by CodeRabbit * **New Features** * Introduced a modular bar with components for OS icon, workspaces, active client, clock, Spotify integration, network, audio, and system tray. * Added global UI constants for sizing, fonts, and colors. * Implemented a dynamic background image loader for multi-screen setups. * Added Spotify integration for displaying track info and controlling playback. * Provided new styled icon and text components for consistent UI. * **Bug Fixes** * Improved network status detection to support simultaneous Wi-Fi and Ethernet connections. * Enhanced system information parsing for better OS detection. * **Refactor** * Replaced and consolidated appearance and configuration settings into a new global singleton. * Streamlined language server configuration and internal imports. * **Chores** * Added environment, formatting, and shell configuration files. * Updated version control and Git LFS settings. * **Removals** * Deleted legacy bar, media controls, power menu, on-screen display, and related components. * Removed old appearance, configuration, and widget files in favor of new modular design.

coderabbitai[bot] commented

2025-08-08 11:57:35 +10:00

(Migrated from github.com)

Walkthrough

This update restructures a shell UI project by introducing new QML components for bar modules, background, and global styling, while removing or replacing legacy files and centralizing style constants in a new singleton. Several modules, configuration, and appearance files are deleted or replaced. The update also adds Nix development environment files and revises service singletons for audio, network, and Spotify integration.

Changes

Cohort / File(s)	Change Summary
Development Environment `.envrc`, `.gitattributes`, `.gitignore`, `.qmlformat.ini`, `shell.nix`	Added configuration for Nix shell, git LFS for `.jpg`, ignored `.qmlls.ini`, QML formatting rules, and Nix shell environment with Qt 6 declarative.
Bar, Background, and Core UI Components (New) `ShellGlobals.qml`, `background/Background.qml`, `bar/Clock.qml`, `bar/ModuleGroup.qml`, `bar/Network.qml`, `bar/OsIcon.qml`, `bar/Pipewire.qml`, `bar/Spotify.qml`, `bar/Window.qml`, `bar/hyprland/ActiveClient.qml`, `bar/hyprland/Workspace.qml`, `bar/hyprland/Workspaces.qml`, `bar/tray/Tray.qml`, `bar/tray/TrayItem.qml`, `components/StyledIcon.qml`, `components/StyledText.qml`, `components/StyledWindow.qml`	Introduced new QML components for global shell constants, background image, bar modules (clock, network, OS icon, Pipewire, Spotify), window layout, Hyprland integration, tray, and standardized styled icon/text/window components.
Service Singletons (Audio, Network, Spotify, SystemInfo) `services/Audio.qml`, `services/Network.qml`, `services/SpotifyController.qml`, `services/SystemInfo.qml`	Refactored singletons: improved typing and behavior, replaced network type with wifi/ethernet booleans, added Spotify controller for MPRIS, enhanced system info parsing and removed unused code.
Legacy, Appearance, and Config (Removed) `settings/Appearance.qml`, `settings/ConfigOptions.qml`, `widgets/CustomIcon.qml`, `widgets/StyledShadow.qml`, `widgets/StyledText.qml`, `windows/Bar/Bar.qml`, `windows/Bar/components/ModuleGroup.qml`, `windows/Bar/components/Separator.qml`, `windows/Bar/modules/ActiveClient.qml`, `windows/Bar/modules/Network.qml`, `windows/Bar/modules/Notifications.qml`, `windows/Bar/modules/OsIcon.qml`, `windows/Bar/modules/PowerMenu.qml`, `windows/Bar/modules/Spotify.qml`, `windows/Bar/modules/Tray.qml`, `windows/Bar/modules/Workspaces.qml`, `windows/MediaControls/MediaControls.qml`, `windows/OnScreenDisplay/OnScreenDisplayVolume.qml`, `windows/PowerMenu/PowerMenu.qml`, `windows/PowerMenu/components/Profile.qml`, `services/MediaController.qml`	Deleted legacy bar modules, appearance/config singletons, widgets, media controls, on-screen display, power menu, and related components.
Shell Entry and Loader `shell.qml`, `.lazy.lua`	Refactored shell entry to use new bar and background modules, updated imports, changed root element, and simplified language server enablement in `.lazy.lua`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ShellRoot
    participant Bar.Window
    participant Background
    participant ShellGlobals
    participant Services (Audio/Network/Spotify/SystemInfo)

    User->>ShellRoot: Launch shell.qml
    ShellRoot->>ShellGlobals: Access global constants
    ShellRoot->>Bar.Window: Instantiate bar per screen
    ShellRoot->>Background: Instantiate background if image set
    Bar.Window->>Services: Query status (audio, network, Spotify, system info)
    Bar.Window->>ShellGlobals: Read sizes, fonts, colors
    Bar.Window->>Bar Modules: Render modules (Clock, Network, Pipewire, etc.)
    Bar.Window->>Tray: Render system tray
    Bar Modules->>Services: Fetch live data (e.g., network, Spotify)
    Note right of Bar.Window: Modules update reactively on service changes

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Poem

In the garden of code, a shell takes new shape,
Old modules retire, new rabbits escape.
With backgrounds that shimmer and bars that align,
Spotify dances, the network’s just fine.
Nix brings fresh clover, the tray hops in view—
A shell full of carrots, for rabbits and you!
🐇🌱

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 334a95e170 and 8caffafb4c.

⛔ Files ignored due to path filters (14)

assets/icons/arch-symbolic.svg is excluded by !**/*.svg
assets/icons/github-symbolic.svg is excluded by !**/*.svg
assets/icons/linux-symbolic.svg is excluded by !**/*.svg
assets/icons/nixos-symbolic.svg is excluded by !**/*.svg
assets/icons/spotify.svg is excluded by !**/*.svg
assets/icons/ubuntu-symbolic.svg is excluded by !**/*.svg
assets/wallpapers/icelandbeach.jpg is excluded by !**/*.jpg
assets/wallpapers/icelandbeach2.jpg is excluded by !**/*.jpg
assets/wallpapers/icelandgeneric.jpg is excluded by !**/*.jpg
assets/wallpapers/nepalmountainsnight.jpg is excluded by !**/*.jpg
assets/wallpapers/ocean.jpg is excluded by !**/*.jpg
assets/wallpapers/scavengersreign1.jpg is excluded by !**/*.jpg
assets/wallpapers/scavengersreign2.jpg is excluded by !**/*.jpg
assets/wallpapers/sunnymountains.jpg is excluded by !**/*.jpg

📒 Files selected for processing (49)

.envrc (1 hunks)
.gitattributes (1 hunks)
.gitignore (1 hunks)
.lazy.lua (0 hunks)
.qmlformat.ini (1 hunks)
ShellGlobals.qml (1 hunks)
background/Background.qml (1 hunks)
bar/Clock.qml (1 hunks)
bar/ModuleGroup.qml (1 hunks)
bar/Network.qml (1 hunks)
bar/OsIcon.qml (1 hunks)
bar/Pipewire.qml (1 hunks)
bar/Spotify.qml (1 hunks)
bar/Window.qml (1 hunks)
bar/hyprland/ActiveClient.qml (1 hunks)
bar/hyprland/Workspace.qml (1 hunks)
bar/hyprland/Workspaces.qml (1 hunks)
bar/tray/Tray.qml (1 hunks)
bar/tray/TrayItem.qml (1 hunks)
components/StyledIcon.qml (1 hunks)
components/StyledText.qml (1 hunks)
components/StyledWindow.qml (1 hunks)
services/Audio.qml (1 hunks)
services/MediaController.qml (0 hunks)
services/Network.qml (1 hunks)
services/SpotifyController.qml (1 hunks)
services/SystemInfo.qml (2 hunks)
settings/Appearance.qml (0 hunks)
settings/ConfigOptions.qml (0 hunks)
shell.nix (1 hunks)
shell.qml (1 hunks)
widgets/CustomIcon.qml (0 hunks)
widgets/StyledShadow.qml (0 hunks)
widgets/StyledText.qml (0 hunks)
windows/Bar/Bar.qml (0 hunks)
windows/Bar/components/ModuleGroup.qml (0 hunks)
windows/Bar/components/Separator.qml (0 hunks)
windows/Bar/modules/ActiveClient.qml (0 hunks)
windows/Bar/modules/Network.qml (0 hunks)
windows/Bar/modules/Notifications.qml (0 hunks)
windows/Bar/modules/OsIcon.qml (0 hunks)
windows/Bar/modules/PowerMenu.qml (0 hunks)
windows/Bar/modules/Spotify.qml (0 hunks)
windows/Bar/modules/Tray.qml (0 hunks)
windows/Bar/modules/Workspaces.qml (0 hunks)
windows/MediaControls/MediaControls.qml (0 hunks)
windows/OnScreenDisplay/OnScreenDisplayVolume.qml (0 hunks)
windows/PowerMenu/PowerMenu.qml (0 hunks)
windows/PowerMenu/components/Profile.qml (0 hunks)

💤 Files with no reviewable changes (22)

.lazy.lua
windows/Bar/modules/OsIcon.qml
windows/Bar/components/ModuleGroup.qml
widgets/StyledShadow.qml
widgets/StyledText.qml
windows/PowerMenu/components/Profile.qml
widgets/CustomIcon.qml
windows/Bar/modules/PowerMenu.qml
windows/Bar/modules/Workspaces.qml
windows/Bar/components/Separator.qml
windows/Bar/modules/ActiveClient.qml
windows/Bar/modules/Notifications.qml
settings/ConfigOptions.qml
windows/Bar/modules/Tray.qml
settings/Appearance.qml
windows/Bar/modules/Spotify.qml
windows/OnScreenDisplay/OnScreenDisplayVolume.qml
services/MediaController.qml
windows/Bar/Bar.qml
windows/Bar/modules/Network.qml
windows/MediaControls/MediaControls.qml
windows/PowerMenu/PowerMenu.qml

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in 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.

## Walkthrough This update restructures a shell UI project by introducing new QML components for bar modules, background, and global styling, while removing or replacing legacy files and centralizing style constants in a new singleton. Several modules, configuration, and appearance files are deleted or replaced. The update also adds Nix development environment files and revises service singletons for audio, network, and Spotify integration. ## Changes | Cohort / File(s) | Change Summary | |---|---| | **Development Environment** `.envrc`, `.gitattributes`, `.gitignore`, `.qmlformat.ini`, `shell.nix` | Added configuration for Nix shell, git LFS for `.jpg`, ignored `.qmlls.ini`, QML formatting rules, and Nix shell environment with Qt 6 declarative. | | **Bar, Background, and Core UI Components (New)** `ShellGlobals.qml`, `background/Background.qml`, `bar/Clock.qml`, `bar/ModuleGroup.qml`, `bar/Network.qml`, `bar/OsIcon.qml`, `bar/Pipewire.qml`, `bar/Spotify.qml`, `bar/Window.qml`, `bar/hyprland/ActiveClient.qml`, `bar/hyprland/Workspace.qml`, `bar/hyprland/Workspaces.qml`, `bar/tray/Tray.qml`, `bar/tray/TrayItem.qml`, `components/StyledIcon.qml`, `components/StyledText.qml`, `components/StyledWindow.qml` | Introduced new QML components for global shell constants, background image, bar modules (clock, network, OS icon, Pipewire, Spotify), window layout, Hyprland integration, tray, and standardized styled icon/text/window components. | | **Service Singletons (Audio, Network, Spotify, SystemInfo)** `services/Audio.qml`, `services/Network.qml`, `services/SpotifyController.qml`, `services/SystemInfo.qml` | Refactored singletons: improved typing and behavior, replaced network type with wifi/ethernet booleans, added Spotify controller for MPRIS, enhanced system info parsing and removed unused code. | | **Legacy, Appearance, and Config (Removed)** `settings/Appearance.qml`, `settings/ConfigOptions.qml`, `widgets/CustomIcon.qml`, `widgets/StyledShadow.qml`, `widgets/StyledText.qml`, `windows/Bar/Bar.qml`, `windows/Bar/components/ModuleGroup.qml`, `windows/Bar/components/Separator.qml`, `windows/Bar/modules/ActiveClient.qml`, `windows/Bar/modules/Network.qml`, `windows/Bar/modules/Notifications.qml`, `windows/Bar/modules/OsIcon.qml`, `windows/Bar/modules/PowerMenu.qml`, `windows/Bar/modules/Spotify.qml`, `windows/Bar/modules/Tray.qml`, `windows/Bar/modules/Workspaces.qml`, `windows/MediaControls/MediaControls.qml`, `windows/OnScreenDisplay/OnScreenDisplayVolume.qml`, `windows/PowerMenu/PowerMenu.qml`, `windows/PowerMenu/components/Profile.qml`, `services/MediaController.qml` | Deleted legacy bar modules, appearance/config singletons, widgets, media controls, on-screen display, power menu, and related components. | | **Shell Entry and Loader** `shell.qml`, `.lazy.lua` | Refactored shell entry to use new bar and background modules, updated imports, changed root element, and simplified language server enablement in `.lazy.lua`. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant ShellRoot participant Bar.Window participant Background participant ShellGlobals participant Services (Audio/Network/Spotify/SystemInfo) User->>ShellRoot: Launch shell.qml ShellRoot->>ShellGlobals: Access global constants ShellRoot->>Bar.Window: Instantiate bar per screen ShellRoot->>Background: Instantiate background if image set Bar.Window->>Services: Query status (audio, network, Spotify, system info) Bar.Window->>ShellGlobals: Read sizes, fonts, colors Bar.Window->>Bar Modules: Render modules (Clock, Network, Pipewire, etc.) Bar.Window->>Tray: Render system tray Bar Modules->>Services: Fetch live data (e.g., network, Spotify) Note right of Bar.Window: Modules update reactively on service changes ``` ## Estimated code review effort 🎯 4 (Complex) | ⏱️ ~45 minutes ## Poem > In the garden of code, a shell takes new shape, > Old modules retire, new rabbits escape. > With backgrounds that shimmer and bars that align, > Spotify dances, the network’s just fine. > Nix brings fresh clover, the tray hops in view— > A shell full of carrots, for rabbits and you! > 🐇🌱   > [!NOTE] > <details open="true"> > <summary>🔌 MCP (Model Context Protocol) integration is now available in Early Access!</summary> > > Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context. > > </details>  --- <details> <summary>📜 Recent review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Free** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 334a95e17009068424797d3beb71eee95be9a19c and 8caffafb4c1e793039ebc5e0a511ef9fba4661fe. </details> <details> <summary>⛔ Files ignored due to path filters (14)</summary> * `assets/icons/arch-symbolic.svg` is excluded by `!**/*.svg` * `assets/icons/github-symbolic.svg` is excluded by `!**/*.svg` * `assets/icons/linux-symbolic.svg` is excluded by `!**/*.svg` * `assets/icons/nixos-symbolic.svg` is excluded by `!**/*.svg` * `assets/icons/spotify.svg` is excluded by `!**/*.svg` * `assets/icons/ubuntu-symbolic.svg` is excluded by `!**/*.svg` * `assets/wallpapers/icelandbeach.jpg` is excluded by `!**/*.jpg` * `assets/wallpapers/icelandbeach2.jpg` is excluded by `!**/*.jpg` * `assets/wallpapers/icelandgeneric.jpg` is excluded by `!**/*.jpg` * `assets/wallpapers/nepalmountainsnight.jpg` is excluded by `!**/*.jpg` * `assets/wallpapers/ocean.jpg` is excluded by `!**/*.jpg` * `assets/wallpapers/scavengersreign1.jpg` is excluded by `!**/*.jpg` * `assets/wallpapers/scavengersreign2.jpg` is excluded by `!**/*.jpg` * `assets/wallpapers/sunnymountains.jpg` is excluded by `!**/*.jpg` </details> <details> <summary>📒 Files selected for processing (49)</summary> * `.envrc` (1 hunks) * `.gitattributes` (1 hunks) * `.gitignore` (1 hunks) * `.lazy.lua` (0 hunks) * `.qmlformat.ini` (1 hunks) * `ShellGlobals.qml` (1 hunks) * `background/Background.qml` (1 hunks) * `bar/Clock.qml` (1 hunks) * `bar/ModuleGroup.qml` (1 hunks) * `bar/Network.qml` (1 hunks) * `bar/OsIcon.qml` (1 hunks) * `bar/Pipewire.qml` (1 hunks) * `bar/Spotify.qml` (1 hunks) * `bar/Window.qml` (1 hunks) * `bar/hyprland/ActiveClient.qml` (1 hunks) * `bar/hyprland/Workspace.qml` (1 hunks) * `bar/hyprland/Workspaces.qml` (1 hunks) * `bar/tray/Tray.qml` (1 hunks) * `bar/tray/TrayItem.qml` (1 hunks) * `components/StyledIcon.qml` (1 hunks) * `components/StyledText.qml` (1 hunks) * `components/StyledWindow.qml` (1 hunks) * `services/Audio.qml` (1 hunks) * `services/MediaController.qml` (0 hunks) * `services/Network.qml` (1 hunks) * `services/SpotifyController.qml` (1 hunks) * `services/SystemInfo.qml` (2 hunks) * `settings/Appearance.qml` (0 hunks) * `settings/ConfigOptions.qml` (0 hunks) * `shell.nix` (1 hunks) * `shell.qml` (1 hunks) * `widgets/CustomIcon.qml` (0 hunks) * `widgets/StyledShadow.qml` (0 hunks) * `widgets/StyledText.qml` (0 hunks) * `windows/Bar/Bar.qml` (0 hunks) * `windows/Bar/components/ModuleGroup.qml` (0 hunks) * `windows/Bar/components/Separator.qml` (0 hunks) * `windows/Bar/modules/ActiveClient.qml` (0 hunks) * `windows/Bar/modules/Network.qml` (0 hunks) * `windows/Bar/modules/Notifications.qml` (0 hunks) * `windows/Bar/modules/OsIcon.qml` (0 hunks) * `windows/Bar/modules/PowerMenu.qml` (0 hunks) * `windows/Bar/modules/Spotify.qml` (0 hunks) * `windows/Bar/modules/Tray.qml` (0 hunks) * `windows/Bar/modules/Workspaces.qml` (0 hunks) * `windows/MediaControls/MediaControls.qml` (0 hunks) * `windows/OnScreenDisplay/OnScreenDisplayVolume.qml` (0 hunks) * `windows/PowerMenu/PowerMenu.qml` (0 hunks) * `windows/PowerMenu/components/Profile.qml` (0 hunks) </details> <details> <summary>💤 Files with no reviewable changes (22)</summary> * .lazy.lua * windows/Bar/modules/OsIcon.qml * windows/Bar/components/ModuleGroup.qml * widgets/StyledShadow.qml * widgets/StyledText.qml * windows/PowerMenu/components/Profile.qml * widgets/CustomIcon.qml * windows/Bar/modules/PowerMenu.qml * windows/Bar/modules/Workspaces.qml * windows/Bar/components/Separator.qml * windows/Bar/modules/ActiveClient.qml * windows/Bar/modules/Notifications.qml * settings/ConfigOptions.qml * windows/Bar/modules/Tray.qml * settings/Appearance.qml * windows/Bar/modules/Spotify.qml * windows/OnScreenDisplay/OnScreenDisplayVolume.qml * services/MediaController.qml * windows/Bar/Bar.qml * windows/Bar/modules/Network.qml * windows/MediaControls/MediaControls.qml * windows/PowerMenu/PowerMenu.qml </details> </details>     --- > [!NOTE] > <details> > <summary>🎁 Summarized by CodeRabbit Free</summary> > > Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting <https://app.coderabbit.ai/login>. > > </details> <details> <summary>🪧 Tips</summary> ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=Kruziikrel13/quickshell&utm_content=11): - 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.` - 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.` ### Support Need help? Join our [Discord community](https://discord.gg/coderabbit) for assistance with any issues or questions. ### 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 sequence diagram` to generate a sequence diagram of the changes in 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements. </details>

No reviewers

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

kruziikrel13/quickshell!11

No description provided.

Rows
Columns