#9 Complete Action:Util

Author: qdriven

README.md

@@ -1,8 +1,58 @@
 # README
 
-## fluent cli
+## Build and Deploy to Local
+
+```shell
+sh deploy-local.sh
+```
+
+## fluent cli help
+
+```shell
+❯ fluent -h       
+fluent cli is a collection of daily scripts
+
+Usage:
+  fluent [flags]
+  fluent [command]
+
+Examples:
+fluent <category> <action> <--options>
+
+Available Commands:
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  issue       Create a new issue
+  starter     fluent start java,go,ts-lib,fe-next,mono,python
+  util        fluent  util echo,mac-cleanup
+
+Flags:
+  -h, --help      help for fluent
+  -v, --version   version for fluent
+
+Use "fluent [command] --help" for more information about a command.
+
+```
+
+## fluent starer cli
+
+create template project: ***fluent starter <name>***
+
+```shell
+fluent starter -h 
+
+
+Usage:
+  fluent starter [flags]
+
+Examples:
+fluent start java
+
+Flags:
+  -h, --help   help for starter
+
+```
 
-- create template project
 ```shell
 fluent starter -h
 fluent starter java
@@ -12,6 +62,54 @@ fluent starter ts-lib
 fluent starter mono
 ```
 
+## fluent util cli
+
+***fluent util <cmd>***, to run ,and add more commands in utils.json file
+
+```shell
+fluent  util echo,mac-cleanup
+
+Usage:
+  fluent util [flags]
+
+Examples:
+fluent  util echo
+
+Flags:
+  -h, --help   help for util
+
+```
+
+## action json file
+
+action structure:
+- name: command name
+- desc: command usage
+- commands: a list of shell commands or something else which is runnable 
+
+```json
+{
+  "actions": [
+    {
+      "name": "echo",
+      "desc": "try cli",
+      "commands": [
+        "echo \"hello fluent cli\""
+      ]
+    },    {
+      "name": "mac-cleanup",
+      "desc": "cleanup mac pc to free disk space",
+      "commands": [
+        "sh mac-cleanup.sh"
+      ]
+    }
+  ]
+}
+```
+
+
+
+
 ## Pocketbase Server
 
 ```shell
@@ -24,7 +122,7 @@ All Url:
 - http://127.0.0.1:8090/_/ - Admin dashboard UI
 - http://127.0.0.1:8090/api/ - REST API
 
-## Embedded PocketServer
+
 
 ### References 
 

cmd/actions/base.go

@@ -0,0 +1,28 @@
+package actions
+
+import (
+	"github.com/fluent-qa/qgops/internal/utils/shell"
+	"github.com/spf13/cobra"
+	"path"
+	"strings"
+)
+
+func CreateActions(actionCategory, actionConfigFile string) ([]string, *cobra.Command) {
+	usedActions := shell.LoadCommands(path.Join(WorkSpaceDir, actionConfigFile))
+
+	availableActions := usedActions.GetAvailableActionNames()
+	availableCmd := &cobra.Command{
+		Use:       actionCategory,
+		Short:     "fluent  " + actionCategory + " " + strings.Join(availableActions, ","),
+		Long:      "fluent  " + actionCategory + " " + strings.Join(availableActions, ","),
+		Example:   "fluent  " + actionCategory + " " + availableActions[0],
+		ValidArgs: availableActions,
+		//ValidArgsFunction: ;
+		//RunE
+		Run: func(cmd *cobra.Command, args []string) {
+			category := args[0]
+			usedActions.ExecuteActionByName(category)
+		},
+	}
+	return availableActions, availableCmd
+}

cmd/actions/constants.go

@@ -0,0 +1,5 @@
+package actions
+
+import "os"
+
+var WorkSpaceDir = os.Getenv("FLUENT_HOME")

cmd/actions/starter.go

@@ -2,17 +2,14 @@ package actions
 
 import (
 	_ "log/slog"
-	"os"
 	"path"
 	"strings"
 
 	"github.com/fluent-qa/qgops/internal/utils/shell"
 	"github.com/spf13/cobra"
 )
 
-var CurrentDir = os.Getenv("FLUENT_HOME")
-
-var starterActions = shell.LoadCommands(path.Join(CurrentDir, "starters.json"))
+var starterActions = shell.LoadCommands(path.Join(WorkSpaceDir, "starters.json"))
 
 var (
 	AvailableStarter = starterActions.GetAvailableActionNames()

cmd/actions/utility.go

@@ -0,0 +1,5 @@
+package actions
+
+var (
+	_, UtilCmd = CreateActions("util", "utils.json")
+)

cmd/base/root.go

@@ -2,16 +2,14 @@ package base
 
 import (
 	"github.com/spf13/cobra"
-	"os"
 )
 
 var VERSION = "0.0.2"
-var WorkSpaceDir = os.Getenv("FLUENT_HOME")
 
 var CmdRoot = &cobra.Command{
 	Use:     "fluent",
 	Example: "fluent <category> <action> <--options>",
-	Short:   "fluent is for feeds usage",
+	Short:   "fluent cli is a collection of daily scripts",
 	Version: VERSION,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return cmd.Help()

cmd/fluent.go

@@ -8,6 +8,7 @@ import (
 func init() {
 	base.CmdRoot.AddCommand(actions.StarterCmd)
 	base.CmdRoot.AddCommand(actions.IssueCmd)
+	base.CmdRoot.AddCommand(actions.UtilCmd)
 }
 func main() {
 	_ = base.CmdRoot.Execute()

deploy-local.sh

@@ -1,3 +1,5 @@
 make build-cli
 mv fluent ~/workspace/tools/bin
 cp starters.json ~/workspace/tools/bin
+cp utils.json ~/workspace/tools/bin
+cp scripts/mac-cleanup.sh ~/workspace/tools/bin

docs/features/starter-with-project-name.md

@@ -0,0 +1,8 @@
+# Starter: Create Project by given project name
+
+```shell
+fluent starter -t fe-next -p new-name
+```
+
+-t: template name
+-p: new project name

internal/utils/shell/commands.go

@@ -2,7 +2,6 @@ package shell
 
 import (
 	"io"
-	"log"
 	"log/slog"
 	"os"
 
@@ -29,7 +28,7 @@ var NotFoundAction = &NamedAction{
 func ExecShellCommand(cmd string) (int, error) {
 	return Exec(cmd).
 		FilterScan(func(s string, writer io.Writer) {
-			log.Println(s)
+			slog.Info(s)
 		}).Stdout()
 }