feat: Verify the minimum runtime version supported by the plug-in

In order to better upgrade the plug-in system in the future, plugins are now supported to specify the minimum runtime version that is compatible with running. If not configured, it means that the full version of the plug-in is available

Author: aooohan

cmd/cmd.go

@@ -20,11 +20,12 @@ import (
 	"fmt"
 	"github.com/urfave/cli/v2"
 	"github.com/version-fox/vfox/cmd/commands"
+	"github.com/version-fox/vfox/internal"
 	"os"
 )
 
-func Execute(version string, args []string) {
-	newCmd(version).Execute(args)
+func Execute(args []string) {
+	newCmd().Execute(args)
 }
 
 type cmd struct {
@@ -39,8 +40,8 @@ func (c *cmd) Execute(args []string) {
 	}
 }
 
-func newCmd(version string) *cmd {
-
+func newCmd() *cmd {
+	version := internal.RuntimeVersion
 	cli.VersionFlag = &cli.BoolFlag{
 		Name:    "version",
 		Aliases: []string{"v", "V"},

internal/manager.go

@@ -235,6 +235,11 @@ func (m *Manager) Add(pluginName, url, alias string) error {
 	}
 	defer source.Close()
 
+	// Check if the plugin is compatible with the current runtime
+	if source.MinRuntimeVersion != "" && util.CompareVersion(source.MinRuntimeVersion, RuntimeVersion) > 0 {
+		return fmt.Errorf("check failed: this plugin is not compatible with current vfox (>= %s), please upgrade vfox version to latest", source.MinRuntimeVersion)
+	}
+
 	pname := source.Name
 	if len(alias) > 0 {
 		pname = alias

internal/package.go

@@ -0,0 +1,40 @@
+/*
+ *    Copyright 2024 Han Li and contributors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+package internal
+
+import "path/filepath"
+
+type Package struct {
+	Main       *Info
+	Additional []*Info
+}
+
+type Info struct {
+	Name     string
+	Version  Version
+	Path     string
+	Note     string
+	Checksum *Checksum
+}
+
+func (i *Info) label() string {
+	return i.Name + "@" + string(i.Version)
+}
+
+func (i *Info) storagePath(parentDir string) string {
+	return filepath.Join(parentDir, i.Name+"-"+string(i.Version))
+}

internal/plugin.go

@@ -35,12 +35,13 @@ type LuaPlugin struct {
 	state     *lua.LState
 	pluginObj *lua.LTable
 	// plugin source path
-	SourcePath  string
-	Name        string
-	Author      string
-	Version     string
-	Description string
-	UpdateUrl   string
+	SourcePath        string
+	Name              string
+	Author            string
+	Version           string
+	Description       string
+	UpdateUrl         string
+	MinRuntimeVersion string
 }
 
 func (l *LuaPlugin) checkValid() error {
@@ -365,6 +366,9 @@ func NewLuaPlugin(content, path string, manager *Manager) (*LuaPlugin, error) {
 	if author := PLUGIN.RawGetString("author"); author.Type() != lua.LTNil {
 		source.Author = author.String()
 	}
+	if minRuntimeVersion := PLUGIN.RawGetString("minRuntimeVersion"); minRuntimeVersion.Type() != lua.LTNil {
+		source.MinRuntimeVersion = minRuntimeVersion.String()
+	}
 	return source, nil
 }
 

internal/version.go

@@ -16,25 +16,4 @@
 
 package internal
 
-import "path/filepath"
-
-type Package struct {
-	Main       *Info
-	Additional []*Info
-}
-
-type Info struct {
-	Name     string
-	Version  Version
-	Path     string
-	Note     string
-	Checksum *Checksum
-}
-
-func (i *Info) label() string {
-	return i.Name + "@" + string(i.Version)
-}
-
-func (i *Info) storagePath(parentDir string) string {
-	return filepath.Join(parentDir, i.Name+"-"+string(i.Version))
-}
+const RuntimeVersion = "0.2.3"

main.go

@@ -21,8 +21,6 @@ import (
 	"os"
 )
 
-const Version = "0.2.2"
-
 func main() {
-	cmd.Execute(Version, os.Args)
+	cmd.Execute(os.Args)
 }

template.lua

@@ -17,8 +17,12 @@ PLUGIN = {
     author = "Lihan",
     --- Plugin version
     version = "0.0.1",
+    --- Plugin description
+    description = "xxx",
     -- Update URL
     updateUrl = "{URL}/sdk.lua",
+    -- minimum compatible vfox version
+    minRuntimeVersion = "0.2.2",
 }
 
 --- Returns some pre-installed information, such as version number, download address, local files, etc.