feat: show available version if no version provided (version-fox#236)

* feat: show available version if no version provided

* refactor: use pterm confirm

* chore: update print

* refactor: throw error in an elegant way

* refactor: update code

* chore: add license

* feat: collect error

* docs: update docs

Author: bytemain

cmd/commands/install.go

@@ -19,12 +19,14 @@ package commands
 import (
 	"errors"
 	"fmt"
+	"os"
+	"strings"
+
 	"github.com/pterm/pterm"
 	"github.com/urfave/cli/v2"
 	"github.com/version-fox/vfox/internal"
 	"github.com/version-fox/vfox/internal/toolset"
-	"os"
-	"strings"
+	"github.com/version-fox/vfox/internal/util"
 )
 
 var Install = &cli.Command{
@@ -47,32 +49,67 @@ func installCmd(ctx *cli.Context) error {
 		return installAll()
 	}
 
-	sdkArg := ctx.Args().First()
-	if sdkArg == "" {
+	args := ctx.Args()
+	if args.First() == "" {
 		return cli.Exit("sdk name is required", 1)
 	}
-	argArr := strings.Split(sdkArg, "@")
-	argsLen := len(argArr)
+
 	manager := internal.NewSdkManager()
 	defer manager.Close()
-	if argsLen > 2 {
-		return cli.Exit("sdk version is invalid", 1)
-	} else {
-		var name string
-		var version internal.Version
-		if argsLen == 2 {
-			name = strings.ToLower(argArr[0])
-			version = internal.Version(argArr[1])
+
+	errorStore := util.NewErrorStore()
+
+	for i := 0; i < args.Len(); i++ {
+		sdkArg := args.Get(i)
+		argArr := strings.Split(sdkArg, "@")
+		argsLen := len(argArr)
+
+		if argsLen > 2 {
+			errorStore.AddAndShow(sdkArg, fmt.Errorf("your input is invalid: %s", sdkArg))
 		} else {
-			name = strings.ToLower(argArr[0])
-			version = ""
-		}
-		source, err := manager.LookupSdkWithInstall(name)
-		if err != nil {
-			return err
+			var name string
+			var version internal.Version
+			if argsLen == 2 {
+				name = strings.ToLower(argArr[0])
+				version = internal.Version(argArr[1])
+			} else {
+				name = strings.ToLower(argArr[0])
+				version = ""
+			}
+			source, err := manager.LookupSdkWithInstall(name)
+			if err != nil {
+				errorStore.AddAndShow(name, err)
+				continue
+			}
+
+			err = source.Install(version)
+			if errors.Is(err, internal.ErrNoVersionProvided) {
+				showAvailable, _ := pterm.DefaultInteractiveConfirm.Show(fmt.Sprintf("No %s version provided, do you want to select a version to install?", name))
+				if showAvailable {
+					err := RunSearch(name, []string{})
+					if err != nil {
+						errorStore.AddAndShow(name, err)
+					}
+					continue
+				}
+			}
+
+			if err != nil {
+				errorStore.AddAndShow(name, err)
+				continue
+			}
 		}
-		return source.Install(version)
 	}
+
+	notes := errorStore.GetNotesSet()
+
+	if notes.Len() == 1 {
+		return fmt.Errorf("failed to install %s", notes.Slice()[0])
+	} else if notes.Len() > 1 {
+		return fmt.Errorf("failed to install some SDKs: %s", strings.Join(notes.Slice(), ", "))
+	}
+
+	return nil
 }
 
 func installAll() error {

cmd/commands/search.go

@@ -36,18 +36,14 @@ var Search = &cli.Command{
 	Category: CategorySDK,
 }
 
-func searchCmd(ctx *cli.Context) error {
-	sdkName := ctx.Args().First()
-	if sdkName == "" {
-		return cli.Exit("sdk name is required", 1)
-	}
+func RunSearch(sdkName string, availableArgs []string) error {
 	manager := internal.NewSdkManager()
 	defer manager.Close()
 	source, err := manager.LookupSdkWithInstall(sdkName)
 	if err != nil {
 		return fmt.Errorf("%s not supported, error: %w", sdkName, err)
 	}
-	result, err := source.Available(ctx.Args().Tail())
+	result, err := source.Available(availableArgs)
 	if err != nil {
 		return fmt.Errorf("plugin [Available] method error: %w", err)
 	}
@@ -76,17 +72,18 @@ func searchCmd(ctx *cli.Context) error {
 		})
 	}
 
-	highlightOptions := util.NewSet[string]()
+	installedVersions := util.NewSet[string]()
 	for _, version := range source.List() {
-		highlightOptions.Add(string(version))
+		installedVersions.Add(string(version))
 	}
 
 	_, height, _ := terminal.GetSize(int(os.Stdout.Fd()))
 	kvSelect := printer.PageKVSelect{
-		TopText:          "Please select a version of " + sdkName,
+		TopText:          "Please select a version of " + sdkName + " to install",
 		Filter:           true,
 		Size:             int(math.Min(math.Max(float64(height-3), 1), 20)),
-		HighlightOptions: highlightOptions,
+		HighlightOptions: installedVersions,
+		DisabledOptions:  installedVersions,
 		Options:          options,
 		SourceFunc: func(page, size int, options []*printer.KV) ([]*printer.KV, error) {
 			start := page * size
@@ -111,3 +108,11 @@ func searchCmd(ctx *cli.Context) error {
 	}
 	return source.Install(internal.Version(version.Key))
 }
+
+func searchCmd(ctx *cli.Context) error {
+	sdkName := ctx.Args().First()
+	if sdkName == "" {
+		return cli.Exit("sdk name is required", 1)
+	}
+	return RunSearch(sdkName, ctx.Args().Tail())
+}

docs/plugins/create/howto.md

@@ -57,6 +57,8 @@ directory
 in advance. If it is a compressed package such as `tar`, `tar.gz`, `tar.xz`, `zip`, `vfox` will help you to decompress
 it directly.
 
+if the return value of version is empty, it means that the version is not found, and `vfox` will ask the user whether to perform a search operation.
+
 ```lua
 function PLUGIN:PreInstall(ctx)
     --- input parameters

docs/usage/core-commands.md

@@ -42,7 +42,11 @@ vfox i <sdk-name>@<version>
 - `-a, --all`: Install all SDK versions recorded in .tool-versions
 
 ::: tip
-`search` command will retrieve the plugin from the remote repository and add it locally if it is not installed locally.
+You can install multiple SDKs at the same time by separating them with space.
+
+```shell
+vfox install nodejs@20 golang ...
+```
 :::
 
 ## Use

docs/zh-hans/plugins/create/howto.md

@@ -52,6 +52,8 @@
 
 返回预安装信息， 例如具体版本号、下载源等信息。 `vfox`会帮你提前将这些文件下载到特定目录下。如果是压缩包如`tar`、`tar.gz`、`tar.xz`、`zip`这四种压缩包， `vfox`会直接帮你解压处理。
 
+如果版本的返回值为空，表示未找到版本，`vfox`会询问用户是否进行搜索操作。
+
 **位置**: `hooks/pre_install.lua`
 ```lua
 function PLUGIN:PreInstall(ctx)

docs/zh-hans/usage/core-commands.md

@@ -42,7 +42,11 @@ vfox i <sdk-name>@<version>
 - `-a, --all`: 安装 .tool-versions 中记录的所有 SDK 版本
 
 ::: tip 自动安装
-如果本地没有安装 SDK，`install`命令会从远端仓库检索插件并安装到本地。
+你可以一次性安装多个 SDK，通过空格分隔。
+
+```shell
+vfox install nodejs@20 golang ...
+```
 :::
 
 ## Use

internal/interfaces.go

@@ -17,7 +17,8 @@
 package internal
 
 import (
-	"fmt"
+	"errors"
+
 	lua "github.com/yuin/gopher-lua"
 )
 
@@ -105,9 +106,11 @@ type PreInstallHookResult struct {
 	Addition []*PreInstallHookResultAdditionItem `luai:"addition"`
 }
 
+var ErrNoVersionProvided = errors.New("no version number provided")
+
 func (i *PreInstallHookResult) Info() (*Info, error) {
 	if i.Version == "" {
-		return nil, fmt.Errorf("no version number provided")
+		return nil, ErrNoVersionProvided
 	}
 
 	sum := LuaCheckSum{

internal/plugin.go

@@ -20,14 +20,15 @@ import (
 	_ "embed"
 	"errors"
 	"fmt"
+	"path/filepath"
+	"regexp"
+
 	"github.com/pterm/pterm"
 	"github.com/version-fox/vfox/internal/env"
 	"github.com/version-fox/vfox/internal/logger"
 	"github.com/version-fox/vfox/internal/luai"
 	"github.com/version-fox/vfox/internal/util"
 	lua "github.com/yuin/gopher-lua"
-	"path/filepath"
-	"regexp"
 )
 
 const (

internal/printer/select.go

@@ -17,21 +17,25 @@
 package printer
 
 import (
+	"fmt"
+	"sort"
+	"strings"
+
 	"atomicgo.dev/cursor"
 	"atomicgo.dev/keyboard"
 	"atomicgo.dev/keyboard/keys"
-	"fmt"
 	"github.com/lithammer/fuzzysearch/fuzzy"
 	"github.com/pterm/pterm"
 	"github.com/version-fox/vfox/internal/logger"
 	"github.com/version-fox/vfox/internal/util"
-	"sort"
-	"strings"
 )
 
 type PageKVSelect struct {
-	index             int
-	HighlightOptions  util.Set[string]
+	index int
+	// Options to highlight with green color
+	HighlightOptions util.Set[string]
+	// Options to disable
+	DisabledOptions   util.Set[string]
 	Options           []*KV
 	searchOptions     []*KV
 	pageOptions       []*KV
@@ -217,6 +221,9 @@ func (s *PageKVSelect) Show() (*KV, error) {
 		case keys.Enter:
 			if s.index < len(s.pageOptions) {
 				s.result = s.pageOptions[s.index]
+				if (s.result != nil) && s.DisabledOptions.Contains(s.result.Key) {
+					return false, nil
+				}
 			} else {
 				s.result = nil
 				logger.Info("No search, program stopped.")

internal/util/error_store.go

@@ -0,0 +1,71 @@
+/*
+ *    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 util
+
+import "fmt"
+
+type errorItem struct {
+	Note string
+	Err  error
+}
+
+// ErrorStore is a struct that stores errors
+type ErrorStore struct {
+	errors []errorItem
+}
+
+// NewErrorStore creates a new ErrorStore
+func NewErrorStore() *ErrorStore {
+	return &ErrorStore{
+		errors: make([]errorItem, 0),
+	}
+}
+
+// Add adds an error to the store
+func (e *ErrorStore) Add(note string, err error) {
+	e.errors = append(e.errors, errorItem{Note: note, Err: err})
+}
+
+// Add and show in the console
+func (e *ErrorStore) AddAndShow(note string, err error) {
+	e.Add(note, err)
+	fmt.Println(err)
+}
+
+// get all error notes
+func (e *ErrorStore) GetNotes() []string {
+	notes := make([]string, 0, len(e.errors))
+
+	for _, item := range e.errors {
+		notes = append(notes, item.Note)
+	}
+
+	return notes
+}
+
+// get notes set
+func (e *ErrorStore) GetNotesSet() Set[string] {
+	set := NewSet[string]()
+	for _, item := range e.errors {
+		set.Add(item.Note)
+	}
+	return set
+}
+
+func (e *ErrorStore) HasError() bool {
+	return len(e.errors) > 0
+}