Update config API and add dependencies

Author: zurawiki

Cargo.lock

@@ -38,6 +38,7 @@ tera = { version = "1.17.1", default-features = false }
 tiktoken-rs = "0.1.2"
 tokio = { version = "1.25.0", features = ["full"] }
 toml = "0.7.2"
+toml_edit = "0.19.4"
 which = "4.4.0"
 
 [dev-dependencies]

Cargo.toml

@@ -51,6 +51,8 @@ Configs are applied in the following order:
 - The settings as read from the repo clone at `$GIT_ROOT/.git/gptcommit.toml`.
 - Environment variables starting with `GPTCOMMIT__*`.
 
+See all the config options available with `gptcommit config keys`.
+
 ### Set your OpenAI API key
 
 Persist your OpenAI key
@@ -139,7 +141,6 @@ All of these awesome projects are built using  `gptcommit`.
 
 If you encounter any bugs or have any suggestions for improvements, please open an issue on the repository.
 
-
 ## License
 
 This project is licensed under the [MIT License](./LICENSE).

README.md

@@ -3,6 +3,7 @@ set -eu
 
 gptcommit config list
 # assert is valid TOML
+gptcommit config keys
 
 gptcommit config get openai.model
 # assert default = text-davinci-003

e2e/test_config_list_get_set.sh

@@ -1,14 +1,18 @@
 use std::{collections::VecDeque, fs, path::PathBuf};
 
-use async_std::path::Path;
 use clap::{Args, Subcommand};
 use toml::Value;
 
-use crate::settings::{get_local_config_path, get_user_config_path, Settings};
+use crate::{
+    settings::{get_local_config_path, get_user_config_path, Settings},
+    toml::DeepKeysCollector,
+};
 use anyhow::{bail, Result};
 
 #[derive(Subcommand, Debug)]
 pub(crate) enum ConfigAction {
+    /// List all config keys
+    Keys,
     /// List all config values
     List {
         /// if set, will save the config to the user's config file
@@ -44,6 +48,7 @@ pub(crate) async fn main(settings: Settings, args: ConfigArgs) -> Result<()> {
     debug!("Config subcommand - Settings = {:?}", settings);
 
     match args.action {
+        ConfigAction::Keys => keys(settings).await,
         ConfigAction::List { save } => list(settings, save).await,
         ConfigAction::Get { key } => get(settings, key).await,
         ConfigAction::Set { key, value, local } => set(settings, key, value, local).await,
@@ -58,13 +63,20 @@ fn get_config_path(local: bool) -> Result<PathBuf> {
         } else {
             bail!("No repo-local config found. Please run `git init` to create a repo first");
         }
+    } else if let Some(config_path) = get_user_config_path() {
+        Ok(config_path)
     } else {
-                if let Some(config_path) = get_user_config_path() {
-            Ok(config_path)
-        } else {
-            bail!("No user config found.");
-        }
+        bail!("No user config found.");
+    }
+}
+
+async fn keys(settings: Settings) -> Result<()> {
+    let toml_string = toml::to_string_pretty(&settings).unwrap();
+    let keys = DeepKeysCollector::get_keys(toml_string);
+    for key in keys {
+        println!("{key}");
     }
+    Ok(())
 }
 
 async fn delete(_settings: Settings, full_key: String, local: bool) -> Result<()> {

src/actions/config.rs

@@ -8,6 +8,7 @@ mod cmd;
 mod git;
 mod prompt;
 mod summarize;
+mod toml;
 mod util;
 
 use anyhow::Result;

src/main.rs

@@ -0,0 +1,115 @@
+use toml_edit::{visit::*, Document, Item, Value};
+
+#[derive(Default)]
+pub(crate) struct DeepKeysCollector<'doc> {
+    current_path: Vec<&'doc str>,
+    pub keys: Vec<String>,
+}
+
+impl DeepKeysCollector<'_> {
+    pub fn get_keys(toml_string: String) -> Vec<String> {
+        let document: Document = toml_string.parse().unwrap();
+        let mut visitor = DeepKeysCollector::default();
+        visitor.visit_document(&document);
+
+        visitor.keys.sort();
+        visitor.keys
+    }
+}
+
+impl<'doc> Visit<'doc> for DeepKeysCollector<'doc> {
+    fn visit_table_like_kv(&mut self, key: &'doc str, node: &'doc Item) {
+        self.current_path.push(key);
+        self.visit_item(node);
+        self.current_path.pop();
+    }
+
+    fn visit_value(&mut self, node: &'doc Value) {
+        match node {
+            Value::InlineTable(_table) => {}
+            _ => {
+                self.keys.push(self.current_path.join("."));
+            }
+        };
+
+        match node {
+            Value::String(s) => self.visit_string(s),
+            Value::Integer(i) => self.visit_integer(i),
+            Value::Float(f) => self.visit_float(f),
+            Value::Boolean(b) => self.visit_boolean(b),
+            Value::Datetime(dt) => self.visit_datetime(dt),
+            Value::Array(array) => self.visit_array(array),
+            Value::InlineTable(table) => self.visit_inline_table(table),
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use toml_edit::Document;
+
+    use crate::settings::Settings;
+
+    use super::*;
+
+    #[test]
+    fn test_basic() {
+        let input = r#"
+laputa = "sky-castle"
+the-force = { value = "surrounds-you" }
+"#;
+
+        let document: Document = input.parse().unwrap();
+        let mut visitor = DeepKeysCollector::default();
+        visitor.visit_document(&document);
+
+        assert_eq!(visitor.current_path, Vec::<&str>::new());
+        assert_eq!(visitor.keys, vec!["laputa", "the-force.value"]);
+    }
+
+    #[test]
+    fn test_default_config() {
+        let input = toml::to_string_pretty(&Settings::new().unwrap()).unwrap();
+
+        let document: Document = input.parse().unwrap();
+        let mut visitor = DeepKeysCollector::default();
+        visitor.visit_document(&document);
+
+        assert_eq!(visitor.current_path, Vec::<&str>::new());
+        visitor.keys.sort();
+        assert_eq!(
+            visitor.keys,
+            vec![
+                "allow_amend",
+                "model_provider",
+                "openai.api_key",
+                "openai.model",
+                "output.lang",
+                "prompt.commit_summary",
+                "prompt.commit_title",
+                "prompt.file_diff",
+                "prompt.translation",
+            ]
+        );
+    }
+
+    #[test]
+    fn test_get_keys() {
+        let input = toml::to_string_pretty(&Settings::new().unwrap()).unwrap();
+
+        assert_eq!(
+            DeepKeysCollector::get_keys(input),
+            vec![
+                "allow_amend",
+                "model_provider",
+                "openai.api_key",
+                "openai.model",
+                "output.lang",
+                "prompt.commit_summary",
+                "prompt.commit_title",
+                "prompt.file_diff",
+                "prompt.translation",
+            ]
+        );
+    }
+}