added sorted output, total number of functions in category and 4 missing function descriptions

Author: ugol

pkg/cmd/functionList.go

@@ -26,6 +26,7 @@ import (
 	"github.com/ugol/jr/pkg/functions"
 	"os"
 	"os/exec"
+	"slices"
 	"strings"
 )
 
@@ -57,17 +58,21 @@ func doList(cmd *cobra.Command, args []string) {
 	noColor, _ := cmd.Flags().GetBool("nocolor")
 
 	if category && len(args) > 0 {
+		var functionNames []string
 		for k, v := range functions.DescriptionMap() {
 			if strings.Contains(v.Category, args[0]) {
-				printFunction(k, isMarkdown, noColor)
+				functionNames = append(functionNames, k)
 			}
 		}
+		sortAndPrint(functionNames, isMarkdown, noColor)
 	} else if find && len(args) > 0 {
+		var functionNames []string
 		for k, v := range functions.DescriptionMap() {
 			if strings.Contains(v.Description, args[0]) || strings.Contains(v.Name, args[0]) {
-				printFunction(k, isMarkdown, noColor)
+				functionNames = append(functionNames, k)
 			}
 		}
+		sortAndPrint(functionNames, isMarkdown, noColor)
 	} else if len(args) == 1 {
 
 		if run {
@@ -83,15 +88,30 @@ func doList(cmd *cobra.Command, args []string) {
 			printFunction(args[0], isMarkdown, noColor)
 		}
 	} else {
-		count := 0
-		for k := range functions.FunctionsMap() {
-			count++
-			printFunction(k, isMarkdown, noColor)
+
+		//l := len(functions.FunctionsMap())
+		l := len(functions.DescriptionMap())
+		functionNames := make([]string, l)
+
+		i := 0
+		for k := range functions.DescriptionMap() {
+			functionNames[i] = k
+			i++
 		}
-		fmt.Println()
-		fmt.Printf("Total functions: %d\n", count)
+		sortAndPrint(functionNames, isMarkdown, noColor)
+
+	}
+	fmt.Println()
+}
+
+func sortAndPrint(functionNames []string, isMarkdown bool, noColor bool) {
+	slices.Sort(functionNames)
+	for _, k := range functionNames {
+		printFunction(k, isMarkdown, noColor)
+		//fmt.Println(k)
 	}
 	fmt.Println()
+	fmt.Printf("Total functions: %d\n", len(functionNames))
 }
 
 func printFunction(name string, isMarkdown bool, noColor bool) (functions.FunctionDescription, bool) {
@@ -104,21 +124,8 @@ func printFunction(name string, isMarkdown bool, noColor bool) (functions.Functi
 		Reset = "\033[0m"
 	}
 
-	if !isMarkdown {
-
-		if found {
-			fmt.Println()
-			fmt.Printf("%sName: %s%s\n", Cyan, Reset, f.Name)
-			fmt.Printf("%sCategory: %s%s\n", Cyan, Reset, f.Category)
-			fmt.Printf("%sDescription: %s%s\n", Cyan, Reset, f.Description)
-			fmt.Printf("%sParameters: %s%s\n", Cyan, Reset, f.Parameters)
-			fmt.Printf("%sLocalizable: %s%v\n", Cyan, Reset, f.Localizable)
-			fmt.Printf("%sReturn: %s%s\n", Cyan, Reset, f.Return)
-			fmt.Printf("%sExample: %s%s\n", Cyan, Reset, f.Example)
-			fmt.Printf("%sOutput: %s%s\n", Cyan, Reset, f.Output)
-		}
-	} else {
-		if found {
+	if found {
+		if isMarkdown {
 			fmt.Println()
 			fmt.Printf("## Name: %s \n", f.Name)
 			fmt.Printf("**Category:** %s\\\n", f.Category)
@@ -133,6 +140,16 @@ func printFunction(name string, isMarkdown bool, noColor bool) (functions.Functi
 			fmt.Printf("**Return:** `%s`\\\n", f.Return)
 			fmt.Printf("**Example:** `%s`\\\n", f.Example)
 			fmt.Printf("**Output:** `%s`\n", f.Output)
+		} else {
+			fmt.Println()
+			fmt.Printf("%sName: %s%s\n", Cyan, Reset, f.Name)
+			fmt.Printf("%sCategory: %s%s\n", Cyan, Reset, f.Category)
+			fmt.Printf("%sDescription: %s%s\n", Cyan, Reset, f.Description)
+			fmt.Printf("%sParameters: %s%s\n", Cyan, Reset, f.Parameters)
+			fmt.Printf("%sLocalizable: %s%v\n", Cyan, Reset, f.Localizable)
+			fmt.Printf("%sReturn: %s%s\n", Cyan, Reset, f.Return)
+			fmt.Printf("%sExample: %s%s\n", Cyan, Reset, f.Example)
+			fmt.Printf("%sOutput: %s%s\n", Cyan, Reset, f.Output)
 		}
 	}
 	return f, found

pkg/functions/functionsDescription.go

@@ -512,6 +512,16 @@ var funcDesc = map[string]FunctionDescription{
 		Example:     "jr template run --embedded '{{set_v \"id\" \"12770\"}}{{get_v \"id\"}}'",
 		Output:      "12770",
 	},
+	"get_v_from_list_at_index": {
+		Name:        "get_v_from_list_at_index",
+		Category:    "context",
+		Description: "returns a specific value from a list. The list must be set with 'add_v_to_list', usually in an other template",
+		Parameters:  "name string index int",
+		Localizable: false,
+		Return:      "string",
+		Example:     "jr template run --embedded '{{add_v_to_list \"ids\" \"12770\"}}{{get_v_from_list_at_index \"ids\" 0}}'",
+		Output:      "12770",
+	},
 	"http_method": {
 		Name:        "http_method",
 		Category:    "network",
@@ -728,6 +738,16 @@ var funcDesc = map[string]FunctionDescription{
 		Name:        "max",
 		Category:    "math",
 		Description: "returns the maximum of two numbers",
+		Parameters:  "first int|float, second int|float",
+		Localizable: false,
+		Return:      "int",
+		Example:     "jr template run --embedded '{{max 10.3 2.4}}'",
+		Output:      "10.3",
+	},
+	"maxint": {
+		Name:        "max",
+		Category:    "math",
+		Description: "returns the maximum of two ints",
 		Parameters:  "first int, second int",
 		Localizable: false,
 		Return:      "int",
@@ -748,7 +768,17 @@ var funcDesc = map[string]FunctionDescription{
 		Name:        "min",
 		Category:    "math",
 		Description: "returns the minimum of two numbers",
-		Parameters:  "min int, max int",
+		Parameters:  "first int|float, second int|float",
+		Localizable: false,
+		Return:      "int",
+		Example:     "jr template run --embedded '{{min 10.1 2.3}}'",
+		Output:      "2.3",
+	},
+	"minint": {
+		Name:        "min",
+		Category:    "math",
+		Description: "returns the minimum of two ints",
+		Parameters:  "first int, second int",
 		Localizable: false,
 		Return:      "int",
 		Example:     "jr template run --embedded '{{min 10 2}}'",
@@ -994,6 +1024,16 @@ var funcDesc = map[string]FunctionDescription{
 		Example:     "jr template run --embedded '{{replaceall \"hello world\" \"hello\" \"goodbye\"}}'",
 		Output:      "goodbye world",
 	},
+	"seed": {
+		Name:        "seed",
+		Category:    "utilities",
+		Description: "set seed directly in a template",
+		Parameters:  "rndSeed int64",
+		Localizable: false,
+		Return:      "",
+		Example:     "jr template run --embedded '{{seed 12345}}'",
+		Output:      "",
+	},
 	"sedol": {
 		Name:        "sedol",
 		Category:    "finance",