feat: format output colors and set flag global no-color ✨

LerianStudio · Nov 27, 2024 · 7fae4c0 · 7fae4c0
1 parent 4e7f54c
commit 7fae4c0
Show file tree

Hide file tree

Showing 51 changed files with 203 additions and 137 deletions.
diff --git a/components/mdz/pkg/cmd/account/create.go b/components/mdz/pkg/cmd/account/create.go
@@ -3,7 +3,6 @@ package account
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
 	"strconv"
 
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
@@ -92,8 +91,7 @@ func (f *factoryAccountCreate) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The Account ID %s has been successfully created", resp.ID))
+	output.FormatAndPrint(f.factory, resp.ID, "Account", output.Created)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/account/create_test.go b/components/mdz/pkg/cmd/account/create_test.go
@@ -2,9 +2,10 @@ package account
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"
@@ -92,5 +93,5 @@ func Test_newCmdAccountCreate(t *testing.T) {
 	assert.NoError(t, err)
 
 	output := orgFactory.factory.IOStreams.Out.(*bytes.Buffer).String()
-	assert.Contains(t, output, "The Account ID 01933f96-ed04-7c57-be5b-c091388830f8 has been successfully created")
+	assert.Contains(t, output, "The Account 01933f96-ed04-7c57-be5b-c091388830f8 has been successfully created.")
 }
diff --git a/components/mdz/pkg/cmd/account/delete.go b/components/mdz/pkg/cmd/account/delete.go
@@ -1,8 +1,6 @@
 package account
 
 import (
-	"fmt"
-
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/internal/rest"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/cmd/utils"
@@ -73,8 +71,7 @@ func (f *factoryAccountDelete) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The Account ID %s has been successfully deleted.", f.AccountID))
+	output.FormatAndPrint(f.factory, f.AccountID, "Account", output.Deleted)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/account/delete_test.go b/components/mdz/pkg/cmd/account/delete_test.go
@@ -2,9 +2,10 @@ package account
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"
@@ -43,5 +44,5 @@ func Test_newCmdAccountDelete(t *testing.T) {
 	assert.NoError(t, err)
 
 	output := orgFactory.factory.IOStreams.Out.(*bytes.Buffer).String()
-	assert.Contains(t, output, "The Account ID 444 has been successfully deleted.")
+	assert.Contains(t, output, "The Account 444 has been successfully deleted.")
 }
diff --git a/components/mdz/pkg/cmd/account/describe.go b/components/mdz/pkg/cmd/account/describe.go
@@ -116,10 +116,12 @@ func (f *factoryAccountDescribe) outputAccount(cmd *cobra.Command, account *mmod
 func (f *factoryAccountDescribe) describePrint(account *mmodel.Account) {
 	tbl := table.New("FIELDS", "VALUES")
 
-	headerFmt := color.New(color.FgYellow).SprintfFunc()
-	fieldFmt := color.New(color.FgYellow).SprintfFunc()
+	if !f.factory.NoColor {
+		headerFmt := color.New(color.FgYellow).SprintfFunc()
+		fieldFmt := color.New(color.FgYellow).SprintfFunc()
+		tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
+	}
 
-	tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
 	tbl.WithWriter(f.factory.IOStreams.Out)
 
 	tbl.AddRow("ID:", account.ID)

diff --git a/components/mdz/pkg/cmd/account/list.go b/components/mdz/pkg/cmd/account/list.go
@@ -70,9 +70,6 @@ func (f *factoryAccountList) runE(cmd *cobra.Command, _ []string) error {
 		return nil
 	}
 
-	headerFmt := color.New(color.FgYellow).SprintfFunc()
-	columnFmt := color.New(color.FgYellow).SprintfFunc()
-
 	tbl := table.New(
 		"ID",
 		"NAME",
@@ -82,7 +79,12 @@ func (f *factoryAccountList) runE(cmd *cobra.Command, _ []string) error {
 		"CREATED_AT",
 	)
 
-	tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(columnFmt)
+	if !f.factory.NoColor {
+		headerFmt := color.New(color.FgYellow).SprintfFunc()
+		fieldFmt := color.New(color.FgYellow).SprintfFunc()
+		tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
+	}
+
 	tbl.WithWriter(f.factory.IOStreams.Out)
 
 	for _, i := range accounts.Items {

diff --git a/components/mdz/pkg/cmd/account/update.go b/components/mdz/pkg/cmd/account/update.go
@@ -3,7 +3,6 @@ package account
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
 	"strconv"
 
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
@@ -106,8 +105,7 @@ func (f *factoryAccountUpdate) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The Account ID %s has been successfully updated.", resp.ID))
+	output.FormatAndPrint(f.factory, resp.ID, "Account", output.Updated)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/account/update_test.go b/components/mdz/pkg/cmd/account/update_test.go
@@ -2,16 +2,16 @@ package account
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/ptr"
 	"github.com/LerianStudio/midaz/pkg/mmodel"
-
-	"github.com/stretchr/testify/assert"
 )
 
 func Test_newCmdLedgerUpdate(t *testing.T) {
@@ -71,5 +71,5 @@ func Test_newCmdLedgerUpdate(t *testing.T) {
 	assert.NoError(t, err)
 
 	output := orgFactory.factory.IOStreams.Out.(*bytes.Buffer).String()
-	assert.Contains(t, output, "The Account ID 777 has been successfully updated.")
+	assert.Contains(t, output, "The Account 777 has been successfully updated.")
 }
diff --git a/components/mdz/pkg/cmd/asset/create.go b/components/mdz/pkg/cmd/asset/create.go
@@ -3,7 +3,6 @@ package asset
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
 
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/internal/rest"
@@ -76,8 +75,7 @@ func (f *factoryAssetCreate) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The Asset ID %s has been successfully created", resp.ID))
+	output.FormatAndPrint(f.factory, resp.ID, "Asset", output.Created)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/asset/create_test.go b/components/mdz/pkg/cmd/asset/create_test.go
@@ -2,9 +2,10 @@ package asset
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"
@@ -89,5 +90,5 @@ func Test_newCmdAssetCreate(t *testing.T) {
 	assert.NoError(t, err)
 
 	output := orgFactory.factory.IOStreams.Out.(*bytes.Buffer).String()
-	assert.Contains(t, output, "The Asset ID 01930219-2c25-7a37-a5b9-610d44ae0a27 has been successfully created")
+	assert.Contains(t, output, "The Asset 01930219-2c25-7a37-a5b9-610d44ae0a27 has been successfully created.")
 }
diff --git a/components/mdz/pkg/cmd/asset/delete.go b/components/mdz/pkg/cmd/asset/delete.go
@@ -1,8 +1,6 @@
 package asset
 
 import (
-	"fmt"
-
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/internal/rest"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/cmd/utils"
@@ -63,8 +61,7 @@ func (f *factoryAssetDelete) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The Asset ID %s has been successfully deleted.", f.AssetID))
+	output.FormatAndPrint(f.factory, f.AssetID, "Asset", output.Deleted)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/asset/delete_test.go b/components/mdz/pkg/cmd/asset/delete_test.go
@@ -2,9 +2,10 @@ package asset
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"
@@ -42,5 +43,5 @@ func Test_newCmdAssetDelete(t *testing.T) {
 	assert.NoError(t, err)
 
 	output := orgFactory.factory.IOStreams.Out.(*bytes.Buffer).String()
-	assert.Contains(t, output, "The Asset ID 444 has been successfully deleted.")
+	assert.Contains(t, output, "The Asset 444 has been successfully deleted.")
 }
diff --git a/components/mdz/pkg/cmd/asset/describe.go b/components/mdz/pkg/cmd/asset/describe.go
@@ -106,10 +106,12 @@ func (f *factoryAssetDescribe) outputAsset(cmd *cobra.Command, asset *mmodel.Ass
 func (f *factoryAssetDescribe) describePrint(asset *mmodel.Asset) {
 	tbl := table.New("FIELDS", "VALUES")
 
-	headerFmt := color.New(color.FgYellow).SprintfFunc()
-	fieldFmt := color.New(color.FgYellow).SprintfFunc()
+	if !f.factory.NoColor {
+		headerFmt := color.New(color.FgYellow).SprintfFunc()
+		fieldFmt := color.New(color.FgYellow).SprintfFunc()
+		tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
+	}
 
-	tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
 	tbl.WithWriter(f.factory.IOStreams.Out)
 
 	tbl.AddRow("ID:", asset.ID)

diff --git a/components/mdz/pkg/cmd/asset/list.go b/components/mdz/pkg/cmd/asset/list.go
@@ -60,9 +60,6 @@ func (f *factoryAssetList) runE(cmd *cobra.Command, _ []string) error {
 		return nil
 	}
 
-	headerFmt := color.New(color.FgYellow).SprintfFunc()
-	columnFmt := color.New(color.FgYellow).SprintfFunc()
-
 	tbl := table.New(
 		"ID",
 		"NAME",
@@ -73,7 +70,12 @@ func (f *factoryAssetList) runE(cmd *cobra.Command, _ []string) error {
 		"CREATED_AT",
 	)
 
-	tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(columnFmt)
+	if !f.factory.NoColor {
+		headerFmt := color.New(color.FgYellow).SprintfFunc()
+		fieldFmt := color.New(color.FgYellow).SprintfFunc()
+		tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
+	}
+
 	tbl.WithWriter(f.factory.IOStreams.Out)
 
 	for _, i := range leds.Items {

diff --git a/components/mdz/pkg/cmd/asset/update.go b/components/mdz/pkg/cmd/asset/update.go
@@ -3,7 +3,6 @@ package asset
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
 
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/internal/rest"
@@ -91,8 +90,7 @@ func (f *factoryAssetUpdate) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The Asset ID %s has been successfully updated.", resp.ID))
+	output.FormatAndPrint(f.factory, resp.ID, "Asset", output.Updated)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/asset/update_test.go b/components/mdz/pkg/cmd/asset/update_test.go
@@ -2,9 +2,10 @@ package asset
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"
@@ -70,5 +71,5 @@ func Test_newCmdLedgerUpdate(t *testing.T) {
 	assert.NoError(t, err)
 
 	output := orgFactory.factory.IOStreams.Out.(*bytes.Buffer).String()
-	assert.Contains(t, output, "The Asset ID 412 has been successfully updated.")
+	assert.Contains(t, output, "The Asset 412 has been successfully updated.")
 }
diff --git a/components/mdz/pkg/cmd/ledger/create.go b/components/mdz/pkg/cmd/ledger/create.go
@@ -3,7 +3,6 @@ package ledger
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
 
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/internal/rest"
@@ -63,8 +62,7 @@ func (f *factoryLedgerCreate) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The ledger_id %s has been successfully created", resp.ID))
+	output.FormatAndPrint(f.factory, resp.ID, "Ledger", output.Created)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/ledger/create_test.go b/components/mdz/pkg/cmd/ledger/create_test.go
@@ -2,9 +2,10 @@ package ledger
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"
@@ -76,6 +77,5 @@ func Test_newCmdLedgerCreate(t *testing.T) {
 	assert.NoError(t, err)
 
 	output := orgFactory.factory.IOStreams.Out.(*bytes.Buffer).String()
-	assert.Contains(t, output, "The ledger_id 0192e251-328d-7390-99f5-5c54980115ed has been successfully created")
-
+	assert.Contains(t, output, "The Ledger 0192e251-328d-7390-99f5-5c54980115ed has been successfully created.")
 }
diff --git a/components/mdz/pkg/cmd/ledger/delete.go b/components/mdz/pkg/cmd/ledger/delete.go
@@ -1,8 +1,6 @@
 package ledger
 
 import (
-	"fmt"
-
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/internal/rest"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/cmd/utils"
@@ -45,8 +43,7 @@ func (f *factoryLedgerDelete) runE(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	output.Printf(f.factory.IOStreams.Out,
-		fmt.Sprintf("The Ledger %s has been successfully deleted.", f.ledgerID))
+	output.FormatAndPrint(f.factory, f.ledgerID, "Ledger", output.Deleted)
 
 	return nil
 }

diff --git a/components/mdz/pkg/cmd/ledger/delete_test.go b/components/mdz/pkg/cmd/ledger/delete_test.go
@@ -2,9 +2,10 @@ package ledger
 
 import (
 	"bytes"
-	"go.uber.org/mock/gomock"
 	"testing"
 
+	"go.uber.org/mock/gomock"
+
 	"github.com/LerianStudio/midaz/components/mdz/internal/domain/repository"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/factory"
 	"github.com/LerianStudio/midaz/components/mdz/pkg/iostreams"

diff --git a/components/mdz/pkg/cmd/ledger/describe.go b/components/mdz/pkg/cmd/ledger/describe.go
@@ -84,10 +84,12 @@ func (f *factoryLedgerDescribe) runE(cmd *cobra.Command, _ []string) error {
 func (f *factoryLedgerDescribe) describePrint(led *mmodel.Ledger) {
 	tbl := table.New("FIELDS", "VALUES")
 
-	headerFmt := color.New(color.FgYellow).SprintfFunc()
-	fieldFmt := color.New(color.FgYellow).SprintfFunc()
+	if !f.factory.NoColor {
+		headerFmt := color.New(color.FgYellow).SprintfFunc()
+		fieldFmt := color.New(color.FgYellow).SprintfFunc()
+		tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
+	}
 
-	tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(fieldFmt)
 	tbl.WithWriter(f.factory.IOStreams.Out)
 
 	tbl.AddRow("ID:", led.ID)