syntax-highlight example config

Author: upsj

Cargo.toml

@@ -15,6 +15,7 @@ documented = "0.8.0"
 futures = "0.3.30"
 gitlab = "0.1705.0"
 http = "1.1.0"
+inkjet = { version = "0.11.1", features = ["language-toml", "theme", "terminal"] }
 itertools = "0.13.0"
 log = "0.4.22"
 serde = "1.0.210"
@@ -23,6 +24,7 @@ serde_json = "1.0.128"
 shellexpand = "3.1.0"
 simple_logger = { version = "5.0.0", features = ["stderr"] }
 struct-field-names-as-array = "0.3.0"
+termcolor = "1.4.1"
 tokio = { version = "1.40.0", features = ["full"] }
 tokio-util = "0.7.12"
 toml = "0.8.19"

src/config.rs

@@ -1,5 +1,10 @@
 use anyhow::Context;
 use documented::DocumentedFields;
+use inkjet::{
+    formatter::Terminal,
+    theme::{vendored, Theme},
+    Highlighter, Language,
+};
 use itertools::Itertools;
 use log::warn;
 use std::{
@@ -9,6 +14,7 @@ use std::{
     path::{Path, PathBuf},
 };
 use struct_field_names_as_array::FieldNamesAsArray;
+use termcolor::{ColorChoice, StandardStream};
 use toml_edit::{DocumentMut, RawString};
 
 use serde::{de::Error, Deserializer, Serializer};
@@ -358,6 +364,19 @@ pub fn get_example_config_str() -> String {
     document.to_string()
 }
 
+pub fn print_example_config_highlighted() {
+    let config = get_example_config_str();
+    let mut highlighter = Highlighter::new();
+    let language = Language::Toml;
+    let theme: Theme = Theme::from_helix(vendored::BASE16_TERMINAL).unwrap();
+    let stream = StandardStream::stdout(ColorChoice::Auto);
+    let formatter = Terminal::new(theme, stream);
+    highlighter
+        .highlight_to_writer(language, &formatter, &config, &mut std::io::sink())
+        .unwrap();
+    println!();
+}
+
 pub fn write_example_config(filename: &Path) -> anyhow::Result<()> {
     let mut file = std::fs::File::create_new(filename)
         .context(format!("Failed creating config file {:?}", filename))?;

src/main.rs

@@ -27,7 +27,7 @@ fn main() -> anyhow::Result<()> {
         .unwrap();
     match cli.command {
         cli::Command::CreateExampleConfig => config::write_example_config(&cli.paths.config_file),
-        cli::Command::ShowExampleConfig => Ok(println!("{}", config::get_default_config_str())),
+        cli::Command::ShowExampleConfig => Ok(config::print_example_config_highlighted()),
         cli::Command::CheckConfig => check_config::check(&cli.paths),
         cli::Command::ShowConfig => check_config::show(&cli.paths),
         cli::Command::Configure => configure::configure(&cli.paths),