Replace all ansi_term crates

prdoc/pr_2923.prdoc

@@ -0,0 +1,12 @@
+title: "Use `console` crate instead of `ansi_term`"
+
+doc:
+  - audience: Node Dev
+    description: |
+      This PR replace obsoleted `ansi_term` to `console`.
+
+crates:
+  - name: sc-informant
+    bump: patch
+  - name: sc-tracing
+    bump: patch

substrate/client/informant/Cargo.toml

@@ -16,7 +16,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
-ansi_term = { workspace = true }
+console = { workspace = true }
 futures = { workspace = true }
 futures-timer = { workspace = true }
 log = { workspace = true, default-features = true }

substrate/client/informant/src/display.rs

@@ -17,7 +17,7 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
 use crate::OutputFormat;
-use ansi_term::Colour;
+use console::{Attribute, Color};
 use log::info;
 use sc_client_api::ClientInfo;
 use sc_network::NetworkStatus;
@@ -146,15 +146,15 @@ impl<B: BlockT> InformantDisplay<B> {
 			target: "substrate",
 			"{} {}{} ({} peers), best: #{} ({}), finalized #{} ({}), {} {}",
 			level,
-			self.format.print_with_color(Colour::White.bold(), status),
+			self.format.print(Color::White, Some(Attribute::Bold), &status),
 			target,
-			self.format.print_with_color(Colour::White.bold(), num_connected_peers),
-			self.format.print_with_color(Colour::White.bold(), best_number),
+			self.format.print(Color::White, Some(Attribute::Bold), format!("{}", num_connected_peers)),
+			self.format.print(Color::White, Some(Attribute::Bold), format!("{}", best_number)),
 			best_hash,
-			self.format.print_with_color(Colour::White.bold(), finalized_number),
+			self.format.print(Color::White, Some(Attribute::Bold), format!("{}", finalized_number)),
 			info.chain.finalized_hash,
-			self.format.print_with_color(Colour::Green, format!("⬇ {}", TransferRateFormat(avg_bytes_per_sec_inbound))),
-			self.format.print_with_color(Colour::Red, format!("⬆ {}", TransferRateFormat(avg_bytes_per_sec_outbound))),
+			self.format.print(Color::Green, None, format!("⬇ {}", TransferRateFormat(avg_bytes_per_sec_inbound))),
+			self.format.print(Color::Red, None, format!("⬆ {}", TransferRateFormat(avg_bytes_per_sec_outbound))),
 		)
 	}
 }

substrate/client/informant/src/lib.rs

@@ -18,7 +18,7 @@
 
 //! Console informant. Prints sync progress and block events. Runs on the calling thread.
 
-use ansi_term::{Colour, Style};
+use console::{style, Attribute, Color};
 use futures::prelude::*;
 use futures_timer::Delay;
 use log::{debug, info, trace};
@@ -51,41 +51,15 @@ impl Default for OutputFormat {
 	}
 }
 
-enum ColorOrStyle {
-	Color(Colour),
-	Style(Style),
-}
-
-impl From<Colour> for ColorOrStyle {
-	fn from(value: Colour) -> Self {
-		Self::Color(value)
-	}
-}
-
-impl From<Style> for ColorOrStyle {
-	fn from(value: Style) -> Self {
-		Self::Style(value)
-	}
-}
-
-impl ColorOrStyle {
-	fn paint(&self, data: String) -> impl Display {
-		match self {
-			Self::Color(c) => c.paint(data),
-			Self::Style(s) => s.paint(data),
-		}
-	}
-}
-
 impl OutputFormat {
 	/// Print with color if `self.enable_color == true`.
-	fn print_with_color(
-		&self,
-		color: impl Into<ColorOrStyle>,
-		data: impl ToString,
-	) -> impl Display {
+	fn print(&self, color: Color, attr: Option<Attribute>, data: impl Display) -> impl Display {
 		if self.enable_color {
-			color.into().paint(data.to_string()).to_string()
+			let mut styled = style(data).fg(color);
+			if let Some(attr) = attr {
+				styled = styled.attr(attr);
+			}
+			styled.to_string()
 		} else {
 			data.to_string()
 		}
@@ -161,11 +135,19 @@ where
 				match maybe_ancestor {
 					Ok(ref ancestor) if ancestor.hash != *last_hash => info!(
 						"♻️  Reorg on #{},{} to #{},{}, common ancestor #{},{}",
-						format.print_with_color(Colour::Red.bold(), last_num),
+						format.print(Color::Red, Some(Attribute::Bold), format!("{}", last_num)),
 						last_hash,
-						format.print_with_color(Colour::Green.bold(), n.header.number()),
+						format.print(
+							Color::Green,
+							Some(Attribute::Bold),
+							format!("{}", n.header.number())
+						),
 						n.hash,
-						format.print_with_color(Colour::White.bold(), ancestor.number),
+						format.print(
+							Color::White,
+							Some(Attribute::Bold),
+							format!("{}", ancestor.number)
+						),
 						ancestor.hash,
 					),
 					Ok(_) => {},
@@ -191,7 +173,7 @@ where
 			info!(
 				target: "substrate",
 				"{best_indicator} Imported #{} ({} → {})",
-				format.print_with_color(Colour::White.bold(), n.header.number()),
+				format.print(Color::White, Some(Attribute::Bold), format!("{}", n.header.number())),
 				n.header.parent_hash(),
 				n.hash,
 			);

substrate/client/tracing/Cargo.toml

@@ -16,7 +16,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
-ansi_term = { workspace = true }
+console = { workspace = true }
 is-terminal = { workspace = true }
 chrono = { workspace = true }
 codec = { workspace = true, default-features = true }

substrate/client/tracing/src/logging/event_format.rs

@@ -17,7 +17,7 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
 use crate::logging::fast_local_time::FastLocalTime;
-use ansi_term::Colour;
+use console::style;
 use regex::Regex;
 use std::fmt::{self, Write};
 use tracing::{Event, Level, Subscriber};
@@ -166,11 +166,11 @@ impl<'a> fmt::Display for FmtLevel<'a> {
 	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 		if self.ansi {
 			match *self.level {
-				Level::TRACE => write!(f, "{}", Colour::Purple.paint(TRACE_STR)),
-				Level::DEBUG => write!(f, "{}", Colour::Blue.paint(DEBUG_STR)),
-				Level::INFO => write!(f, "{}", Colour::Green.paint(INFO_STR)),
-				Level::WARN => write!(f, "{}", Colour::Yellow.paint(WARN_STR)),
-				Level::ERROR => write!(f, "{}", Colour::Red.paint(ERROR_STR)),
+				Level::TRACE => write!(f, "{}", style(TRACE_STR).magenta().to_string()),
+				Level::DEBUG => write!(f, "{}", style(DEBUG_STR).blue().to_string()),
+				Level::INFO => write!(f, "{}", style(INFO_STR).green().to_string()),
+				Level::WARN => write!(f, "{}", style(WARN_STR).yellow().to_string()),
+				Level::ERROR => write!(f, "{}", style(ERROR_STR).red().to_string()),
 			}
 		} else {
 			match *self.level {
@@ -234,7 +234,6 @@ impl<'a> fmt::Display for FmtThreadName<'a> {
 //
 //       https://github.com/tokio-rs/tracing/blob/2f59b32/tracing-subscriber/src/fmt/time/mod.rs#L252
 mod time {
-	use ansi_term::Style;
 	use std::fmt;
 	use tracing_subscriber::fmt::{format, time::FormatTime};
 
@@ -247,10 +246,9 @@ mod time {
 		T: FormatTime,
 	{
 		if with_ansi {
-			let style = Style::new().dimmed();
-			write!(writer, "{}", style.prefix())?;
+			write!(writer, "\x1B[2m")?;
 			timer.format_time(writer)?;
-			write!(writer, "{}", style.suffix())?;
+			write!(writer, "\x1B[0m")?;
 		} else {
 			timer.format_time(writer)?;
 		}

substrate/client/tracing/src/logging/mod.rs

@@ -494,7 +494,7 @@ mod tests {
 	fn do_not_write_with_colors_on_tty_entrypoint() {
 		if env::var("ENABLE_LOGGING").is_ok() {
 			let _guard = init_logger("");
-			log::info!("{}", ansi_term::Colour::Yellow.paint(EXPECTED_LOG_MESSAGE));
+			log::info!("{}", console::style(EXPECTED_LOG_MESSAGE).yellow().to_string());
 		}
 	}