Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: improve settings list display #3167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kkashilk merged 2 commits into from
Oct 15, 2025
Merged

fix: improve settings list display #3167

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e732c0
fix: improve settings list display
konippi Oct 14, 2025
fcce8ce
fix: q settings list with --all option
konippi Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 147 additions & 17 deletions crates/chat-cli/src/cli/settings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use eyre::{
};
use globset::Glob;
use serde_json::json;
use strum::IntoEnumIterator;

use super::OutputFormat;
use crate::database::settings::Setting;
Expand All @@ -24,7 +25,20 @@ use crate::util::directories;
pub enum SettingsSubcommands {
/// Open the settings file
Open,
/// List all the settings
/// List settings
List {
/// Show all available settings
#[arg(long)]
all: bool,
/// Format of the output
#[arg(long, short, value_enum, default_value_t)]
format: OutputFormat,
/// Whether or not we want to modify state instead
#[arg(long, short, hide = true)]
state: bool,
},
/// List configured settings
#[command(hide = true)]
All {
/// Format of the output
#[arg(long, short, value_enum, default_value_t)]
Expand Down Expand Up @@ -54,6 +68,123 @@ pub struct SettingsArgs {
format: OutputFormat,
}

#[derive(Debug)]
struct SettingInfo {
/// Setting key
key: String,
/// Setting description
description: String,
/// Current setting value
current_value: Option<serde_json::Value>,
}

/// Print configured settings
fn print_configured_settings(os: &Os, format: OutputFormat) -> Result<()> {
let settings = os.database.settings.map().clone();
match format {
OutputFormat::Plain => {
for (key, value) in settings {
println!("{key} = {value}");
}
},
OutputFormat::Json => {
println!("{}", serde_json::to_string(&settings)?);
},
OutputFormat::JsonPretty => {
println!("{}", serde_json::to_string_pretty(&settings)?);
},
}
Ok(())
}

/// Print internal state table dump (hidden debug feature)
fn print_state_dump(os: &Os, format: OutputFormat) -> Result<()> {
let settings = os.database.get_all_entries()?;
match format {
OutputFormat::Plain => {
for (key, value) in settings {
println!("{key} = {value}");
}
},
OutputFormat::Json => {
println!("{}", serde_json::to_string(&settings)?);
},
OutputFormat::JsonPretty => {
println!("{}", serde_json::to_string_pretty(&settings)?);
},
}
Ok(())
}

/// Collect all settings with their metadata and current values
fn collect_settings(os: &Os) -> Vec<SettingInfo> {
use strum::EnumMessage;

Setting::iter()
.map(|setting| {
let key = setting.as_ref().to_string();
let description = setting.get_message().unwrap_or("No description").to_string();
let current_value = os.database.settings.get(setting).cloned();

SettingInfo {
key,
description,
current_value,
}
})
.collect()
}

/// Print settings list in plain text format with colors
fn print_settings_plain(settings: &[SettingInfo]) {
for setting in settings {
println!("{}", setting.key.as_str().cyan().bold());
println!(" Description: {}", setting.description);
match &setting.current_value {
Some(value) => println!(" Current: {}", value.to_string().green()),
None => println!(" Current: {}", "not set".dim()),
}
println!();
}
}

/// Print settings list in JSON or JSON Pretty format
fn print_settings_json(settings: &[SettingInfo], pretty: bool) -> Result<()> {
let settings_list: Vec<_> = settings
.iter()
.map(|s| {
json!({
"key": s.key,
"description": s.description,
"current_value": s.current_value,
})
})
.collect();

let output = if pretty {
serde_json::to_string_pretty(&settings_list)?
} else {
serde_json::to_string(&settings_list)?
};

println!("{}", output);
Ok(())
}

/// Print all available settings
fn print_all_settings(os: &Os, format: OutputFormat) -> Result<()> {
let settings = collect_settings(os);

match format {
OutputFormat::Plain => {
print_settings_plain(&settings);
Ok(())
},
OutputFormat::Json => print_settings_json(&settings, false),
OutputFormat::JsonPretty => print_settings_json(&settings, true),
}
}

impl SettingsArgs {
pub async fn execute(&self, os: &mut Os) -> Result<ExitCode> {
match self.cmd {
Expand All @@ -66,24 +197,23 @@ impl SettingsArgs {
bail!("The EDITOR environment variable is not set")
}
},
Some(SettingsSubcommands::List { all, format, state }) => {
if state {
print_state_dump(os, format)?;
} else if all {
print_all_settings(os, format)?;
} else {
print_configured_settings(os, format)?;
}
Ok(ExitCode::SUCCESS)
},
Some(SettingsSubcommands::All { format, state }) => {
let settings = match state {
true => os.database.get_all_entries()?,
false => os.database.settings.map().clone(),
};

match format {
OutputFormat::Plain => {
for (key, value) in settings {
println!("{key} = {value}");
}
},
OutputFormat::Json => println!("{}", serde_json::to_string(&settings)?),
OutputFormat::JsonPretty => {
println!("{}", serde_json::to_string_pretty(&settings)?);
},
// Deprecated: redirect to List behavior for backward compatibility
if state {
print_state_dump(os, format)?;
} else {
print_configured_settings(os, format)?;
}

Ok(ExitCode::SUCCESS)
},
None => {
Expand Down