feat: add module list command (#4732)

* feat:  add module list command

* updates

* updates

* updates

* fix wrong test

* impr

Author: julienrbrt

changelog.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Features
+
+- [#4728](https://github.com/ignite/cli/pull/4728) Ask before overwriting a `xgenny` file.
+- [#4732](https://github.com/ignite/cli/pull/4732) Add `ignite chain modules list` command to list all modules in the chain.
+
 ### Changes
 
 - [#4717](https://github.com/ignite/cli/pull/4717) Bump Cosmos SDK to `v0.53.2`.
@@ -11,10 +16,6 @@
 
 - [#4691](https://github.com/ignite/cli/pull/4691), [#4706](https://github.com/ignite/cli/pull/4706), [#4725](https://github.com/ignite/cli/pull/4725) Fix ts-client query template and solely Go template for `ts-client` generation.
 
-### Features
-
-- [#4728](https://github.com/ignite/cli/pull/4728) Ask before overwriting a `xgenny` file.
-
 ## [`v29.0.0`](https://github.com/ignite/cli/releases/tag/v29.0.0)
 
 ### Features

go.mod

@@ -12,10 +12,10 @@ require (
 	github.com/briandowns/spinner v1.23.2
 	github.com/buger/jsonparser v1.1.1
 	github.com/cenkalti/backoff v2.2.1+incompatible
-	github.com/charmbracelet/bubbles v0.20.0
-	github.com/charmbracelet/bubbletea v1.3.3
+	github.com/charmbracelet/bubbles v0.21.0
+	github.com/charmbracelet/bubbletea v1.3.5
 	github.com/charmbracelet/glow v1.5.1
-	github.com/charmbracelet/lipgloss v1.0.0
+	github.com/charmbracelet/lipgloss v1.1.0
 	github.com/cockroachdb/errors v1.12.0
 	github.com/cometbft/cometbft v0.38.17
 	github.com/cosmos/cosmos-sdk v0.53.2
@@ -140,8 +140,10 @@ require (
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/charithe/durationcheck v0.0.10 // indirect
 	github.com/charmbracelet/charm v0.8.7 // indirect
+	github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
 	github.com/charmbracelet/glamour v0.6.0 // indirect
 	github.com/charmbracelet/x/ansi v0.8.0 // indirect
+	github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
 	github.com/charmbracelet/x/term v0.2.1 // indirect
 	github.com/chavacava/garif v0.1.0 // indirect
 	github.com/chigopher/pathlib v0.19.1 // indirect
@@ -352,7 +354,7 @@ require (
 	github.com/muesli/gitcha v0.2.0 // indirect
 	github.com/muesli/go-app-paths v0.2.2 // indirect
 	github.com/muesli/sasquatch v0.0.0-20200811221207-66979d92330a // indirect
-	github.com/muesli/termenv v0.15.2 // indirect
+	github.com/muesli/termenv v0.16.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/nakabonne/nestif v0.3.1 // indirect
 	github.com/nishanths/exhaustive v0.12.0 // indirect
@@ -443,6 +445,7 @@ require (
 	github.com/vektra/mockery/v2 v2.53.3 // indirect
 	github.com/xanzy/ssh-agent v0.3.3 // indirect
 	github.com/xen0n/gosmopolitan v1.2.2 // indirect
+	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
 	github.com/yagipy/maintidx v1.0.0 // indirect
 	github.com/yeya24/promlinter v0.3.0 // indirect
 	github.com/ykadowak/zerologlint v0.1.5 // indirect

go.sum

@@ -336,6 +336,8 @@ github.com/aymanbagabas/go-osc52 v1.0.3/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZ
 github.com/aymanbagabas/go-osc52 v1.2.1/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZNC7cASDfUCdT4=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
+github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8=
+github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA=
 github.com/aymerick/douceur v0.2.0 h1:Mv+mAeH1Q+n9Fr+oyamOlAkUNPWPlA8PPGR0QAaYuPk=
 github.com/aymerick/douceur v0.2.0/go.mod h1:wlT5vV2O3h55X9m7iVYN0TBM0NH/MmbLnd30/FjWUq4=
 github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA=
@@ -406,25 +408,31 @@ github.com/charithe/durationcheck v0.0.10 h1:wgw73BiocdBDQPik+zcEoBG/ob8uyBHf2iy
 github.com/charithe/durationcheck v0.0.10/go.mod h1:bCWXb7gYRysD1CU3C+u4ceO49LoGOY1C1L6uouGNreQ=
 github.com/charmbracelet/bubbles v0.7.5/go.mod h1:IRTORFvhEI6OUH7WhN2Ks8Z8miNGimk1BE6cmHijOkM=
 github.com/charmbracelet/bubbles v0.15.0/go.mod h1:Y7gSFbBzlMpUDR/XM9MhZI374Q+1p1kluf1uLl8iK74=
-github.com/charmbracelet/bubbles v0.20.0 h1:jSZu6qD8cRQ6k9OMfR1WlM+ruM8fkPWkHvQWD9LIutE=
-github.com/charmbracelet/bubbles v0.20.0/go.mod h1:39slydyswPy+uVOHZ5x/GjwVAFkCsV8IIVy+4MhzwwU=
+github.com/charmbracelet/bubbles v0.21.0 h1:9TdC97SdRVg/1aaXNVWfFH3nnLAwOXr8Fn6u6mfQdFs=
+github.com/charmbracelet/bubbles v0.21.0/go.mod h1:HF+v6QUR4HkEpz62dx7ym2xc71/KBHg+zKwJtMw+qtg=
 github.com/charmbracelet/bubbletea v0.12.2/go.mod h1:3gZkYELUOiEUOp0bTInkxguucy/xRbGSOcbMs1geLxg=
 github.com/charmbracelet/bubbletea v0.23.1/go.mod h1:JAfGK/3/pPKHTnAS8JIE2u9f61BjWTQY57RbT25aMXU=
 github.com/charmbracelet/bubbletea v0.23.2/go.mod h1:FaP3WUivcTM0xOKNmhciz60M6I+weYLF76mr1JyI7sM=
-github.com/charmbracelet/bubbletea v1.3.3 h1:WpU6fCY0J2vDWM3zfS3vIDi/ULq3SYphZhkAGGvmEUY=
-github.com/charmbracelet/bubbletea v1.3.3/go.mod h1:dtcUCyCGEX3g9tosuYiut3MXgY/Jsv9nKVdibKKRRXo=
+github.com/charmbracelet/bubbletea v1.3.5 h1:JAMNLTbqMOhSwoELIr0qyP4VidFq72/6E9j7HHmRKQc=
+github.com/charmbracelet/bubbletea v1.3.5/go.mod h1:TkCnmH+aBd4LrXhXcqrKiYwRs7qyQx5rBgH5fVY3v54=
 github.com/charmbracelet/charm v0.8.7 h1:FJ9b7IxWUWHOPR72zS/QJLEqtudOB2Mwfc+Sir0eZR8=
 github.com/charmbracelet/charm v0.8.7/go.mod h1:ApJYwJljEjODkOYJgFDzbUqztLrCWQct9zyPD+xcVr4=
+github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs=
+github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk=
 github.com/charmbracelet/glamour v0.6.0 h1:wi8fse3Y7nfcabbbDuwolqTqMQPMnVPeZhDM273bISc=
 github.com/charmbracelet/glamour v0.6.0/go.mod h1:taqWV4swIMMbWALc0m7AfE9JkPSU8om2538k9ITBxOc=
 github.com/charmbracelet/glow v1.5.1 h1:o1mwT4xXXpkfUhJG6euQayNxLZf9yKctOCNHLztrwdE=
 github.com/charmbracelet/glow v1.5.1/go.mod h1:rGgop0a2/4gXWiAxUW1iEQseoE+9Ctpb7M4sM9cY9CU=
 github.com/charmbracelet/harmonica v0.2.0/go.mod h1:KSri/1RMQOZLbw7AHqgcBycp8pgJnQMYYT8QZRqZ1Ao=
 github.com/charmbracelet/lipgloss v0.6.0/go.mod h1:tHh2wr34xcHjC2HCXIlGSG1jaDF0S0atAUvBMP6Ppuk=
-github.com/charmbracelet/lipgloss v1.0.0 h1:O7VkGDvqEdGi93X+DeqsQ7PKHDgtQfF8j8/O2qFMQNg=
-github.com/charmbracelet/lipgloss v1.0.0/go.mod h1:U5fy9Z+C38obMs+T+tJqst9VGzlOYGj4ri9reL3qUlo=
+github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
+github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
 github.com/charmbracelet/x/ansi v0.8.0 h1:9GTq3xq9caJW8ZrBTe0LIe2fvfLR/bYXKTx2llXn7xE=
 github.com/charmbracelet/x/ansi v0.8.0/go.mod h1:wdYl/ONOLHLIVmQaxbIYEC/cRKOQyjTkowiI4blgS9Q=
+github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8=
+github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
+github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91 h1:payRxjMjKgx2PaCWLZ4p3ro9y97+TVLZNaRZgJwSVDQ=
+github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
 github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
 github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
 github.com/chavacava/garif v0.1.0 h1:2JHa3hbYf5D9dsgseMKAmc/MZ109otzgNFk5s87H9Pc=
@@ -1357,8 +1365,8 @@ github.com/muesli/termenv v0.11.1-0.20220204035834-5ac8409525e0/go.mod h1:Bd5NYQ
 github.com/muesli/termenv v0.13.0/go.mod h1:sP1+uffeLaEYpyOTb8pLCUctGcGLnoFjSn4YJK5e2bc=
 github.com/muesli/termenv v0.14.0/go.mod h1:kG/pF1E7fh949Xhe156crRUrHNyK221IuGO7Ez60Uc8=
 github.com/muesli/termenv v0.15.1/go.mod h1:HeAQPTzpfs016yGtA4g00CsdYnVLJvxsS4ANqrZs2sQ=
-github.com/muesli/termenv v0.15.2 h1:GohcuySI0QmI3wN8Ok9PtKGkgkFIk7y6Vpb5PvrY+Wo=
-github.com/muesli/termenv v0.15.2/go.mod h1:Epx+iuz8sNs7mNKhxzH4fWXGNpZwUaJKRS1noLXviQ8=
+github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
+github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
 github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
@@ -1737,6 +1745,8 @@ github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI
 github.com/xen0n/gosmopolitan v1.2.2 h1:/p2KTnMzwRexIW8GlKawsTWOxn7UHA+jCMF/V8HHtvU=
 github.com/xen0n/gosmopolitan v1.2.2/go.mod h1:7XX7Mj61uLYrj0qmeN0zi7XDon9JRAEhYQqAPLVNTeg=
 github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
 github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
 github.com/yagipy/maintidx v1.0.0 h1:h5NvIsCz+nRDapQ0exNv4aJ0yXSI0420omVANTv3GJM=
 github.com/yagipy/maintidx v1.0.0/go.mod h1:0qNf/I/CCZXSMhsRsrEPDZ+DkekpKLXAJfsTACwgXLk=

ignite/cmd/chain.go

@@ -98,6 +98,7 @@ chain.
 		NewChainSimulate(),
 		NewChainDebug(),
 		NewChainLint(),
+		NewChainModules(),
 	)
 
 	return c

ignite/cmd/chain_modules.go

@@ -0,0 +1,21 @@
+package ignitecmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// NewChainModules returns the modules command.
+func NewChainModules() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "modules",
+		Short: "Manage modules",
+		Long:  "The modules command allows you to manage modules in the codebase.",
+		Args:  cobra.NoArgs,
+	}
+
+	c.AddCommand(
+		NewChainModulesList(),
+	)
+
+	return c
+}

ignite/cmd/chain_modules_list.go

@@ -0,0 +1,165 @@
+package ignitecmd
+
+import (
+	"sort"
+	"strings"
+
+	"github.com/spf13/cobra"
+
+	"github.com/ignite/cli/v29/ignite/pkg/cliui"
+	"github.com/ignite/cli/v29/ignite/pkg/cosmosanalysis/app"
+	"github.com/ignite/cli/v29/ignite/pkg/gomodule"
+	"github.com/ignite/cli/v29/ignite/services/chain"
+)
+
+func NewChainModulesList() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "list",
+		Short: "List all Cosmos SDK modules in the app",
+		Long:  "The list command lists all modules in the app.",
+		Args:  cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			session := cliui.New(cliui.StartSpinner())
+			defer session.End()
+
+			chainOption := []chain.Option{
+				chain.WithOutputer(session),
+				chain.CollectEvents(session.EventBus()),
+			}
+
+			c, err := chain.NewWithHomeFlags(cmd, chainOption...)
+			if err != nil {
+				return err
+			}
+
+			modules, err := app.FindRegisteredModules(c.AppPath())
+			if err != nil {
+				return err
+			}
+
+			if len(modules) == 0 {
+				session.Println("no modules found")
+				return nil
+			}
+
+			modFile, err := gomodule.ParseAt(c.AppPath())
+			if err != nil {
+				return err
+			}
+
+			deps, err := gomodule.ResolveDependencies(modFile, false)
+			if err != nil {
+				return err
+			}
+
+			depMap := make(map[string]string)
+			for _, dep := range deps {
+				depMap[dep.Path] = dep.Version
+			}
+
+			// create a map of replaced modules for easy lookup
+			// check the original required modules, not the resolved ones
+			replacedMap := make(map[string]bool)
+			for _, replace := range modFile.Replace {
+				replacedMap[replace.Old.Path] = true
+			}
+
+			// get the app's module path to identify app modules
+			appModulePath := modFile.Module.Mod.Path
+
+			var entries [][]string
+			for _, m := range modules {
+				ver := depMap[m]
+				modName := m
+
+				switch {
+				case strings.HasPrefix(m, appModulePath+"/"):
+					ver = "main"
+				case strings.HasPrefix(m, cosmosSDKModulePrefix+"/"):
+					ver = depMap[cosmosSDKModulePrefix]
+					modName = strings.TrimPrefix(m, cosmosSDKModulePrefix+"/")
+				case strings.Contains(m, ibcModulePrefix+"/v"):
+					modName, ver = getIBCVersion(m, depMap)
+				case isModuleReplaced(m, replacedMap):
+					ver = "locally replaced"
+				}
+
+				if ver == "" {
+					ver = findBestMatchingVersion(m, depMap)
+					if ver == "" {
+						ver = "-"
+					}
+				}
+
+				entries = append(entries, []string{modName, ver})
+			}
+
+			session.StopSpinner()
+
+			// Sort entries by module name
+			sort.SliceStable(entries, func(i, j int) bool {
+				return entries[i][0] < entries[j][0]
+			})
+
+			header := []string{"module", "version"}
+			return session.PrintTable(header, entries...)
+		},
+	}
+
+	return c
+}
+
+const (
+	cosmosSDKModulePrefix = "github.com/cosmos/cosmos-sdk"
+	ibcModulePrefix       = "github.com/cosmos/ibc-go"
+)
+
+// isModuleReplaced checks if a module path (or its parent paths) is in the replaced map.
+func isModuleReplaced(modulePath string, replacedMap map[string]bool) bool {
+	checkPath := modulePath
+	for checkPath != "" && checkPath != "." {
+		if replacedMap[checkPath] {
+			return true
+		}
+		// check parent path
+		if idx := strings.LastIndex(checkPath, "/"); idx > 0 {
+			checkPath = checkPath[:idx]
+		} else {
+			break
+		}
+	}
+	return false
+}
+
+// for a given module path by checking progressively shorter paths.
+func findBestMatchingVersion(modulePath string, depMap map[string]string) string {
+	checkPath := modulePath
+	for checkPath != "" && checkPath != "." {
+		if version, exists := depMap[checkPath]; exists {
+			return version
+		}
+		// check parent path
+		if idx := strings.LastIndex(checkPath, "/"); idx > 0 {
+			checkPath = checkPath[:idx]
+		} else {
+			break
+		}
+	}
+	return ""
+}
+
+// getIBCVersion tries to extract the ibc-go version from the module path or dependencies.
+func getIBCVersion(modulePath string, depMap map[string]string) (string, string) {
+	// find the root ibc-go module path (with major version)
+	parts := strings.Split(modulePath, "/")
+	for i := range parts {
+		if parts[i] == "ibc-go" && i+1 < len(parts) && strings.HasPrefix(parts[i+1], "v") {
+			root := strings.Join(parts[:i+2], "/")
+			ver := depMap[root]
+			// clean module name after root
+			mod := strings.TrimPrefix(modulePath, root+"/")
+			return mod, ver
+		}
+	}
+	return modulePath, ""
+}

integration/chain/cmd_modules_list_test.go

@@ -0,0 +1,72 @@
+//go:build !relayer
+
+package chain_test
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ignite/cli/v29/ignite/pkg/cmdrunner/step"
+	envtest "github.com/ignite/cli/v29/integration"
+)
+
+func TestModulesList(t *testing.T) {
+	var (
+		env = envtest.New(t)
+		app = env.ScaffoldApp("github.com/test/mars")
+	)
+
+	var buffer bytes.Buffer
+
+	env.Must(env.Exec("list modules",
+		step.NewSteps(step.New(
+			step.Exec(envtest.IgniteApp,
+				"c",
+				"modules",
+				"list",
+			),
+			step.Workdir(app.SourcePath()),
+		)),
+		envtest.ExecStdout(&buffer),
+	))
+
+	output := buffer.String()
+
+	// check for module header
+	require.Contains(t, output, "Module")
+	require.Contains(t, output, "Version")
+
+	// check for specific modules
+	require.Contains(t, output, "client/grpc/cmtservice")
+	require.Contains(t, output, "client/grpc/node")
+	require.Contains(t, output, "cosmossdk.io/x/circuit")
+	require.Contains(t, output, "cosmossdk.io/x/evidence")
+	require.Contains(t, output, "cosmossdk.io/x/feegrant/module")
+	require.Contains(t, output, "cosmossdk.io/x/nft/module")
+	require.Contains(t, output, "cosmossdk.io/x/upgrade")
+	require.Contains(t, output, "github.com/test/mars/x/mars")
+	require.Contains(t, output, "github.com/test/mars/x/mars/module")
+	require.Contains(t, output, "modules/apps/27-interchain-accounts")
+	require.Contains(t, output, "modules/apps/transfer")
+	require.Contains(t, output, "modules/core")
+	require.Contains(t, output, "x/auth")
+	require.Contains(t, output, "x/auth/tx")
+	require.Contains(t, output, "x/auth/tx/config")
+	require.Contains(t, output, "x/auth/vesting")
+	require.Contains(t, output, "x/authz")
+	require.Contains(t, output, "x/authz/module")
+	require.Contains(t, output, "x/bank")
+	require.Contains(t, output, "x/consensus")
+	require.Contains(t, output, "x/distribution")
+	require.Contains(t, output, "x/epochs")
+	require.Contains(t, output, "x/gov")
+	require.Contains(t, output, "x/group/module")
+	require.Contains(t, output, "x/mint")
+	require.Contains(t, output, "x/params")
+	require.Contains(t, output, "x/slashing")
+	require.Contains(t, output, "x/staking")
+
+	app.EnsureSteady()
+}