coderabbitai[bot]
commented
5 months ago Walkthrough
The overall change introduces a new SidebarService interface to handle sidebar integrations, modifies the module-info.java to include this new service, and updates the version in pom.xml to reflect these changes. New methods and an exception class streamline the addition and removal of sidebar entries, enhancing the sidebar feature integration.
Changes
| Files | Change Summary |
|---|---|
pom.xml |
Updated version from 1.4.0-SNAPSHOT to 1.4.0-sidebar. |
src/main/java/module-info.java |
Added import for SidebarService, exported the new package, and declared usage of SidebarService. |
src/main/java/org/cryptomator/integrations/sidebar/... |
Introduced SidebarService interface, methods for sidebar entry management, and the new exception class SidebarServiceException. |
Sequence Diagram(s)
sequenceDiagram
participant Client
participant SidebarService
participant FileManager
Client->>SidebarService: add(target, displayName)
SidebarService-->>FileManager: Integrate target into sidebar
FileManager-->>SidebarService: Success/Error
SidebarService-->>Client: SidebarEntry/Exception
Client->>SidebarService: SidebarEntry.remove()
SidebarService-->>FileManager: Remove entry from sidebar
FileManager-->>SidebarService: Success/Error
SidebarService-->>Client: Confirmation/ExceptionPoem
From
SNAPSHOTtosidebar, our code does grow,
With paths to the quick bar, new features to show.
Services to add, and entries to weave,
Through the file manager’s leaves, quick as a breeze.
🐰✨ Here’s to the journey of bytes well-spun,
A hop for the code, and progress begun! 🌟
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?
infeo
This is a proposal for an new SPI: The
SidebarSPI.This spi is intended to allow an application to add an entry to the filemanager sidebar/navigation pane/bookmark section/etc, such that a user can easily access a certain path (e.g. mounted vault).
The SPI is kept simple: Only a single service, namely the
SidebarServiceoffering a single functionadd(target, displayName)to add an entry to the filemanager sidebar. The function returns an object (SidebarEntry), which is used to remove the entry again. The methods throw an service specificSidebarServiceException.