editoast: add cli arg to control colored output

Author: leovalais

editoast/Cargo.lock

@@ -64,6 +64,7 @@ osm4routing = "0.5.8"
 osmpbfreader = "0.16.0"
 itertools = "0.11"
 utoipa = { version = "3.5", features = ["actix_extras"] }
+atty = "0.2.14"
 
 [dev-dependencies]
 async-std = { version = "1.12", features = ["attributes", "tokio1"] }

editoast/Cargo.toml

@@ -1,7 +1,7 @@
 mod postgres_config;
 mod redis_config;
 
-use clap::{Args, Parser, Subcommand};
+use clap::{Args, Parser, Subcommand, ValueEnum};
 use derivative::Derivative;
 pub use postgres_config::PostgresConfig;
 pub use redis_config::RedisConfig;
@@ -14,10 +14,21 @@ pub struct Client {
     pub postgres_config: PostgresConfig,
     #[command(flatten)]
     pub redis_config: RedisConfig,
+    #[arg(long, env, value_enum, default_value_t = Color::Auto)]
+    pub color: Color,
     #[command(subcommand)]
     pub command: Commands,
 }
 
+#[derive(ValueEnum, Debug, Derivative, Clone)]
+#[derivative(Default)]
+pub enum Color {
+    Never,
+    Always,
+    #[derivative(Default)]
+    Auto,
+}
+
 #[derive(Subcommand, Debug)]
 pub enum Commands {
     Runserver(RunserverArgs),

editoast/src/client/mod.rs

@@ -29,7 +29,7 @@ use actix_web::{App, HttpServer};
 use chashmap::CHashMap;
 use clap::Parser;
 use client::{
-    ClearArgs, Client, Commands, GenerateArgs, ImportProfileSetArgs, ImportRailjsonArgs,
+    ClearArgs, Client, Color, Commands, GenerateArgs, ImportProfileSetArgs, ImportRailjsonArgs,
     PostgresConfig, RedisConfig, RunserverArgs,
 };
 use colored::*;
@@ -71,6 +71,12 @@ async fn run() -> Result<(), Box<dyn Error + Send + Sync>> {
     let pg_config = client.postgres_config;
     let redis_config = client.redis_config;
 
+    match client.color {
+        Color::Never => colored::control::set_override(false),
+        Color::Always => colored::control::set_override(true),
+        Color::Auto => colored::control::set_override(atty::is(atty::Stream::Stderr)),
+    }
+
     match client.command {
         Commands::Runserver(args) => runserver(args, pg_config, redis_config).await,
         Commands::Generate(args) => generate(args, pg_config, redis_config).await,