vs-plugin-api 0.0.1

Shared plugin models and traits for the vs runtime manager.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

use std::path::Path;

use crate::error::PluginResult;
use crate::model::{AvailableVersion, EnvKey, InstallPlan, InstalledRuntime, PluginManifest};

/// Common runtime interface used by the application layer.
pub trait Plugin {
    /// Returns the immutable plugin manifest.
    fn manifest(&self) -> &PluginManifest;

    /// Lists versions that the plugin can install.
    fn available_versions(&self, args: &[String]) -> PluginResult<Vec<AvailableVersion>>;

    /// Builds an install plan for the requested version.
    fn install_plan(&self, version: &str) -> PluginResult<InstallPlan>;

    /// Runs optional post-install logic after artifacts are materialized.
    fn post_install(&self, _runtime: &InstalledRuntime) -> PluginResult<()> {
        Ok(())
    }

    /// Returns environment keys that should be exported for the installed version.
    fn env_keys(&self, runtime: &InstalledRuntime) -> PluginResult<Vec<EnvKey>>;

    /// Allows a plugin to map the requested version before activation.
    fn pre_use(
        &self,
        _requested_version: &str,
        _scope: &str,
        _cwd: &Path,
        _previous_version: Option<&str>,
        _installed: &[InstalledRuntime],
    ) -> PluginResult<Option<String>> {
        Ok(None)
    }

    /// Attempts to map a legacy file content to a version.
    fn parse_legacy_file(&self, file_name: &str, content: &str) -> PluginResult<Option<String>>;
}