vfox 2026.3.1

Interface to vfox plugins
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use mlua::prelude::LuaError;
use mlua::{FromLua, IntoLua, Lua, MultiValue, Value};
use std::path::{Path, PathBuf};

use crate::Plugin;
use crate::error::Result;

#[derive(Debug)]
pub struct LegacyFileContext {
    pub args: Vec<String>,
    pub filepath: PathBuf,
}

#[derive(Debug)]
pub struct ParseLegacyFileResponse {
    pub version: Option<String>,
}

impl Plugin {
    pub async fn parse_legacy_file(&self, legacy_file: &Path) -> Result<ParseLegacyFileResponse> {
        debug!("[vfox:{}] parse_legacy_file", &self.name);
        let ctx = LegacyFileContext {
            args: vec![],
            filepath: legacy_file.to_path_buf(),
        };
        let legacy_file_response = self
            .eval_async(chunk! {
                require "hooks/available"
                require "hooks/parse_legacy_file"
                return PLUGIN:ParseLegacyFile($ctx)
            })
            .await?;

        Ok(legacy_file_response)
    }
}

impl IntoLua for LegacyFileContext {
    fn into_lua(self, lua: &Lua) -> mlua::Result<Value> {
        let table = lua.create_table()?;
        table.set("args", self.args)?;
        table.set(
            "filename",
            self.filepath
                .file_name()
                .ok_or(LuaError::RuntimeError(String::from(
                    "No basename for legacy file",
                )))?
                .to_os_string()
                .into_string()
                .or(Err(LuaError::RuntimeError(String::from(
                    "Could not convert basename to string",
                ))))?,
        )?;
        table.set("filepath", self.filepath.to_string_lossy().to_string())?;
        table.set(
            "getInstalledVersions",
            lua.create_async_function(|lua, _input: MultiValue| async move {
                let plugin_dir = lua.named_registry_value::<PathBuf>("plugin_dir")?;
                Ok(Plugin::from_dir(plugin_dir.as_path())
                    .map_err(|e| LuaError::RuntimeError(e.to_string()))?
                    .available_async()
                    .await
                    .map_err(|e| LuaError::RuntimeError(e.to_string()))?
                    .into_iter()
                    .map(|v| v.version)
                    .collect::<Vec<String>>())
            })?,
        )?;
        Ok(Value::Table(table))
    }
}

impl FromLua for ParseLegacyFileResponse {
    fn from_lua(value: Value, _: &Lua) -> std::result::Result<Self, LuaError> {
        match value {
            Value::Table(table) => Ok(ParseLegacyFileResponse {
                version: table.get::<Option<String>>("version")?,
            }),
            _ => panic!("Expected table"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Vfox;

    #[tokio::test]
    async fn test_parse_legacy_file_test_nodejs() {
        let vfox = Vfox::test();
        let response = vfox
            .parse_legacy_file("test-nodejs", Path::new("test/data/.node-version"))
            .await
            .unwrap();
        let out = format!("{response:?}");
        assert_snapshot!(out, @r###"ParseLegacyFileResponse { version: Some("20.0.0") }"###);
    }

    #[tokio::test]
    async fn test_parse_legacy_file_dummy() {
        let vfox = Vfox::test();
        let response = vfox
            .parse_legacy_file("dummy", Path::new("test/data/.dummy-version"))
            .await
            .unwrap();
        let out = format!("{response:?}");
        assert_snapshot!(out, @r###"ParseLegacyFileResponse { version: Some("1.0.0") }"###);
    }
}