fix(cli): Deprecate color flag

erezrokah · erezrokah · commit 25006d43a6df · 2022-10-16T10:34:19.000+03:00
diff --git a/cli/cmd/root.go b/cli/cmd/root.go
@@ -31,7 +31,6 @@ Find more information at:
 func NewCmdRoot() *cobra.Command {
 	logLevel := enum.NewEnum([]string{"trace", "debug", "info", "warn", "error"}, "info")
 	logFormat := enum.NewEnum([]string{"text", "json"}, "text")
-	noColor := false
 	logConsole := false
 	noLogFile := false
 	logFileName := "cloudquery.log"
@@ -79,7 +78,7 @@ func NewCmdRoot() *cobra.Command {
 				if logFormat.String() == "text" {
 					writers = append(writers, zerolog.ConsoleWriter{
 						Out:             os.Stderr,
-						NoColor:         noColor,
+						NoColor:         true,
 						FormatTimestamp: formatTimestampUtcRfc3339,
 					})
 				} else {
@@ -110,6 +109,7 @@ func NewCmdRoot() *cobra.Command {
 					return err
 				}
 			}
+
 			return nil
 		},
 		PersistentPostRun: func(cmd *cobra.Command, args []string) {
@@ -121,7 +121,11 @@ func NewCmdRoot() *cobra.Command {
 
 	cmd.PersistentFlags().String("data-dir", "./.cq", "set persistent data directory (env: CQ_DATA_DIR)")
 
-	cmd.PersistentFlags().String("color", "auto", "Enable colorized output (on, off, auto)")
+	cmd.PersistentFlags().String("color", "auto", "Enable colorized output when log-console is set (on, off, auto)")
+	err := cmd.PersistentFlags().MarkDeprecated("color", "console logs are always colorless")
+	if err != nil {
+		panic(err)
+	}
 
 	// Logging Flags
 	cmd.PersistentFlags().BoolVar(&logConsole, "log-console", false, "enable console logging")
diff --git a/website/pages/docs/reference/cli/cloudquery.md b/website/pages/docs/reference/cli/cloudquery.md
@@ -17,7 +17,6 @@ Find more information at:
 ### Options
 
 ```
-      --color string           Enable colorized output (on, off, auto) (default "auto")
       --data-dir string        set persistent data directory (env: CQ_DATA_DIR) (default "./.cq")
   -h, --help                   help for cloudquery
       --log-console            enable console logging
diff --git a/website/pages/docs/reference/cli/cloudquery_sync.md b/website/pages/docs/reference/cli/cloudquery_sync.md
@@ -32,7 +32,6 @@ cloudquery sync ./directory ./aws.yml ./pg.yml
 ### Options inherited from parent commands
 
 ```
-      --color string           Enable colorized output (on, off, auto) (default "auto")
       --data-dir string        set persistent data directory (env: CQ_DATA_DIR) (default "./.cq")
       --log-console            enable console logging
       --log-file-name string   Log filename (default "cloudquery.log")
