feat: add all types to the documentation and disclaimer for multiple coin types (#4786)

Author: Pantani

changelog.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- [#4786](https://github.com/ignite/cli/pull/4786) Add all types to the documentation and disclaimer for multiple coin types.
+
 ## [`v29.2.1`](https://github.com/ignite/cli/releases/tag/v29.2.1)
 
 ### Changes

ignite/cmd/scaffold.go

@@ -5,13 +5,15 @@ import (
 	flag "github.com/spf13/pflag"
 
 	"github.com/ignite/cli/v29/ignite/pkg/cliui"
+	"github.com/ignite/cli/v29/ignite/pkg/cliui/colors"
 	"github.com/ignite/cli/v29/ignite/pkg/cosmosver"
 	"github.com/ignite/cli/v29/ignite/pkg/env"
 	"github.com/ignite/cli/v29/ignite/pkg/errors"
 	"github.com/ignite/cli/v29/ignite/pkg/gocmd"
 	"github.com/ignite/cli/v29/ignite/pkg/xgenny"
 	"github.com/ignite/cli/v29/ignite/pkg/xgit"
 	"github.com/ignite/cli/v29/ignite/services/scaffolder"
+	"github.com/ignite/cli/v29/ignite/templates/field"
 	"github.com/ignite/cli/v29/ignite/version"
 )
 
@@ -27,28 +29,12 @@ const (
 	msgCommitPrefix = "Your project changes have not been committed.\nTo enable reverting to your current state, commit your saved changes."
 	msgCommitPrompt = "Do you want to proceed without committing your saved changes"
 
-	statusScaffolding = "Scaffolding..."
-
-	supportFieldTypes = `
-Currently supports: 
-
-| Type         | Alias   | Index | Code Type | Description                     |
-|--------------|---------|-------|-----------|---------------------------------|
-| string       | -       | yes   | string    | Text type                       |
-| array.string | strings | no    | []string  | List of text type               |
-| bool         | -       | yes   | bool      | Boolean type                    |
-| int          | -       | yes   | int64     | Integer type                    |
-| array.int    | ints    | no    | []int64   | List of integers types          |
-| uint         | -       | yes   | uint64    | Unsigned integer type           |
-| array.uint   | uints   | no    | []uint64  | List of unsigned integers types |
-| coin         | -       | no    | sdk.Coin  | Cosmos SDK coin type            |
-| array.coin   | coins   | no    | sdk.Coins | List of Cosmos SDK coin types   |
-
-Field Usage:
-    - fieldName
-    - fieldName:fieldType
-
-If no :fieldType, default (string) is used
+	statusScaffolding      = "Scaffolding..."
+	multipleCoinDisclaimer = `**Disclaimer**  
+The 'coins' and 'dec.coins' argument types require special attention when used in CLI commands. 
+Due to current limitations in the AutoCLI, only one variadic (slice) argument is supported per command. 
+If a message contains more than one field of type 'coins' or 'dec.coins', only the last one will accept multiple values via the CLI. 
+For the best user experience, manual command handling or scaffolding is recommended when working with messages containing multiple 'coins' or 'dec.coins' fields.
 `
 )
 
@@ -220,6 +206,18 @@ func scaffoldType(
 	)
 	defer session.End()
 
+	if !withoutMessage {
+		hasMultipleCoinSlice, err := field.MultipleCoins(fields)
+		if err != nil {
+			return err
+		}
+		if hasMultipleCoinSlice {
+			session.PauseSpinner()
+			_ = session.Print(colors.Info(multipleCoinDisclaimer))
+			session.StartSpinner(statusScaffolding)
+		}
+	}
+
 	cfg, _, err := getChainConfig(cmd)
 	if err != nil {
 		return err

ignite/cmd/scaffold_message.go

@@ -4,8 +4,10 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/ignite/cli/v29/ignite/pkg/cliui"
+	"github.com/ignite/cli/v29/ignite/pkg/cliui/colors"
 	"github.com/ignite/cli/v29/ignite/pkg/xgenny"
 	"github.com/ignite/cli/v29/ignite/services/scaffolder"
+	"github.com/ignite/cli/v29/ignite/templates/field"
 )
 
 const flagSigner = "signer"
@@ -95,6 +97,16 @@ func messageHandler(cmd *cobra.Command, args []string) error {
 	)
 	defer session.End()
 
+	hasMultipleCoinSlice, err := field.MultipleCoins(resFields)
+	if err != nil {
+		return err
+	}
+	if hasMultipleCoinSlice {
+		session.PauseSpinner()
+		_ = session.Print(colors.Info(multipleCoinDisclaimer))
+		session.StartSpinner(statusScaffolding)
+	}
+
 	cfg, _, err := getChainConfig(cmd)
 	if err != nil {
 		return err

ignite/cmd/scaffold_type.go

@@ -2,18 +2,23 @@ package ignitecmd
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/spf13/cobra"
 
 	"github.com/ignite/cli/v29/ignite/services/scaffolder"
+	"github.com/ignite/cli/v29/ignite/templates/field/datatype"
 )
 
 // NewScaffoldType returns a new command to scaffold a type.
 func NewScaffoldType() *cobra.Command {
+	b := strings.Builder{}
+	_ = datatype.PrintScaffoldTypeList(&b)
+
 	c := &cobra.Command{
 		Use:     "type NAME [field:type] ...",
 		Short:   "Type definition",
-		Long:    fmt.Sprintf("Type information\n%s\n", supportFieldTypes),
+		Long:    fmt.Sprintf("Type information\n\n%s\n", b.String()),
 		Example: "  ignite scaffold type todo-item priority:int desc:string tags:array.string done:bool",
 		Args:    cobra.MinimumNArgs(1),
 		PreRunE: migrationPreRunHandler,

ignite/cmd/scaffold_type_list.go

@@ -1,8 +1,6 @@
 package ignitecmd
 
 import (
-	"sort"
-
 	"github.com/spf13/cobra"
 
 	"github.com/ignite/cli/v29/ignite/pkg/cliui"
@@ -16,28 +14,16 @@ func NewScaffoldTypeList() *cobra.Command {
 		Short: "List scaffold types",
 		Long:  "List all available scaffold types",
 		Args:  cobra.NoArgs,
-		RunE:  scaffoldTypeListHandler,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			session := cliui.New(
+				cliui.StartSpinnerWithText("printing..."),
+				cliui.WithoutUserInteraction(getYes(cmd)),
+			)
+			defer session.End()
+			session.StopSpinner()
+			return datatype.PrintScaffoldTypeList(cmd.OutOrStdout())
+		},
 	}
 
 	return c
 }
-
-func scaffoldTypeListHandler(cmd *cobra.Command, _ []string) error {
-	session := cliui.New(
-		cliui.StartSpinnerWithText("printing..."),
-		cliui.WithoutUserInteraction(getYes(cmd)),
-	)
-	defer session.End()
-
-	supported := datatype.SupportedTypes()
-	entries := make([][]string, 0, len(supported))
-	for name, usage := range supported {
-		entries = append(entries, []string{name, usage})
-	}
-
-	sort.Slice(entries, func(i, j int) bool {
-		return entries[i][0] < entries[j][0]
-	})
-
-	return session.PrintTable([]string{"types", "usage"}, entries...)
-}

ignite/internal/tools/gen-cli-docs/main.go

@@ -11,6 +11,7 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+	"sort"
 	"strings"
 
 	"github.com/spf13/cobra"
@@ -20,9 +21,28 @@ import (
 	pluginsconfig "github.com/ignite/cli/v29/ignite/config/plugins"
 	"github.com/ignite/cli/v29/ignite/pkg/env"
 	"github.com/ignite/cli/v29/ignite/services/plugin"
+	"github.com/ignite/cli/v29/ignite/templates/field/datatype"
 )
 
 const (
+	scaffoldTypeFooter = `
+
+Field Usage:
+
+    - fieldName
+    - fieldName:fieldType
+
+
+If no :fieldType, default (string) is used
+`
+	scaffoldTypeHead = `# Scaffold Type
+
+Ignites provides a set of scaffold types that can be used to generate code for your application.
+These types are used in the ` + "`ignite scaffold`" + ` command.
+
+## Available Scaffold Types
+
+`
 	head = `---
 description: Ignite CLI docs.
 ---
@@ -67,7 +87,8 @@ func run() error {
 		return err
 	}
 	defer cleanUp()
-	cmd.Flags().String(outFlag, ".", ".md file path to place Ignite CLI docs inside")
+
+	cmd.Flags().String(outFlag, "output.md", ".md file path to place Ignite CLI docs inside")
 	if err := cmd.Flags().MarkHidden(outFlag); err != nil {
 		return err
 	}
@@ -83,10 +104,10 @@ func run() error {
 		return nil
 	}
 
-	return generate(cmd, outPath)
+	return generateUsage(cmd, outPath)
 }
 
-func generate(cmd *cobra.Command, outPath string) error {
+func generateUsage(cmd *cobra.Command, outPath string) error {
 	if err := os.MkdirAll(filepath.Dir(outPath), 0o755); err != nil {
 		return err
 	}
@@ -100,7 +121,47 @@ func generate(cmd *cobra.Command, outPath string) error {
 		return err
 	}
 
-	return generateCmd(cmd, f)
+	if err := generateCmd(cmd, f); err != nil {
+		return err
+	}
+
+	return generateScaffoldTypes(f)
+}
+
+func generateScaffoldTypes(w io.Writer) error {
+	if _, err := fmt.Fprint(w, scaffoldTypeHead); err != nil {
+		return err
+	}
+
+	supported := datatype.SupportedTypes()
+	entries := make([][]string, 0, len(supported))
+	for name, usage := range supported {
+		entries = append(entries, []string{name, usage})
+	}
+
+	sort.Slice(entries, func(i, j int) bool {
+		return entries[i][0] < entries[j][0]
+	})
+
+	// Write table header
+	if _, err := fmt.Fprintf(w, "| Type | Usage |\n"); err != nil {
+		return err
+	}
+	if _, err := fmt.Fprintf(w, "| --- | --- |\n"); err != nil {
+		return err
+	}
+
+	// Write table rows
+	for _, entry := range entries {
+		if _, err := fmt.Fprintf(w, "| %s | %s |\n", entry[0], entry[1]); err != nil {
+			return err
+		}
+	}
+
+	if _, err := fmt.Fprint(w, scaffoldTypeFooter); err != nil {
+		return err
+	}
+	return nil
 }
 
 func generateCmd(cmd *cobra.Command, w io.Writer) error {

ignite/pkg/multiformatname/multiformatname.go

@@ -23,6 +23,15 @@ type Name struct {
 
 type Checker func(name string) error
 
+// MustNewName returns a new multi-format name from a name.
+func MustNewName(name string, additionalChecks ...Checker) Name {
+	n, err := NewName(name, additionalChecks...)
+	if err != nil {
+		panic(err)
+	}
+	return n
+}
+
 // NewName returns a new multi-format name from a name.
 func NewName(name string, additionalChecks ...Checker) (Name, error) {
 	checks := append([]Checker{basicCheckName}, additionalChecks...)

ignite/templates/field/datatype/coin.go

@@ -70,6 +70,7 @@ var (
 
 	// DataDecCoin decimal coin data type definition.
 	DataDecCoin = DataType{
+		Name:                    DecCoin,
 		DataType:                func(string) string { return "sdk.DecCoin" },
 		CollectionsKeyValueName: func(string) string { return collectionValueComment },
 		DefaultTestValue:        "100001token",
@@ -98,6 +99,7 @@ var (
 
 	// DataDecCoinSlice is a decimal coin array data type definition.
 	DataDecCoinSlice = DataType{
+		Name:                    DecCoins,
 		DataType:                func(string) string { return "sdk.DecCoins" },
 		CollectionsKeyValueName: func(string) string { return collectionValueComment },
 		DefaultTestValue:        "20000002stake",