Skip to content

chore: Refactor find & list so that they use a single write instead of intermediate writes #5027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2025
+45 −94
Merged

chore: Refactor find & list so that they use a single write instead of intermediate writes #5027

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions cli/commands/find/find.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"encoding/json"
"path/filepath"
"strings"

"github.com/gruntwork-io/terragrunt/pkg/log"
"github.com/gruntwork-io/terragrunt/telemetry"
Expand Down Expand Up @@ -282,16 +283,17 @@ func (c *Colorizer) Colorize(foundComponent *FoundComponent) string {

// outputText outputs the discovered components in text format.
func outputText(l log.Logger, opts *Options, components FoundComponents) error {
var buf strings.Builder

colorizer := NewColorizer(shouldColor(l))

for _, c := range components {
_, err := opts.Writer.Write([]byte(colorizer.Colorize(c) + "\n"))
if err != nil {
return errors.New(err)
}
buf.WriteString(colorizer.Colorize(c) + "\n")
}

return nil
_, err := opts.Writer.Write([]byte(buf.String()))

return errors.New(err)
}

// shouldColor returns true if the output should be colored.
Expand Down
127 changes: 38 additions & 89 deletions cli/commands/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,23 +341,15 @@ func shouldColor(l log.Logger) bool {

// renderLong renders the components in a long format.
func renderLong(opts *Options, components ListedComponents, c *Colorizer) error {
var buf strings.Builder

longestPathLen := getLongestPathLen(components)

err := renderLongHeadings(opts, c, longestPathLen)
if err != nil {
return errors.New(err)
}
buf.WriteString(buildLongHeadings(opts, c, longestPathLen))

for _, component := range components {
_, err := opts.Writer.Write([]byte(c.ColorizeType(component.Type)))
if err != nil {
return errors.New(err)
}

_, err = opts.Writer.Write([]byte(" " + c.Colorize(component)))
if err != nil {
return errors.New(err)
}
buf.WriteString(c.ColorizeType(component.Type))
buf.WriteString(" " + c.Colorize(component))

if opts.Dependencies && len(component.Dependencies) > 0 {
colorizedDeps := []string{}
Expand All @@ -370,92 +362,67 @@ func renderLong(opts *Options, components ListedComponents, c *Colorizer) error

dependenciesPadding := (longestPathLen - len(component.Path)) + extraDependenciesPadding
for range dependenciesPadding {
_, err = opts.Writer.Write([]byte(" "))
if err != nil {
return errors.New(err)
}
buf.WriteString(" ")
}

_, err = opts.Writer.Write([]byte(strings.Join(colorizedDeps, ", ")))
if err != nil {
return errors.New(err)
}
buf.WriteString(strings.Join(colorizedDeps, ", "))
}

_, err = opts.Writer.Write([]byte("\n"))
if err != nil {
return errors.New(err)
}
buf.WriteString("\n")
}

return nil
_, err := opts.Writer.Write([]byte(buf.String()))

return errors.New(err)
}

// renderLongHeadings renders the headings for the long format.
func renderLongHeadings(opts *Options, c *Colorizer, longestPathLen int) error {
_, err := opts.Writer.Write([]byte(c.ColorizeHeading("Type Path")))
if err != nil {
return errors.New(err)
}
// buildLongHeadings renders the headings for the long format.
func buildLongHeadings(opts *Options, c *Colorizer, longestPathLen int) string {
var buf strings.Builder

buf.WriteString(c.ColorizeHeading("Type Path"))

if opts.Dependencies {
const extraDependenciesPadding = 2

dependenciesPadding := (longestPathLen - len("Path")) + extraDependenciesPadding
for range dependenciesPadding {
_, err = opts.Writer.Write([]byte(" "))
if err != nil {
return errors.New(err)
}
buf.WriteString(" ")
}

_, err = opts.Writer.Write([]byte(c.ColorizeHeading("Dependencies")))
if err != nil {
return errors.New(err)
}
buf.WriteString(c.ColorizeHeading("Dependencies"))
}

_, err = opts.Writer.Write([]byte("\n"))
if err != nil {
return errors.New(err)
}
buf.WriteString("\n")

return nil
return buf.String()
}

// renderTabular renders the components in a tabular format.
func renderTabular(opts *Options, components ListedComponents, c *Colorizer) error {
var buf strings.Builder

maxCols, colWidth := getMaxCols(components)

for i, component := range components {
if i > 0 && i%maxCols == 0 {
_, err := opts.Writer.Write([]byte("\n"))
if err != nil {
return errors.New(err)
}
buf.WriteString("\n")
}

_, err := opts.Writer.Write([]byte(c.Colorize(component)))
if err != nil {
return errors.New(err)
}
buf.WriteString(c.Colorize(component))

// Add padding until the length of maxCols
padding := colWidth - len(component.Path)
for range padding {
_, err := opts.Writer.Write([]byte(" "))
if err != nil {
return errors.New(err)
}
buf.WriteString(" ")
}
}

_, err := opts.Writer.Write([]byte("\n"))
if err != nil {
return errors.New(err)
}
buf.WriteString("\n")

return nil
_, err := opts.Writer.Write([]byte(buf.String()))

return errors.New(err)
}

// outputTree outputs the discovered components in tree format.
Expand Down Expand Up @@ -705,9 +672,9 @@ func getLongestPathLen(components ListedComponents) int {

// renderDot renders the components in GraphViz DOT format.
func renderDot(opts *Options, components ListedComponents) error {
if _, err := opts.Writer.Write([]byte("digraph {\n")); err != nil {
return errors.New(err)
}
var buf strings.Builder

buf.WriteString("digraph {\n")

sortedComponents := make(ListedComponents, len(components))
copy(sortedComponents, components)
Expand All @@ -729,34 +696,16 @@ func renderDot(opts *Options, components ListedComponents) error {
style = "[color=red]"
}

if _, writeErr := opts.Writer.Write(
fmt.Appendf(
nil,
"\t\"%s\" %s;\n",
component.Path,
style,
),
); writeErr != nil {
return errors.New(writeErr)
}
buf.WriteString(fmt.Sprintf("\t\"%s\" %s;\n", component.Path, style))

for _, dep := range component.Dependencies {
if _, writeErr := opts.Writer.Write(
fmt.Appendf(
nil,
"\t\"%s\" -> \"%s\";\n",
component.Path,
dep.Path,
),
); writeErr != nil {
return errors.New(writeErr)
}
buf.WriteString(fmt.Sprintf("\t\"%s\" -> \"%s\";\n", component.Path, dep.Path))
}
}

if _, err := opts.Writer.Write([]byte("}\n")); err != nil {
return errors.New(err)
}
buf.WriteString("}\n")

return nil
_, err := opts.Writer.Write([]byte(buf.String()))

return errors.New(err)
}
Loading