chore: Create GitHub action for vfox.rs tests

.github/workflows/test-vfox.yml

@@ -0,0 +1,33 @@
+name: test-vfox
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+concurrency:
+  group: test-vfox-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  "test-vfox":
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: Swatinem/rust-cache@v2
+      - run: |
+          cargo build --all-features
+          echo "$PWD/target/debug" >> "$GITHUB_PATH"
+      - run: mise -v
+      - run: mise --cd crates/vfox install
+      - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
+        with:
+          key: ${{ runner.os }}-${{ runner.arch }}-mise-tools-vfox-${{ hashFiles('crates/vfox/mise.toml') }}
+          path: |
+            ~/.local/share/mise
+            ~/.cache/mise
+      - run: mise --cd crates/vfox run build
+      - run: mise --cd crates/vfox run lint
+      - run: mise --cd crates/vfox run test

crates/vfox/.cargo/config.toml

@@ -0,0 +1,2 @@
+[env]
+RUST_TEST_THREADS = '1'

crates/vfox/.gitignore

@@ -0,0 +1 @@
+test/downloads

crates/vfox/.prettierignore

@@ -0,0 +1 @@
+plugins/nodejs

crates/vfox/mise.toml

@@ -0,0 +1,30 @@
+[tools]
+"cargo-binstall" = "latest"
+"cargo:cargo-edit" = "latest"
+"cargo:git-cliff" = "latest"
+"npm:prettier" = "latest"
+
+[tasks.build]
+run = "cargo build"
+[tasks.test]
+alias = "t"
+depends = ['test:setup-plugins']
+run = "cargo test"
+[tasks."test:setup-plugins"]
+run = [
+  "mkdir -p plugins",
+  "test -d plugins/nodejs || git clone https://github.com/version-fox/vfox-nodejs plugins/nodejs",
+  "test -d plugins/cmake || git clone https://github.com/version-fox/vfox-cmake plugins/cmake",
+]
+[tasks.lint-fix]
+run = "cargo fmt --all && cargo clippy --fix --all --all-features --allow-dirty --allow-staged -- -D warnings"
+[tasks.lint]
+depends = ['lint:prettier', 'lint:clippy', 'lint:fmt']
+[tasks."lint:prettier"]
+run = "prettier -c ."
+[tasks."lint:clippy"]
+run = 'cargo clippy --all-features -- -D warnings'
+[tasks."lint:fmt"]
+run = 'cargo fmt --all -- --check'
+[tasks.pre-commit]
+depends = ['lint:*']

crates/vfox/plugins/.gitignore

@@ -0,0 +1,2 @@
+cmake
+nodejs

crates/vfox/plugins/dummy/Injection.lua

@@ -0,0 +1,15 @@
+--[[
+Do not change any thing in the current file,
+it's just there to show what objects are injected by vfox and what they do.
+
+It's just handy when developing plugins, IDE can use this object for code hints!
+ --]]
+RUNTIME = {
+    --- Operating system type at runtime (Windows, Linux, Darwin)
+    osType = "",
+    --- Operating system architecture at runtime (amd64, arm64, etc.)
+    archType = "",
+    --- vfox runtime version
+    version = "",
+}
+

crates/vfox/plugins/dummy/README.md

@@ -0,0 +1,16 @@
+# vfox-nodejs
+
+Node.js plugin for [vfox](https://vfox.lhan.me/).
+
+## Install
+
+After installing [vfox](https://github.com/version-fox/vfox), install the plugin by running:
+
+```bash
+vfox add nodejs
+```
+
+## Mirror
+
+You can configure the mirror by `VFOX_NODEJS_MIRROR` environment variable. The default value
+is `https://nodejs.org/dist/`.

crates/vfox/plugins/dummy/hooks/available.lua

@@ -0,0 +1,13 @@
+--- Return all available versions provided by this plugin
+--- @param ctx table Empty table used as context, for future extension
+--- @return table Descriptions of available versions and accompanying tool descriptions
+function PLUGIN:Available(ctx)
+    return {
+        {
+            version = "1.0.0",
+        },
+        {
+            version = "1.0.1",
+        },
+    }
+end

crates/vfox/plugins/dummy/hooks/env_keys.lua

@@ -0,0 +1,25 @@
+--- Each SDK may have different environment variable configurations.
+--- This allows plugins to define custom environment variables (including PATH settings)
+--- Note: Be sure to distinguish between environment variable settings for different platforms!
+--- @param ctx table Context information
+--- @field ctx.path string SDK installation directory
+function PLUGIN:EnvKeys(ctx)
+    --- this variable is same as ctx.sdkInfo['plugin-name'].path
+    local version_path = ctx.path
+    if RUNTIME.osType == "windows" then
+        return {
+            {
+                key = "PATH",
+                value = version_path
+            },
+        }
+    else
+        return {
+            {
+                key = "PATH",
+                value = version_path .. "/bin"
+            },
+        }
+    end
+
+end

crates/vfox/plugins/dummy/hooks/parse_legacy_file.lua

@@ -0,0 +1,22 @@
+--- Parse legacy version files like .node-version, .nvmrc, etc.
+--- @param ctx table Context information
+--- @field ctx.filepath string Path to the legacy file
+--- @return table Version information
+function PLUGIN:ParseLegacyFile(ctx)
+    local filepath = ctx.filepath
+    local content = io.open(filepath, "r")
+    if content then
+        local version = content:read("*line")
+        content:close()
+        if version then
+            -- Remove any "v" prefix and trim whitespace
+            version = version:gsub("^v", ""):match("^%s*(.-)%s*$")
+            return {
+                version = version
+            }
+        end
+    end
+    return {
+        version = nil
+    }
+end 

crates/vfox/plugins/dummy/hooks/post_install.lua

@@ -0,0 +1,11 @@
+function PLUGIN:PostInstall(ctx)
+    --- SDK installation root path
+    local rootPath = ctx.rootPath
+    local runtimeVersion = ctx.runtimeVersion
+    --- Other SDK information, the `addition` field returned in PreInstall, obtained by name
+    --TODO
+    --local sdkInfo = ctx.sdkInfo['dummy']
+    --local path = sdkInfo.path
+    --local version = sdkInfo.version
+    --local name = sdkInfo.name
+end

crates/vfox/plugins/dummy/hooks/pre_install.lua

@@ -0,0 +1,12 @@
+--- Returns some pre-installed information, such as version number, download address, local files, etc.
+--- If checksum is provided, vfox will automatically check it for you.
+--- @param ctx table
+--- @field ctx.version string User-input version
+--- @return table Version information
+function PLUGIN:PreInstall(ctx)
+    local version = ctx.version
+
+    return {
+        version = version,
+    }
+end

crates/vfox/plugins/dummy/metadata.lua

@@ -0,0 +1,26 @@
+--- !!! DO NOT EDIT OR RENAME !!!
+PLUGIN = {}
+
+--- !!! MUST BE SET !!!
+--- Plugin name
+PLUGIN.name = "dummy"
+--- Plugin version
+PLUGIN.version = "0.3.0"
+--- Plugin repository
+PLUGIN.homepage = "https://github.com/version-fox/vfox-nodejs"
+--- Plugin license
+PLUGIN.license = "Apache 2.0"
+--- Plugin description
+PLUGIN.description = "Dummy plugin for testing."
+
+--- !!! OPTIONAL !!!
+--- minimum compatible vfox version
+PLUGIN.minRuntimeVersion = "0.3.0"
+--- Some things that need user to be attention!
+PLUGIN.notes = {}
+
+--- List legacy configuration filenames for determining the specified version of the tool.
+--- such as ".node-version", ".nvmrc", etc.
+PLUGIN.legacyFilenames = {
+    ".dummy-version",
+}

crates/vfox/plugins/hooks/available.lua

@@ -0,0 +1,13 @@
+--- Return all available versions provided by this plugin
+--- @param ctx table Empty table used as context, for future extension
+--- @return table Descriptions of available versions and accompanying tool descriptions
+function PLUGIN:Available(ctx)
+    return {
+        {
+            version = "1.0.0",
+        },
+        {
+            version = "1.0.1",
+        },
+    }
+end

crates/vfox/plugins/hooks/env_keys.lua

@@ -0,0 +1,25 @@
+--- Each SDK may have different environment variable configurations.
+--- This allows plugins to define custom environment variables (including PATH settings)
+--- Note: Be sure to distinguish between environment variable settings for different platforms!
+--- @param ctx table Context information
+--- @field ctx.path string SDK installation directory
+function PLUGIN:EnvKeys(ctx)
+    --- this variable is same as ctx.sdkInfo['plugin-name'].path
+    local version_path = ctx.path
+    if RUNTIME.osType == "windows" then
+        return {
+            {
+                key = "PATH",
+                value = version_path
+            },
+        }
+    else
+        return {
+            {
+                key = "PATH",
+                value = version_path .. "/bin"
+            },
+        }
+    end
+
+end

crates/vfox/plugins/hooks/post_install.lua

@@ -0,0 +1,11 @@
+function PLUGIN:PostInstall(ctx)
+    --- SDK installation root path
+    local rootPath = ctx.rootPath
+    local runtimeVersion = ctx.runtimeVersion
+    --- Other SDK information, the `addition` field returned in PreInstall, obtained by name
+    --TODO
+    --local sdkInfo = ctx.sdkInfo['dummy']
+    --local path = sdkInfo.path
+    --local version = sdkInfo.version
+    --local name = sdkInfo.name
+end

crates/vfox/plugins/hooks/pre_install.lua

@@ -0,0 +1,12 @@
+--- Returns some pre-installed information, such as version number, download address, local files, etc.
+--- If checksum is provided, vfox will automatically check it for you.
+--- @param ctx table
+--- @field ctx.version string User-input version
+--- @return table Version information
+function PLUGIN:PreInstall(ctx)
+    local version = ctx.version
+
+    return {
+        version = version,
+    }
+end

crates/vfox/src/hooks/parse_legacy_file.rs

@@ -84,4 +84,15 @@ mod tests {
         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") }"###);
+    }
 }

crates/vfox/test/data/.dummy-version

@@ -0,0 +1 @@
+1.0.0