feat: add support to change spinner text using event updates

changelog.md

@@ -43,6 +43,7 @@
 - Add `--peer-address` flag to `network chain join` command.
 - Change nightly tag format
 - Add cosmos-sdk version in `version` command
+- Add a new event "update" status option to `pkg/cliui`.
 - [#2935](https://github.com/ignite/cli/pull/2935) Update `gobuffalo/plush` templating tool to `v4`
 
 ### Fixes

ignite/cmd/chain_build.go

@@ -101,7 +101,10 @@ func chainBuildHandler(cmd *cobra.Command, _ []string) error {
 		releaseTargets, _ = cmd.Flags().GetStringSlice(flagReleaseTargets)
 		releasePrefix, _  = cmd.Flags().GetString(flagReleasePrefix)
 		output, _         = cmd.Flags().GetString(flagOutput)
-		session           = cliui.New(cliui.WithVerbosity(getVerbosity(cmd)), cliui.StartSpinner())
+		session           = cliui.New(
+			cliui.WithVerbosity(getVerbosity(cmd)),
+			cliui.StartSpinner(),
+		)
 	)
 
 	defer session.End()

ignite/cmd/chain_serve.go

@@ -71,7 +71,10 @@ production, you may want to run "appd start" manually.
 }
 
 func chainServeHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.WithVerbosity(getVerbosity(cmd)), cliui.StartSpinner())
+	session := cliui.New(
+		cliui.WithVerbosity(getVerbosity(cmd)),
+		cliui.StartSpinner(),
+	)
 	defer session.End()
 
 	chainOption := []chain.Option{

ignite/cmd/cmd.go

@@ -37,6 +37,9 @@ const (
 
 	checkVersionTimeout = time.Millisecond * 600
 	cacheFileName       = "ignite_cache.db"
+
+	statusGenerating = "Generating..."
+	statusQuerying   = "Querying..."
 )
 
 // New creates a new root command for `Ignite CLI` with its sub commands.

ignite/cmd/generate_dart.go

@@ -22,11 +22,9 @@ func NewGenerateDart() *cobra.Command {
 }
 
 func generateDartHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusGenerating))
 	defer session.End()
 
-	session.StartSpinner("Generating...")
-
 	c, err := newChainWithHomeFlags(
 		cmd,
 		chain.EnableThirdPartyModuleCodegen(),

ignite/cmd/generate_go.go

@@ -22,11 +22,9 @@ func NewGenerateGo() *cobra.Command {
 }
 
 func generateGoHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusGenerating))
 	defer session.End()
 
-	session.StartSpinner("Generating...")
-
 	c, err := newChainWithHomeFlags(
 		cmd,
 		chain.WithOutputer(session),

ignite/cmd/generate_openapi.go

@@ -22,11 +22,9 @@ func NewGenerateOpenAPI() *cobra.Command {
 }
 
 func generateOpenAPIHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusGenerating))
 	defer session.End()
 
-	session.StartSpinner("Generating...")
-
 	c, err := newChainWithHomeFlags(
 		cmd,
 		chain.WithOutputer(session),

ignite/cmd/generate_typescript_client.go

@@ -23,11 +23,9 @@ func NewGenerateTSClient() *cobra.Command {
 }
 
 func generateTSClientHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusGenerating))
 	defer session.End()
 
-	session.StartSpinner("Generating...")
-
 	c, err := newChainWithHomeFlags(
 		cmd,
 		chain.EnableThirdPartyModuleCodegen(),

ignite/cmd/generate_vuex.go

@@ -23,11 +23,9 @@ func NewGenerateVuex() *cobra.Command {
 }
 
 func generateVuexHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusGenerating))
 	defer session.End()
 
-	session.StartSpinner("Generating...")
-
 	c, err := newChainWithHomeFlags(
 		cmd,
 		chain.EnableThirdPartyModuleCodegen(),

ignite/cmd/network_reward_release.go

@@ -63,11 +63,9 @@ func networkRewardRelease(cmd *cobra.Command, args []string) (err error) {
 		err = handleRelayerAccountErr(err)
 	}()
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText("Setting up chains..."))
 	defer session.End()
 
-	session.StartSpinner("Setting up chains...")
-
 	launchID, err := network.ParseID(args[0])
 	if err != nil {
 		return err

ignite/cmd/node_query_bank_balances.go

@@ -42,9 +42,8 @@ func nodeQueryBankBalancesHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusQuerying))
 	defer session.End()
-	session.StartSpinner("Querying...")
 
 	balances, err := client.BankBalances(cmd.Context(), address, pagination)
 	if err != nil {

ignite/cmd/node_query_tx.go

@@ -20,11 +20,9 @@ func NewNodeQueryTx() *cobra.Command {
 }
 
 func nodeQueryTxHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusQuerying))
 	defer session.End()
 
-	session.StartSpinner("Querying...")
-
 	bz, err := hex.DecodeString(args[0])
 	if err != nil {
 		return err

ignite/cmd/node_tx_bank_send.go

@@ -53,7 +53,7 @@ func nodeTxBankSendHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New()
 	defer session.End()
 
 	if generateOnly {

ignite/cmd/relayer_configure.go

@@ -95,7 +95,7 @@ func relayerConfigureHandler(cmd *cobra.Command, _ []string) (err error) {
 		err = handleRelayerAccountErr(err)
 	}()
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New()
 	defer session.End()
 
 	ca, err := cosmosaccount.New(

ignite/cmd/relayer_connect.go

@@ -33,7 +33,7 @@ func relayerConnectHandler(cmd *cobra.Command, args []string) (err error) {
 		err = handleRelayerAccountErr(err)
 	}()
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New()
 	defer session.End()
 
 	ca, err := cosmosaccount.New(

ignite/cmd/scaffold.go

@@ -20,6 +20,8 @@ const (
 	flagNoSimulation = "no-simulation"
 	flagResponse     = "response"
 	flagDescription  = "desc"
+
+	statusScaffolding = "Scaffolding..."
 )
 
 // NewScaffold returns a command that groups scaffolding related sub commands.
@@ -136,11 +138,9 @@ func scaffoldType(
 		}
 	}
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	sc, err := newApp(appPath)
 	if err != nil {
 		return err

ignite/cmd/scaffold_band.go

@@ -49,11 +49,9 @@ func createBandchainHandler(cmd *cobra.Command, args []string) error {
 		signer  = flagGetSigner(cmd)
 	)
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	module, err := cmd.Flags().GetString(flagModule)
 	if err != nil {
 		return err

ignite/cmd/scaffold_chain.go

@@ -81,11 +81,9 @@ about Cosmos SDK on https://docs.cosmos.network
 }
 
 func scaffoldChainHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	var (
 		name               = args[0]
 		addressPrefix      = getAddressPrefix(cmd)

ignite/cmd/scaffold_flutter.go

@@ -24,11 +24,9 @@ func NewScaffoldFlutter() *cobra.Command {
 }
 
 func scaffoldFlutterHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	path := flagGetPath(cmd)
 	if err := scaffolder.Flutter(path); err != nil {
 		return err

ignite/cmd/scaffold_message.go

@@ -87,11 +87,9 @@ func messageHandler(cmd *cobra.Command, args []string) error {
 		withoutSimulation = flagGetNoSimulation(cmd)
 	)
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	cacheStorage, err := newCache(cmd)
 	if err != nil {
 		return err

ignite/cmd/scaffold_module.go

@@ -119,11 +119,9 @@ func scaffoldModuleHandler(cmd *cobra.Command, args []string) error {
 		appPath = flagGetPath(cmd)
 	)
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	ibcModule, err := cmd.Flags().GetBool(flagIBC)
 	if err != nil {
 		return err

ignite/cmd/scaffold_mwasm.go

@@ -24,11 +24,9 @@ func NewScaffoldWasm() *cobra.Command {
 func scaffoldWasmHandler(cmd *cobra.Command, args []string) error {
 	appPath := flagGetPath(cmd)
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	cacheStorage, err := newCache(cmd)
 	if err != nil {
 		return err

ignite/cmd/scaffold_package.go

@@ -45,11 +45,9 @@ func createPacketHandler(cmd *cobra.Command, args []string) error {
 		appPath      = flagGetPath(cmd)
 	)
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	module, err := cmd.Flags().GetString(flagModule)
 	if err != nil {
 		return err

ignite/cmd/scaffold_query.go

@@ -38,11 +38,9 @@ func NewScaffoldQuery() *cobra.Command {
 func queryHandler(cmd *cobra.Command, args []string) error {
 	appPath := flagGetPath(cmd)
 
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	// Get the module to add the type into
 	module, err := cmd.Flags().GetString(flagModule)
 	if err != nil {

ignite/cmd/scaffold_vue.go

@@ -24,11 +24,9 @@ func NewScaffoldVue() *cobra.Command {
 }
 
 func scaffoldVueHandler(cmd *cobra.Command, args []string) error {
-	session := cliui.New(cliui.StartSpinner())
+	session := cliui.New(cliui.StartSpinnerWithText(statusScaffolding))
 	defer session.End()
 
-	session.StartSpinner("Scaffolding...")
-
 	path := flagGetPath(cmd)
 	if err := scaffolder.Vue(path); err != nil {
 		return err

ignite/pkg/cliui/clispinner/clispinner.go

@@ -25,26 +25,39 @@ type (
 
 	Options struct {
 		writer io.Writer
+		text   string
 	}
 )
 
-// WithWriter configures an output for a spinner
+// WithWriter configures an output for a spinner.
 func WithWriter(w io.Writer) Option {
 	return func(options *Options) {
 		options.writer = w
 	}
 }
 
+// WithText configures the spinner text.
+func WithText(text string) Option {
+	return func(options *Options) {
+		options.text = text
+	}
+}
+
 // New creates a new spinner.
 func New(options ...Option) *Spinner {
 	o := Options{}
 	for _, apply := range options {
 		apply(&o)
 	}
 
+	text := o.text
+	if text == "" {
+		text = DefaultText
+	}
+
 	spOptions := []spinner.Option{
 		spinner.WithColor(spinnerColor),
-		spinner.WithSuffix(" " + DefaultText),
+		spinner.WithSuffix(" " + text),
 	}
 
 	if o.writer != nil {