complate 0.14 - now with lib (preliminary)

Author: Alexander Weber

Cargo.lock

@@ -12,6 +12,10 @@ categories = ["command-line-utilities"]
 readme = "docs/README.md"
 autobins = false
 
+[lib]
+name = "complate"
+path = "./src/lib.rs"
+
 [[bin]]
 name = "complate"
 path = "./src/main.rs"
@@ -33,12 +37,11 @@ mime = "0.3.17"
 serde = { version = "1.0.181", features = ["derive"] }
 serde_json = "1.0.104"
 serde_yaml = "0.9.25"
-thiserror = "1.0.44"
-anyhow = "1.0.72"
 dialoguer = { version = "0.10.4", optional = true }
 schemars = "0.8.12"
 fancy-regex = "0.11.0"
 indoc = "2.0.3"
+anyhow = "1.0.86"
 
 [dev-dependencies]
 rusty-hook = "0.11.2"

Cargo.toml

@@ -1,5 +1,4 @@
 use {
-    crate::error::Error,
     anyhow::Result,
     clap::{
         Arg,
@@ -48,30 +47,7 @@ pub enum Command {
     Autocomplete { path: String, shell: clap_complete::Shell },
     Init,
     Schema,
-    Render(RenderArguments),
-}
-
-#[derive(Debug)]
-pub struct RenderArguments {
-    pub configuration: String,
-    pub template: Option<String>,
-    pub value_overrides: HashMap<String, String>,
-    pub shell_trust: ShellTrust,
-    pub loose: bool,
-    pub backend: Backend,
-}
-
-#[derive(Debug, Eq, PartialEq)]
-pub enum ShellTrust {
-    None,
-    Ultimate,
-}
-
-#[derive(Debug)]
-pub enum Backend {
-    Headless,
-    #[cfg(feature = "backend+cli")]
-    CLI,
+    Render(crate::render::RenderArguments),
 }
 
 pub struct ClapArgumentLoader {}
@@ -193,7 +169,7 @@ impl ClapArgumentLoader {
                     format: match subc.get_one::<String>("format").unwrap().as_str() {
                         | "manpages" => ManualFormat::Manpages,
                         | "markdown" => ManualFormat::Markdown,
-                        | _ => return Err(Error::Argument("unknown format".into()).into()),
+                        | _ => return Err(anyhow::anyhow!("unknown format")),
                     },
                 },
                 privileges,
@@ -220,9 +196,9 @@ impl ClapArgumentLoader {
             let config = std::fs::read_to_string(subc.get_one::<String>("config").unwrap())?;
             let template = subc.get_one::<String>("template").map(|v| v.into());
             let shell_trust = if subc.get_flag("trust") {
-                ShellTrust::Ultimate
+                crate::render::ShellTrust::Ultimate
             } else {
-                ShellTrust::None
+                crate::render::ShellTrust::None
             };
             let loose = subc.get_flag("loose");
 
@@ -234,15 +210,15 @@ impl ClapArgumentLoader {
                 }
             }
             let backend = match subc.get_one::<String>("backend").unwrap().as_str() {
-                | "headless" => Backend::Headless,
+                | "headless" => crate::render::Backend::Headless,
                 #[cfg(feature = "backend+cli")]
-                | "cli" => Backend::CLI,
-                | _ => return Err(Error::Argument("no backend specified".into()).into()),
+                | "cli" => crate::render::Backend::CLI,
+                | _ => return Err(anyhow::anyhow!("no backend specified")),
             };
 
             Ok(CallArgs {
                 privileges,
-                command: Command::Render(RenderArguments {
+                command: Command::Render(crate::render::RenderArguments {
                     configuration: config,
                     template,
                     value_overrides,
@@ -252,7 +228,7 @@ impl ClapArgumentLoader {
                 }),
             })
         } else {
-            return Err(Error::UnknownCommand.into());
+            return Err(anyhow::anyhow!("unknown command"));
         }
     }
 }

src/args.rs

@@ -0,0 +1,2 @@
+pub mod render;
+pub mod config;

src/error.rs

@@ -4,11 +4,10 @@ use {
     std::path::PathBuf,
 };
 
-pub mod args;
-pub mod config;
-pub mod error;
-pub mod reference;
-pub mod render;
+mod args;
+mod config;
+mod reference;
+mod render;
 
 #[tokio::main]
 async fn main() -> Result<()> {
@@ -58,15 +57,14 @@ async fn main() -> Result<()> {
 #[cfg(test)]
 mod tests {
     use {
-        crate::error::Error,
         anyhow::Result,
         std::process::Command,
     };
 
     fn exec(command: &str) -> Result<String> {
         let output = Command::new("sh").arg("-c").arg(command).output()?;
         if output.status.code().unwrap() != 0 {
-            return Err(Error::ShellCommand(String::from_utf8(output.stderr)?).into());
+            return Err(anyhow::anyhow!(String::from_utf8(output.stderr)?));
         }
         Ok(String::from_utf8(output.stdout)?)
     }

src/lib.rs

@@ -1,6 +1,5 @@
 use {
     super::UserInput,
-    crate::error::Error,
     anyhow::Result,
     async_trait::async_trait,
     std::collections::{
@@ -24,11 +23,11 @@ impl<'a> UserInput for CLIBackend<'a> {
     async fn prompt(&self, text: &str) -> Result<String> {
         match dialoguer::Input::new().allow_empty(true).with_prompt(text).interact() {
             | Ok(res) => Ok(res),
-            | Err(_) => Err(Error::InteractAbort.into()),
+            | Err(_) => Err(anyhow::anyhow!("interaction aborted")),
         }
     }
 
-    async fn select(&self, prompt: &str, options: &BTreeMap<String, super::Option>) -> Result<String> {
+    async fn select(&self, prompt: &str, options: &BTreeMap<String, crate::config::Option>) -> Result<String> {
         let keys = options.keys().cloned().collect::<Vec<String>>();
         let display_vals = options.values().map(|x| x.display.to_owned()).collect::<Vec<String>>();
 
@@ -43,7 +42,7 @@ impl<'a> UserInput for CLIBackend<'a> {
         }
     }
 
-    async fn check(&self, prompt: &str, separator: &str, options: &BTreeMap<String, super::Option>) -> Result<String> {
+    async fn check(&self, prompt: &str, separator: &str, options: &BTreeMap<String, crate::config::Option>) -> Result<String> {
         let keys = options.keys().cloned().collect::<Vec<String>>();
         let display_vals = options.values().map(|x| x.display.to_owned()).collect::<Vec<String>>();
 

src/main.rs

@@ -1,6 +1,4 @@
 use {
-    super::UserInput,
-    crate::error::Error,
     anyhow::Result,
     async_trait::async_trait,
 };
@@ -14,25 +12,25 @@ impl HeadlessBackend {
 }
 
 #[async_trait]
-impl UserInput for HeadlessBackend {
+impl super::UserInput for HeadlessBackend {
     async fn prompt(&self, _text: &str) -> Result<String> {
-        Err(Error::Invalid("can not prompt in headless backend".into()).into())
+        Err(anyhow::anyhow!("can not prompt in headless backend").into())
     }
 
     async fn select(
         &self,
         _prompt: &str,
-        _options: &std::collections::BTreeMap<String, super::Option>,
+        _options: &std::collections::BTreeMap<String, crate::config::Option>,
     ) -> Result<String> {
-        Err(Error::Invalid("can not prompt in headless backend".into()).into())
+        Err(anyhow::anyhow!("can not prompt in headless backend").into())
     }
 
     async fn check(
         &self,
         _prompt: &str,
         _separator: &str,
-        _options: &std::collections::BTreeMap<String, super::Option>,
+        _options: &std::collections::BTreeMap<String, crate::config::Option>,
     ) -> Result<String> {
-        Err(Error::Invalid("can not prompt in headless backend".into()).into())
+        Err(anyhow::anyhow!("can not prompt in headless backend").into())
     }
 }