feat: Extend plugin configuration loader to support dynamic levels #107
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, the configuration loader in `BasePlugin` only supported loading plugin configurations from the `plugins` section of the `config.yaml` file. This approach limited flexibility and made it incompatible with new configuration structures.
With this update, the configuration loader now supports additional sections, such as `community-plugins` and `custom-plugins`, while maintaining backward compatibility. Plugins can access their configurations regardless of where they are defined in the file.
- Added dynamic search across multiple levels: `plugins`, `community-plugins`, and `custom-plugins`.
- Ensured `plugins` is prioritized to avoid breaking existing setups.
- Plugins retain access to their full configuration through `self.config`.
How to access configuration in plugins:
- Use `self.config` to retrieve plugin-specific options.
- Example: `self.config.get('active', False)` checks if the plugin is active.
- All configuration options from the corresponding section (e.g., `plugins`, `community-plugins`) are available dynamically.
|
I did some testing from my side but would really appreciate more testing before merging. Specially check the core plugins. |
jeremiah-k
approved these changes
Nov 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The configuration loader in BasePlugin was designed to load plugin configurations exclusively from the plugins section of config.yaml. This approach was rigid and incompatible with newer configuration structures that introduced sections like community-plugins and custom-plugins.
This limitation caused plugins defined outside the plugins section to fail to load their configurations.
Solution
The configuration loader was enhanced to support dynamic levels (plugins, community-plugins, custom-plugins) without breaking existing setups:
Usage
Plugin developers can access their configuration options dynamically through self.config, which contains all the options defined in the configuration file for that plugin.
Example:
Backward Compatibility