refactor: cli (#1092)

# Description

refactor CLI

## gen

- Replace language-based configuration (`lang`) with runtime-based
configuration (`runtime`), enabling support for multiple runtime
environments like "node" and "go"
- improve error handling, refactor serverless function registration, and
enhance build and run processes for better clarity and usability.

---------

Co-authored-by: woorui <[email protected]>

Author: venjiang

cli/build.go

@@ -26,32 +26,28 @@ import (
 
 // buildCmd represents the build command
 var buildCmd = &cobra.Command{
-	Use:   "build [flags] app.go",
+	Use:   "build [flags]",
 	Short: "Build the YoMo Stream Function",
 	Long:  "Build the YoMo Stream Function",
 	Run: func(cmd *cobra.Command, args []string) {
-		if err := parseFileArg(args, &opts, defaultSFNSourceTSFile); err != nil {
+		loadOptionsFromViper(viper.BuildViper, &opts)
+		if err := parseFileArg(&opts); err != nil {
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			os.Exit(127)
-			// return
 		}
-		loadOptionsFromViper(viper.BuildViper, &opts)
-
-		log.InfoStatusEvent(os.Stdout, "YoMo Stream Function file: %v", opts.Filename)
+		log.InfoStatusEvent(os.Stdout, "YoMo Stream Function runtime: %v", opts.Runtime)
 		log.InfoStatusEvent(os.Stdout, "YoMo Stream Function parsing...")
 		s, err := serverless.Create(&opts)
 		if err != nil {
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			os.Exit(127)
-			// return
 		}
 		log.InfoStatusEvent(os.Stdout, "YoMo Stream Function parse done.")
 		// build
 		log.PendingStatusEvent(os.Stdout, "Building YoMo Stream Function instance...")
 		if err := s.Build(true); err != nil {
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			os.Exit(127)
-			// return
 		}
 		log.SuccessStatusEvent(os.Stdout, "YoMo Stream Function build successful!")
 	},
@@ -61,6 +57,7 @@ func init() {
 	rootCmd.AddCommand(buildCmd)
 
 	buildCmd.Flags().StringVarP(&opts.ModFile, "modfile", "m", "", "custom go.mod")
+	buildCmd.Flags().StringVarP(&opts.Runtime, "runtime", "r", "node", "serverless runtime type")
 
 	viper.BindPFlags(viper.BuildViper, buildCmd.Flags())
 }

cli/cli.go

@@ -3,6 +3,7 @@
 package cli
 
 import (
+	"errors"
 	"fmt"
 	"path"
 	"path/filepath"
@@ -21,7 +22,6 @@ const (
 	defaultSFNSourceTSFile     = "src/app.ts"
 	defaultSFNTestSourceFile   = "app_test.go"
 	defaultSFNTestSourceTSFile = "app_test.ts"
-	defaultSFNCompliedFile     = "sfn.yomo"
 )
 
 // GetRootPath get root path
@@ -64,24 +64,19 @@ func loadOptionsFromViper(v *viper.Viper, opts *serverless.Options) {
 	opts.Runtime = v.GetString("runtime")
 }
 
-// parseFileArg parses the filename from command line arguments or uses default files if none provided.
-// It updates the given serverless.Options with the filename and validates it via checkOptions.
-// Returns nil if a valid filename is found, otherwise continues trying default files.
-func parseFileArg(args []string, opts *serverless.Options, defaultFiles ...string) error {
-	// parse filename from args, like `yomo run app.go`
-	if len(args) >= 1 && args[0] != "" {
-		opts.Filename = args[0]
-		return checkOptions(opts)
+// parseFileArg parses the file argument and sets the default file name based on the runtime
+func parseFileArg(opts *serverless.Options) error {
+	runtime := opts.Runtime
+	if runtime == "" {
+		return errors.New("runtime is not specified, please use `-r` flag to specify the runtime")
 	}
-	// if no filename is provided, use the default files
-	for _, f := range defaultFiles {
-		opts.Filename = f
-		err := checkOptions(opts)
-		if err == nil {
-			break
-		}
+	switch runtime {
+	case "go": // go
+		opts.Filename = defaultSFNSourceFile
+	default: // node
+		opts.Filename = defaultSFNSourceTSFile
 	}
-	return nil
+	return checkOptions(opts)
 }
 
 func checkOptions(opts *serverless.Options) error {
@@ -96,22 +91,22 @@ func checkOptions(opts *serverless.Options) error {
 	return nil
 }
 
-// DefaultSFNSourceFile returns the default source file name for the given language
-func DefaultSFNSourceFile(lang string) string {
-	switch lang {
-	case "node":
-		return defaultSFNSourceTSFile
-	default:
+// DefaultSFNSourceFile returns the default source file name for the given runtime
+func DefaultSFNSourceFile(runtime string) string {
+	switch runtime {
+	case "go": // go
 		return defaultSFNSourceFile
+	default: // node
+		return defaultSFNSourceTSFile
 	}
 }
 
 // DefaultSFNTestSourceFile returns the default test source file name
-func DefaultSFNTestSourceFile(lang string) string {
-	switch lang {
-	case "node":
-		return defaultSFNTestSourceTSFile
-	default:
+func DefaultSFNTestSourceFile(runtime string) string {
+	switch runtime {
+	case "go": // go
 		return defaultSFNTestSourceFile
+	default: // node
+		return defaultSFNTestSourceTSFile
 	}
 }

cli/dev.go

@@ -17,7 +17,6 @@ package cli
 
 import (
 	"os"
-	"path/filepath"
 
 	"github.com/spf13/cobra"
 	"github.com/yomorun/yomo/cli/serverless"
@@ -30,13 +29,14 @@ var devCmd = &cobra.Command{
 	Use:                "dev [flags]",
 	Short:              "Test a YoMo Stream Function",
 	Long:               "Test a YoMo Stream Function with public zipper and mocking data",
+	Hidden:             true,
 	FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
 	Run: func(cmd *cobra.Command, args []string) {
-		if err := parseFileArg(args, &opts, defaultSFNCompliedFile, defaultSFNSourceFile); err != nil {
+		loadOptionsFromViper(viper.RunViper, &opts)
+		if err := parseFileArg(&opts); err != nil {
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			return
 		}
-		loadOptionsFromViper(viper.RunViper, &opts)
 		// Serverless
 		log.InfoStatusEvent(os.Stdout, "YoMo Stream Function file: %v", opts.Filename)
 		// resolve serverless
@@ -55,23 +55,19 @@ var devCmd = &cobra.Command{
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			return
 		}
-		if !s.Executable() {
-			log.FailureStatusEvent(os.Stdout,
-				"You cannot run `%s` directly. build first with the `yomo build %s` command and then run with the 'yomo run %s' command.",
-				opts.Filename,
-				opts.Filename,
-				opts.Filename,
-			)
-			return
-		}
-		// build if it's go file
-		if ext := filepath.Ext(opts.Filename); ext == ".go" {
+
+		// if has `--production` flag, skip s.Build() process
+		isProduction := opts.Production
+		if !isProduction {
+			// build
 			log.PendingStatusEvent(os.Stdout, "Building YoMo Stream Function instance...")
 			if err := s.Build(true); err != nil {
 				log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 				os.Exit(127)
 			}
 			log.SuccessStatusEvent(os.Stdout, "YoMo Stream Function build successful!")
+		} else {
+			log.InfoStatusEvent(os.Stdout, "YoMo Serverless LLM Function is running in [production] mode")
 		}
 		// run
 		log.InfoStatusEvent(
@@ -91,6 +87,8 @@ func init() {
 	rootCmd.AddCommand(devCmd)
 
 	devCmd.Flags().StringVarP(&opts.ModFile, "modfile", "m", "", "custom go.mod")
+	devCmd.Flags().StringVarP(&opts.Runtime, "runtime", "r", "node", "serverless runtime type")
+	devCmd.Flags().BoolVarP(&opts.Production, "production", "p", false, "run in production mode, skip the build process")
 
 	viper.BindPFlags(viper.DevViper, devCmd.Flags())
 }

cli/init.go

@@ -25,14 +25,12 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/yomorun/yomo/cli/serverless"
 	"github.com/yomorun/yomo/cli/template"
+	"github.com/yomorun/yomo/cli/viper"
 	"github.com/yomorun/yomo/pkg/file"
 	"github.com/yomorun/yomo/pkg/log"
 )
 
-var (
-	sfnType string
-	lang    string
-)
+var sfnType string
 
 // initCmd represents the init command
 var initCmd = &cobra.Command{
@@ -46,18 +44,21 @@ var initCmd = &cobra.Command{
 			opts.Name = name
 		}
 		if name == "" {
-			log.FailureStatusEvent(os.Stdout, "Please input your app name, e.g. `yomo init my-tool [-l node -t llm]`")
+			log.FailureStatusEvent(os.Stdout, "Please input your app name, e.g. `yomo init my-tool [-r node -t llm]`")
 			return
 		}
-		log.PendingStatusEvent(os.Stdout, "Initializing the Serverless LLM Function...")
+
+		loadOptionsFromViper(viper.InitViper, &opts)
+
+		log.PendingStatusEvent(os.Stdout, "Initializing the Serverless LLM Function with [%s] runtime...", opts.Runtime)
 		name = strings.ReplaceAll(name, " ", "_")
 
-		filename := filepath.Join(name, DefaultSFNSourceFile(lang))
+		filename := filepath.Join(name, DefaultSFNSourceFile(opts.Runtime))
 		opts.Filename = filename
 
 		// create app source file
-		fname := filepath.Join(name, DefaultSFNSourceFile(lang))
-		contentTmpl, err := template.GetContent("init", sfnType, lang, false)
+		fname := filepath.Join(name, DefaultSFNSourceFile(opts.Runtime))
+		contentTmpl, err := template.GetContent("init", sfnType, opts.Runtime, false)
 		if err != nil {
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			return
@@ -73,8 +74,8 @@ var initCmd = &cobra.Command{
 			return
 		}
 		// create app test file
-		testName := filepath.Join(name, DefaultSFNTestSourceFile(lang))
-		testTmpl, err := template.GetContent("init", sfnType, lang, true)
+		testName := filepath.Join(name, DefaultSFNTestSourceFile(opts.Runtime))
+		testTmpl, err := template.GetContent("init", sfnType, opts.Runtime, true)
 		if err != nil {
 			if !errors.Is(err, template.ErrUnsupportedTest) {
 				log.FailureStatusEvent(os.Stdout, "%s", err.Error())
@@ -88,7 +89,11 @@ var initCmd = &cobra.Command{
 		}
 		// create .env
 		fname = filepath.Join(name, ".env")
-		if err := file.PutContents(fname, []byte(fmt.Sprintf("YOMO_SFN_NAME=%s\nYOMO_SFN_ZIPPER=localhost:9000\n", name))); err != nil {
+		var sb strings.Builder
+		sb.WriteString(fmt.Sprintf("YOMO_SFN_RUNTIME=%s\n", opts.Runtime))
+		sb.WriteString(fmt.Sprintf("YOMO_SFN_NAME=%s\n", name))
+		sb.WriteString(fmt.Sprintf("YOMO_SFN_ZIPPER=%s\n", "localhost:9000"))
+		if err := file.PutContents(fname, []byte(sb.String())); err != nil {
 			log.FailureStatusEvent(os.Stdout, "Write Serverless LLM Function .env file failure with the error: %v", err)
 			return
 		}
@@ -103,5 +108,7 @@ func init() {
 	rootCmd.AddCommand(initCmd)
 
 	initCmd.Flags().StringVarP(&sfnType, "type", "t", "llm", "The type of Serverless LLM Function, support normal and llm")
-	initCmd.Flags().StringVarP(&lang, "lang", "l", "node", "The language of Serverless LLM Function, support go and node")
+	initCmd.Flags().StringVarP(&opts.Runtime, "runtime", "r", "node", "serverless runtime type, support node and go")
+
+	viper.BindPFlags(viper.InitViper, initCmd.Flags())
 }

cli/run.go

@@ -23,7 +23,6 @@ import (
 
 	// serverless registrations
 	"github.com/yomorun/yomo/cli/serverless"
-	_ "github.com/yomorun/yomo/cli/serverless/exec"
 	_ "github.com/yomorun/yomo/cli/serverless/golang"
 	_ "github.com/yomorun/yomo/cli/serverless/nodejs"
 	"github.com/yomorun/yomo/cli/viper"
@@ -35,11 +34,11 @@ var runCmd = &cobra.Command{
 	Short: "Run a YoMo Serverless LLM Function",
 	Long:  "Run a YoMo Serverless LLM Function",
 	Run: func(cmd *cobra.Command, args []string) {
-		if err := parseFileArg(args, &opts, defaultSFNCompliedFile, defaultSFNSourceFile, defaultSFNSourceTSFile); err != nil {
+		loadOptionsFromViper(viper.RunViper, &opts)
+		if err := parseFileArg(&opts); err != nil {
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			return
 		}
-		loadOptionsFromViper(viper.RunViper, &opts)
 		// Serverless
 		log.InfoStatusEvent(os.Stdout, "YoMo Serverless LLM Function file: %v", opts.Filename)
 		if opts.Name == "" {
@@ -57,24 +56,19 @@ var runCmd = &cobra.Command{
 			log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 			return
 		}
-		if !s.Executable() {
-			log.FailureStatusEvent(os.Stdout,
-				"You cannot run `%s` directly. build first with the `yomo build %s` command and then run with the 'yomo run %s' command.",
-				opts.Filename,
-				opts.Filename,
-				opts.Filename,
-			)
-			return
-		}
 
 		// if has `--production` flag, skip s.Build() process
 		isProduction := opts.Production
-		log.InfoStatusEvent(os.Stdout, "production mode is %v", opts.Production)
 		if !isProduction {
+			// build
+			log.PendingStatusEvent(os.Stdout, "Building YoMo Stream Function instance...")
 			if err := s.Build(true); err != nil {
 				log.FailureStatusEvent(os.Stdout, "%s", err.Error())
 				os.Exit(127)
 			}
+			log.SuccessStatusEvent(os.Stdout, "YoMo Stream Function build successful!")
+		} else {
+			log.InfoStatusEvent(os.Stdout, "YoMo Serverless LLM Function is running in [production] mode")
 		}
 
 		log.InfoStatusEvent(
@@ -97,7 +91,7 @@ func init() {
 	runCmd.Flags().StringVarP(&opts.Name, "name", "n", "", "yomo Serverless LLM Function name.")
 	runCmd.Flags().StringVarP(&opts.ModFile, "modfile", "m", "", "custom go.mod")
 	runCmd.Flags().StringVarP(&opts.Credential, "credential", "d", "", "client credential payload, eg: `token:dBbBiRE7`")
-	runCmd.Flags().StringVarP(&opts.Runtime, "runtime", "r", "", "serverless runtime type")
+	runCmd.Flags().StringVarP(&opts.Runtime, "runtime", "r", "node", "serverless runtime type")
 	runCmd.Flags().BoolVarP(&opts.Production, "production", "p", false, "run in production mode, skip the build process")
 
 	viper.BindPFlags(viper.RunViper, runCmd.Flags())