feat(vfox): embed vfox plugin Lua code in binary

.github/workflows/release.yml

@@ -45,6 +45,8 @@ jobs:
             target: armv7-unknown-linux-musleabi
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - name: Install cross
         uses: taiki-e/install-action@0aa4f22591557b744fe31e55dbfcdfea74a073f7 # v2
         with:
@@ -96,6 +98,8 @@ jobs:
           p12-file-base64: ${{ secrets.APPLE_DEVELOPER_ID_APPLICATION_CERTS_P12 }}
           p12-password: ${{ secrets.APPLE_DEVELOPER_ID_APPLICATION_CERTS_P12_PASS }}
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - name: cache crates
         id: cache-crates
         uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
@@ -138,6 +142,8 @@ jobs:
             target: x86_64-pc-windows-msvc
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - run: rustup target add ${{matrix.target}}
       - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
         with:

.github/workflows/test.yml

@@ -29,6 +29,8 @@ jobs:
     timeout-minutes: 60
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
         with:
           shared-key: build
@@ -54,6 +56,8 @@ jobs:
     timeout-minutes: 60
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
         with:
           shared-key: build
@@ -82,6 +86,8 @@ jobs:
       MISE_CACHE_DIR: ~/.cache/mise
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
         with:
           shared-key: build
@@ -118,6 +124,7 @@ jobs:
         with:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.head_ref }}
+          submodules: true
       - uses: taiki-e/install-action@0aa4f22591557b744fe31e55dbfcdfea74a073f7 # v2
         with:
           tool: cargo-deny,cargo-msrv,cargo-machete
@@ -155,6 +162,7 @@ jobs:
         with:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.head_ref }}
+          submodules: true
       - run: rustup default nightly
       - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
         with:
@@ -185,6 +193,7 @@ jobs:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
         with:
           fetch-depth: 0
+          submodules: true
       - name: Install build and test dependencies
         run: |
           sudo apt-get update
@@ -234,6 +243,8 @@ jobs:
       MISE_CACHE_DIR: ~/.cache/mise
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
         with:
           shared-key: unit
@@ -253,6 +264,8 @@ jobs:
       MISE_CACHE_DIR: ~/.cache/mise
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          submodules: true
       - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
         with:
           name: mise-windows-latest

.gitmodules

@@ -0,0 +1,24 @@
+[submodule "crates/vfox/embedded-plugins/vfox-aapt2"]
+	path = crates/vfox/embedded-plugins/vfox-aapt2
+	url = https://github.com/mise-plugins/vfox-aapt2.git
+[submodule "crates/vfox/embedded-plugins/vfox-ag"]
+	path = crates/vfox/embedded-plugins/vfox-ag
+	url = https://github.com/mise-plugins/vfox-ag.git
+[submodule "crates/vfox/embedded-plugins/vfox-android-sdk"]
+	path = crates/vfox/embedded-plugins/vfox-android-sdk
+	url = https://github.com/mise-plugins/vfox-android-sdk.git
+[submodule "crates/vfox/embedded-plugins/vfox-ant"]
+	path = crates/vfox/embedded-plugins/vfox-ant
+	url = https://github.com/mise-plugins/vfox-ant.git
+[submodule "crates/vfox/embedded-plugins/vfox-bfs"]
+	path = crates/vfox/embedded-plugins/vfox-bfs
+	url = https://github.com/mise-plugins/vfox-bfs.git
+[submodule "crates/vfox/embedded-plugins/vfox-bpkg"]
+	path = crates/vfox/embedded-plugins/vfox-bpkg
+	url = https://github.com/mise-plugins/vfox-bpkg.git
+[submodule "crates/vfox/embedded-plugins/vfox-chicken"]
+	path = crates/vfox/embedded-plugins/vfox-chicken
+	url = https://github.com/mise-plugins/vfox-chicken.git
+[submodule "crates/vfox/embedded-plugins/vfox-vlang"]
+	path = crates/vfox/embedded-plugins/vfox-vlang
+	url = https://github.com/mise-plugins/vfox-vlang.git

crates/vfox/Cargo.toml

@@ -7,7 +7,8 @@ description = "Interface to vfox plugins"
 documentation = "https://docs.rs/vfox"
 homepage = "https://github.com/jdx/mise"
 repository = "https://github.com/jdx/mise"
-include = ["src", "lua", "Cargo.toml", "Cargo.lock", "README.md", "LICENSE"]
+include = ["src", "lua", "embedded-plugins", "build.rs", "Cargo.toml", "Cargo.lock", "README.md", "LICENSE"]
+build = "build.rs"
 
 [lib]
 name = "vfox"

crates/vfox/build.rs

@@ -0,0 +1,197 @@
+use std::collections::BTreeMap;
+use std::env;
+use std::fs;
+use std::path::Path;
+
+fn main() {
+    codegen_embedded_plugins();
+}
+
+/// Convert a path to a string with forward slashes (required for include_str! on Windows)
+fn path_to_forward_slashes(path: &Path) -> String {
+    path.to_string_lossy().replace('\\', "/")
+}
+
+fn codegen_embedded_plugins() {
+    let out_dir = env::var_os("OUT_DIR").unwrap();
+    let dest_path = Path::new(&out_dir).join("embedded_plugins.rs");
+
+    let manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
+    let embedded_dir = Path::new(&manifest_dir).join("embedded-plugins");
+
+    // Tell Cargo to re-run if any embedded plugin files change
+    println!("cargo:rerun-if-changed=embedded-plugins");
+
+    if !embedded_dir.exists() {
+        // Generate empty implementation if no embedded plugins
+        let code = r#"
+#[derive(Debug)]
+pub struct EmbeddedPlugin {
+    pub metadata: &'static str,
+    pub hooks: &'static [(&'static str, &'static str)],
+    pub lib: &'static [(&'static str, &'static str)],
+}
+
+pub fn get_embedded_plugin(_name: &str) -> Option<&'static EmbeddedPlugin> {
+    None
+}
+
+pub fn list_embedded_plugins() -> &'static [&'static str] {
+    &[]
+}
+"#;
+        fs::write(&dest_path, code).unwrap();
+        return;
+    }
+
+    let mut plugins: BTreeMap<String, PluginFiles> = BTreeMap::new();
+
+    // Scan for plugin directories
+    for entry in fs::read_dir(&embedded_dir).unwrap() {
+        let entry = entry.unwrap();
+        let path = entry.path();
+        if !path.is_dir() {
+            continue;
+        }
+
+        let dir_name = path.file_name().unwrap().to_string_lossy().to_string();
+        if !dir_name.starts_with("vfox-") {
+            continue;
+        }
+
+        // Tell Cargo to re-run if this plugin directory changes
+        println!("cargo:rerun-if-changed={}", path.display());
+
+        let plugin = collect_plugin_files(&path);
+        plugins.insert(dir_name, plugin);
+    }
+
+    // Generate Rust code
+    let mut code = String::new();
+
+    // Struct definition
+    code.push_str(
+        r#"
+#[derive(Debug)]
+pub struct EmbeddedPlugin {
+    pub metadata: &'static str,
+    pub hooks: &'static [(&'static str, &'static str)],
+    pub lib: &'static [(&'static str, &'static str)],
+}
+
+"#,
+    );
+
+    // Generate static instances for each plugin
+    for (name, files) in &plugins {
+        let var_name = name.replace('-', "_").to_uppercase();
+        code.push_str(&format!(
+            "static {var_name}: EmbeddedPlugin = EmbeddedPlugin {{\n"
+        ));
+
+        // Metadata - use absolute path with forward slashes for cross-platform include_str!
+        let metadata_path = embedded_dir.join(name).join("metadata.lua");
+        code.push_str(&format!(
+            "    metadata: include_str!(\"{}\"),\n",
+            path_to_forward_slashes(&metadata_path)
+        ));
+
+        // Hooks
+        code.push_str("    hooks: &[\n");
+        for hook in &files.hooks {
+            let hook_path = embedded_dir
+                .join(name)
+                .join("hooks")
+                .join(format!("{}.lua", hook));
+            code.push_str(&format!(
+                "        (\"{}\", include_str!(\"{}\")),\n",
+                hook,
+                path_to_forward_slashes(&hook_path)
+            ));
+        }
+        code.push_str("    ],\n");
+
+        // Lib files
+        code.push_str("    lib: &[\n");
+        for lib in &files.lib {
+            let lib_path = embedded_dir
+                .join(name)
+                .join("lib")
+                .join(format!("{}.lua", lib));
+            code.push_str(&format!(
+                "        (\"{}\", include_str!(\"{}\")),\n",
+                lib,
+                path_to_forward_slashes(&lib_path)
+            ));
+        }
+        code.push_str("    ],\n");
+
+        code.push_str("};\n\n");
+    }
+
+    // Generate lookup function
+    code.push_str("pub fn get_embedded_plugin(name: &str) -> Option<&'static EmbeddedPlugin> {\n");
+    code.push_str("    match name {\n");
+    for name in plugins.keys() {
+        let var_name = name.replace('-', "_").to_uppercase();
+        let short_name = name.strip_prefix("vfox-").unwrap_or(name);
+        code.push_str(&format!(
+            "        \"{}\" | \"{}\" => Some(&{}),\n",
+            name, short_name, var_name
+        ));
+    }
+    code.push_str("        _ => None,\n");
+    code.push_str("    }\n");
+    code.push_str("}\n\n");
+
+    // Generate list function
+    code.push_str("pub fn list_embedded_plugins() -> &'static [&'static str] {\n");
+    code.push_str("    &[\n");
+    for name in plugins.keys() {
+        code.push_str(&format!("        \"{}\",\n", name));
+    }
+    code.push_str("    ]\n");
+    code.push_str("}\n");
+
+    fs::write(&dest_path, code).unwrap();
+}
+
+struct PluginFiles {
+    hooks: Vec<String>,
+    lib: Vec<String>,
+}
+
+fn collect_plugin_files(plugin_dir: &Path) -> PluginFiles {
+    let mut hooks = Vec::new();
+    let mut lib = Vec::new();
+
+    // Collect hooks
+    let hooks_dir = plugin_dir.join("hooks");
+    if hooks_dir.exists() {
+        for entry in fs::read_dir(&hooks_dir).unwrap() {
+            let entry = entry.unwrap();
+            let path = entry.path();
+            if path.extension().is_some_and(|ext| ext == "lua") {
+                let name = path.file_stem().unwrap().to_string_lossy().to_string();
+                hooks.push(name);
+            }
+        }
+    }
+    hooks.sort();
+
+    // Collect lib files
+    let lib_dir = plugin_dir.join("lib");
+    if lib_dir.exists() {
+        for entry in fs::read_dir(&lib_dir).unwrap() {
+            let entry = entry.unwrap();
+            let path = entry.path();
+            if path.extension().is_some_and(|ext| ext == "lua") {
+                let name = path.file_stem().unwrap().to_string_lossy().to_string();
+                lib.push(name);
+            }
+        }
+    }
+    lib.sort();
+
+    PluginFiles { hooks, lib }
+}

crates/vfox/src/embedded_plugins.rs

@@ -0,0 +1,4 @@
+// This module provides access to embedded vfox plugin Lua code.
+// The actual code is generated at build time by build.rs
+
+include!(concat!(env!("OUT_DIR"), "/embedded_plugins.rs"));

crates/vfox/src/lib.rs

@@ -13,6 +13,7 @@ pub use vfox::Vfox;
 
 mod config;
 mod context;
+pub mod embedded_plugins;
 mod error;
 mod hooks;
 mod http;