b5292f54aa
Implements a plugin system for ZeroClaw modeled after OpenClaw's architecture. Key components: - Plugin trait and PluginApi for registering tools/hooks - Plugin manifest (zeroclaw.plugin.toml) for metadata - Plugin discovery from bundled, global, and workspace directories - PluginRegistry managing loaded plugins, tools, and hooks - Error isolation via panic catching in register() - Config integration via [plugins] section Example plugin included in extensions/hello-world/. Closes #1414 # Conflicts: # src/config/mod.rs # src/config/schema.rs
71 lines
2.0 KiB
Rust
71 lines
2.0 KiB
Rust
//! Plugin system for ZeroClaw.
|
|
//!
|
|
//! Modeled after OpenClaw's plugin architecture, adapted for Rust:
|
|
//!
|
|
//! - **Manifest**: each plugin has a `zeroclaw.plugin.toml` descriptor
|
|
//! - **Discovery**: scans bundled, global (`~/.zeroclaw/extensions/`), and
|
|
//! workspace (`.zeroclaw/extensions/`) directories
|
|
//! - **Registry**: collects loaded plugins, their tools, hooks, and diagnostics
|
|
//! - **PluginApi**: passed to `Plugin::register()` so plugins can register
|
|
//! tools, hooks, and services without knowing the host internals
|
|
//! - **Error isolation**: panics inside plugin `register()` are caught and
|
|
//! recorded as diagnostics rather than crashing the host
|
|
//!
|
|
//! # Quick start
|
|
//!
|
|
//! ```rust,ignore
|
|
//! use zeroclaw::plugins::{Plugin, PluginApi, PluginManifest};
|
|
//!
|
|
//! pub struct MyPlugin { manifest: PluginManifest }
|
|
//!
|
|
//! impl Plugin for MyPlugin {
|
|
//! fn manifest(&self) -> &PluginManifest { &self.manifest }
|
|
//! fn register(&self, api: &mut PluginApi) -> anyhow::Result<()> {
|
|
//! api.register_tool(Box::new(MyTool));
|
|
//! Ok(())
|
|
//! }
|
|
//! }
|
|
//! ```
|
|
//!
|
|
//! Then in your `config.toml`:
|
|
//!
|
|
//! ```toml
|
|
//! [plugins]
|
|
//! enabled = true
|
|
//!
|
|
//! [plugins.entries.my-plugin]
|
|
//! enabled = true
|
|
//! ```
|
|
|
|
pub mod discovery;
|
|
pub mod loader;
|
|
pub mod manifest;
|
|
pub mod registry;
|
|
pub mod traits;
|
|
|
|
pub use discovery::discover_plugins;
|
|
pub use loader::load_plugins;
|
|
pub use manifest::{PluginManifest, PLUGIN_MANIFEST_FILENAME};
|
|
pub use registry::{
|
|
DiagnosticLevel, PluginDiagnostic, PluginHookRegistration, PluginOrigin, PluginRecord,
|
|
PluginRegistry, PluginStatus, PluginToolRegistration,
|
|
};
|
|
pub use traits::{Plugin, PluginApi, PluginLogger};
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn module_reexports_are_accessible() {
|
|
let _manifest = PluginManifest {
|
|
id: "test".into(),
|
|
name: None,
|
|
description: None,
|
|
version: None,
|
|
config_schema: None,
|
|
};
|
|
assert_eq!(PLUGIN_MANIFEST_FILENAME, "zeroclaw.plugin.toml");
|
|
}
|
|
}
|