Skip to main content

PluginManifest

Struct PluginManifest 

Source
pub struct PluginManifest {
    pub name: String,
    pub version: String,
    pub description: String,
    pub author: String,
    pub license: String,
    pub plugin_type: String,
    pub runtime: String,
    pub sdk_version: String,
    pub hooks: Vec<String>,
    pub config_schema: Option<Value>,
    pub capabilities: Option<Capabilities>,
    pub homepage: Option<String>,
}
Expand description

Plugin manifest — the on-disk .progit-plugin.json.

Backwards compatible with v0.1 manifests: missing fields fall back to permissive defaults. New plugins should set capabilities explicitly.

Fields§

§name: String

Unique plugin id (also the directory name).

§version: String

Semver of the plugin itself.

§description: String

One-line summary, shown in the plugin browser.

§author: String

Author handle or organisation.

§license: String

SPDX identifier (LSL-1.0, LUL-1.0, Apache-2.0, …).

§plugin_type: String

Free-form classification: notifier | integration | analytics | …

§runtime: String

lua or wasm.

§sdk_version: String

Required SDK API version (">=0.2", "^0.2", "0.2" exact). Defaults to ">=0.1.0" for legacy manifests.

§hooks: Vec<String>

Hooks the plugin claims to implement. Cross-checked against the hooks the Lua / Wasm side actually registers.

§config_schema: Option<Value>

JSON Schema for the plugin’s slice of .project/config.kdl. Treated as opaque JSON until a host-side schema validator lands.

§capabilities: Option<Capabilities>

Capability declaration — what this plugin is allowed to do. Missing = fully permissive (with a deprecation warning).

§homepage: Option<String>

Optional homepage / source URL for the marketplace.

Implementations§

Source§

impl PluginManifest

Source

pub fn load(path: &Path) -> ManifestResult<Self>

Load and parse a manifest from disk.

Source

pub fn from_str(json: &str) -> ManifestResult<Self>

Parse a manifest from a JSON string.

Source

pub fn effective_capabilities(&self) -> Capabilities

Effective capabilities — declared block, or the legacy permissive default. Use this everywhere the runtime asks “may I?”.

Source

pub fn capabilities_implicit(&self) -> bool

Was the capability block omitted? (Used to emit a one-shot deprecation warning on plugin load.)

Source

pub fn check_sdk_compat(&self, sdk_api_version: &str) -> ManifestResult<()>

Reject the plugin if its sdk_version constraint is incompatible with the running SDK’s API version.

Source

pub fn check_hooks(&self, observed: &[&str]) -> ManifestResult<()>

Confirm every hook implemented by the plugin’s runtime side is also declared in the manifest. Caller passes the hooks observed from the Lua/Wasm side.

Trait Implementations§

Source§

impl Clone for PluginManifest

Source§

fn clone(&self) -> PluginManifest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PluginManifest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PluginManifest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PluginManifest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more