feat: Adding list command (#4034)

* feat: Adding `list` as copy of `find` command

* fix: Renaming found variables to listed

* feat: Format list differently than find

* feat: Working tree listing.

* feat: Adding tree fixture for list tests

* feat: Adding some convenience aliases

* fix: Faster tree construction

* fix: Minor nits

* fix: Working dependency tree graph

* feat: Adding `--long` formatting

* feat: Standardizing color usage

* feat: Updating JSON display for `list`

* feat: Better JSON parsing

* fix: Adjusting logic for listing

* fix: Adjusting JSON logic for listing DAG in JSON

* feat: Adding some integration testing

* feat: Adding `long` as a standalone format

* feat: Hide dependencies in `--long` unless users ask for it

* fix: Linting

* fix: Use yellow for tree branches

* fix: Only show dependencies when asked for

* fix: Fixing tests

* fix: Cleaning up docs

* fix: Refactoring tests

* fix: Addressing lint

* fix: Improving testing

* fix: Improving integration testing

* fix: Updating handling of edge-cases

* fix: Fixing pathing for JSON entries

* feat: Improving fixture for list

* fix: Resolving sorting bug

* fix: Address type presence in JSON response

* fix: Always set the type for the DAG tree

* fix: Removing `stage` fixture

* feat: Adding docs for `list` command

* feat: Adding `docs-starlight` docs

* fix: Addressing lints

* fix: Fixing tests

* feat: More updates to docs

* fix: Addressing lints

* fix: Checking experiment for `list`

* Update cli/commands/find/options.go

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix: Adding more nuance to the status of the `find` and `list` experiments

* fix: Addressing markdownlint errors

* fix: Dropping `json` from the `list` command (#4043)

* feat: Removing sort and group-by for `--dag` mode

* fix: Make tree branches less yellow

* fix: Updating docs

* fix: Fixing tree coloring

* fix: Updating assets for docs

* fix: Fixing integration tests

* fix: Fixing more assets

* fix: Removing unused flag names from Starlight docs

* fix: Updating `--help`

* fix: Updating error handling in `list/action.go` and `find/action.go`

* fix: Adding `mode` to find test

* fix: Fixing integration tests for find

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: yhakbar

cli/commands/commands.go

@@ -4,6 +4,7 @@ package commands
 import (
 	"github.com/gruntwork-io/terragrunt/cli/commands/find"
 	"github.com/gruntwork-io/terragrunt/cli/commands/info"
+	"github.com/gruntwork-io/terragrunt/cli/commands/list"
 	"github.com/gruntwork-io/terragrunt/cli/commands/stack"
 	"github.com/gruntwork-io/terragrunt/options"
 
@@ -70,6 +71,7 @@ func New(opts *options.TerragruntOptions) cli.Commands {
 
 	discoveryCommands := cli.Commands{
 		find.NewCommand(opts), // find
+		list.NewCommand(opts), // list
 	}.SetCategory(
 		&cli.Category{
 			Name:  DiscoveryCommandsCategoryName,

cli/commands/find/action.go

@@ -20,7 +20,7 @@ func Run(ctx context.Context, opts *Options) error {
 		d = d.WithHidden()
 	}
 
-	if opts.Dependencies || opts.External || opts.Sort == SortDAG {
+	if opts.Dependencies || opts.External || opts.Mode == ModeDAG {
 		d = d.WithDiscoverDependencies()
 	}
 
@@ -33,16 +33,20 @@ func Run(ctx context.Context, opts *Options) error {
 		return errors.New(err)
 	}
 
-	switch opts.Sort {
-	case SortAlpha:
+	switch opts.Mode {
+	case ModeNormal:
 		cfgs = cfgs.Sort()
-	case SortDAG:
+	case ModeDAG:
 		q, err := queue.NewQueue(cfgs)
 		if err != nil {
 			return errors.New(err)
 		}
 
 		cfgs = q.Entries()
+	default:
+		// This should never happen, because of validation in the command.
+		// If it happens, we want to throw so we can fix the validation.
+		return errors.New("invalid mode: " + opts.Mode)
 	}
 
 	foundCfgs, err := discoveredToFound(cfgs, opts)
@@ -140,7 +144,15 @@ type Colorizer struct {
 }
 
 // NewColorizer creates a new Colorizer.
-func NewColorizer() *Colorizer {
+func NewColorizer(shouldColor bool) *Colorizer {
+	if !shouldColor {
+		return &Colorizer{
+			unitColorizer:  func(s string) string { return s },
+			stackColorizer: func(s string) string { return s },
+			pathColorizer:  func(s string) string { return s },
+		}
+	}
+
 	return &Colorizer{
 		unitColorizer:  ansi.ColorFunc("blue+bh"),
 		stackColorizer: ansi.ColorFunc("green+bh"),
@@ -181,18 +193,7 @@ func (c *Colorizer) Colorize(config *FoundConfig) string {
 
 // outputText outputs the discovered configurations in text format.
 func outputText(opts *Options, configs FoundConfigs) error {
-	if opts.TerragruntOptions.Logger.Formatter().DisabledColors() || isStdoutRedirected() {
-		for _, config := range configs {
-			_, err := opts.Writer.Write([]byte(config.Path + "\n"))
-			if err != nil {
-				return errors.New(err)
-			}
-		}
-
-		return nil
-	}
-
-	colorizer := NewColorizer()
+	colorizer := NewColorizer(shouldColor(opts))
 
 	for _, config := range configs {
 		_, err := opts.Writer.Write([]byte(colorizer.Colorize(config) + "\n"))
@@ -204,6 +205,11 @@ func outputText(opts *Options, configs FoundConfigs) error {
 	return nil
 }
 
+// shouldColor returns true if the output should be colored.
+func shouldColor(opts *Options) bool {
+	return !(opts.TerragruntOptions.Logger.Formatter().DisabledColors() || isStdoutRedirected())
+}
+
 // isStdoutRedirected returns true if the stdout is redirected.
 func isStdoutRedirected() bool {
 	stat, err := os.Stdout.Stat()