rainfrog edit command for configs (#271)

* rainfrog edit command for configs

* add placeholder for db configs in default config

* update usage info

Author: achristmascarl

.config/rainfrog_config.toml

@@ -3,6 +3,10 @@ mouse_mode = true
 data_compact_columns = true
 data_row_spacer = false
 
+[db]
+# you can add frequently used database connections here. example:
+# dev-postgres = { host = "localhost", driver = "postgres", port = 5499, database = "rainfrog", username = "root" }
+
 [keybindings.Menu]
 "<Ctrl-c>" = "Quit"
 "q" = "AbortQuery"

README.md

@@ -214,7 +214,11 @@ installation instructions: [ODPI-C Client Library Loading](https://odpi-c.readth
 ## usage
 
 ```sh
-Usage: rainfrog [OPTIONS]
+Usage: rainfrog [OPTIONS] [COMMAND]
+
+Commands:
+  edit  Edit the config file (create it first if missing)
+  help  Print this message or the help of the given subcommand(s)
 
 Options:
   -M, --mouse <MOUSE_MODE>   Whether to enable mouse event support. If enabled, the default mouse event handling for your terminal

src/cli.rs

@@ -15,6 +15,9 @@ use crate::{
 #[derive(Parser, Debug, Clone)]
 #[command(author, version = version(), about)]
 pub struct Cli {
+  #[command(subcommand)]
+  pub command: Option<CliCommand>,
+
   #[arg(
     short = 'M',
     long = "mouse",
@@ -53,6 +56,12 @@ pub struct Cli {
   pub connection_name: Option<String>,
 }
 
+#[derive(clap::Subcommand, Debug, Clone, Copy, PartialEq, Eq)]
+pub enum CliCommand {
+  /// Edit the config file (create it first if missing)
+  Edit,
+}
+
 #[derive(Parser, Debug, Clone, Copy, Deserialize, PartialEq, Eq)]
 pub enum Driver {
   #[serde(alias = "postgres", alias = "POSTGRES")]
@@ -248,4 +257,10 @@ mod tests {
       assert!(err.to_string().contains("Invalid connection URL format"), "Unexpected error for {url}: {err}");
     }
   }
+
+  #[test]
+  fn parses_edit_subcommand() {
+    let cli = Cli::parse_from(["rainfrog", "edit"]);
+    assert_eq!(cli.command, Some(CliCommand::Edit));
+  }
 }

src/config.rs

@@ -42,6 +42,14 @@ const FRAGMENT: &AsciiSet = &CONTROLS
   .add(b'/');
 
 const CONFIG: &str = include_str!("../.config/rainfrog_config.toml");
+const CONFIG_FILE_CANDIDATES: [(&str, config::FileFormat); 5] = [
+  ("rainfrog_config.json5", config::FileFormat::Json5),
+  ("rainfrog_config.json", config::FileFormat::Json),
+  ("rainfrog_config.yaml", config::FileFormat::Yaml),
+  ("rainfrog_config.toml", config::FileFormat::Toml),
+  ("rainfrog_config.ini", config::FileFormat::Ini),
+];
+const PREFERRED_CONFIG_FILENAME: &str = "rainfrog_config.toml";
 
 #[derive(Clone, Debug, Deserialize, Default)]
 pub struct AppConfig {
@@ -128,15 +136,8 @@ impl Config {
       .set_default("_config_dir", config_dir.to_str().unwrap())?
       .set_default("_favorites_dir", favorites_dir.to_str().unwrap())?;
 
-    let config_files = [
-      ("rainfrog_config.json5", config::FileFormat::Json5),
-      ("rainfrog_config.json", config::FileFormat::Json),
-      ("rainfrog_config.yaml", config::FileFormat::Yaml),
-      ("rainfrog_config.toml", config::FileFormat::Toml),
-      ("rainfrog_config.ini", config::FileFormat::Ini),
-    ];
     let mut found_config = false;
-    for (file, format) in &config_files {
+    for (file, format) in &CONFIG_FILE_CANDIDATES {
       builder = builder.add_source(config::File::from(config_dir.join(file)).format(*format).required(false));
       if config_dir.join(file).exists() {
         found_config = true
@@ -183,6 +184,19 @@ impl Config {
   }
 }
 
+pub fn preferred_config_path() -> PathBuf {
+  crate::utils::get_config_dir().join(PREFERRED_CONFIG_FILENAME)
+}
+
+pub fn existing_config_path() -> Option<PathBuf> {
+  let config_dir = crate::utils::get_config_dir();
+  CONFIG_FILE_CANDIDATES.iter().map(|(name, _)| config_dir.join(name)).find(|path| path.exists())
+}
+
+pub fn default_config_contents() -> &'static str {
+  CONFIG
+}
+
 #[derive(Clone, Debug, Default, Deref, DerefMut)]
 pub struct KeyBindings(pub HashMap<Focus, HashMap<Vec<KeyEvent>, Action>>);
 

src/main.rs

@@ -17,14 +17,16 @@ pub mod utils;
 pub mod vim;
 
 use std::{
-  env,
+  env, fs,
   io::{self, Write},
+  path::Path,
+  process::Command,
 };
 
 use clap::Parser;
-use cli::{Cli, Driver, extract_driver_from_url, prompt_for_database_selection};
+use cli::{Cli, CliCommand, Driver, extract_driver_from_url, prompt_for_database_selection};
 use color_eyre::eyre::Result;
-use config::{Config, ConnectionString};
+use config::{Config, ConnectionString, default_config_contents, existing_config_path, preferred_config_path};
 use dotenvy::dotenv;
 use keyring::get_password;
 
@@ -93,13 +95,51 @@ fn resolve_driver(args: &mut Cli, config: &Config) -> Result<Driver> {
   Ok(driver)
 }
 
+fn ensure_config_file(path: &Path) -> Result<()> {
+  if path.exists() {
+    return Ok(());
+  }
+
+  if let Some(parent) = path.parent() {
+    fs::create_dir_all(parent)?;
+  }
+  fs::write(path, default_config_contents())?;
+  Ok(())
+}
+
+fn open_editor(path: &Path) -> Result<()> {
+  let editor = env::var("VISUAL")
+    .ok()
+    .filter(|value| !value.trim().is_empty())
+    .or_else(|| env::var("EDITOR").ok().filter(|value| !value.trim().is_empty()))
+    .unwrap_or_else(|| "vi".to_string());
+
+  let mut parts = editor.split_whitespace();
+  let program = parts.next().ok_or_else(|| color_eyre::eyre::eyre!("Could not parse editor command"))?;
+  let status = Command::new(program).args(parts).arg(path).status()?;
+  if !status.success() {
+    color_eyre::eyre::bail!("Editor exited with status code {:?}", status.code());
+  }
+  Ok(())
+}
+
+fn edit_config_file() -> Result<()> {
+  let config_path = existing_config_path().unwrap_or_else(preferred_config_path);
+  ensure_config_file(&config_path)?;
+  open_editor(&config_path)
+}
+
 async fn tokio_main() -> Result<()> {
+  let mut args = Cli::parse();
+  dotenv().ok();
+  if args.command == Some(CliCommand::Edit) {
+    return edit_config_file();
+  }
+
   initialize_logging()?;
 
   initialize_panic_handler()?;
 
-  let mut args = Cli::parse();
-  dotenv().ok();
   let config = Config::new()?;
   let driver = resolve_driver(&mut args, &config)?;