Feat: implement --verbose flag on ion template inspect cmd

README.md

@@ -15,7 +15,7 @@ Download tarball in the release page and extract it to your `$HOME/.julia` direc
 
 ### build from source
 
-Using [`just`](https://github.com/casey/just):
+Using [`just`](https://github.com/casey/just) and [Rust's cargo/rustc compiler](https://rustup.rs/):
 
 ```bash
 just install

ion_derive/src/template.rs

@@ -17,61 +17,219 @@ pub fn emit_template(ast: &DeriveInput) -> TokenStream {
     let context_expr = emit_context();
 
     let gen = quote! {
-        use log::debug;
-        use anyhow::Result;
-        use crate::config::Config;
-
-        #context_expr
-
-        impl #name {
-            pub fn from_name(config: &Config, name: &String) -> Result<Self> {
-                let mut template = config.template_dir();
-                template.push(name);
-                template.push("template.toml");
-
-                assert!(template.is_file(), "Template file not found: {}", template.display());
-                let source = std::fs::read_to_string(template)?;
-                let template : Template = toml::from_str(&source)?;
-                Ok(template)
-            }
+            use log::debug;
+            use anyhow::Result;
+            use crate::config::Config;
+
+            #context_expr
+
+            impl #name {
+                pub fn from_name(config: &Config, name: &String) -> Result<Self> {
+                    let mut template = config.template_dir();
+                    template.push(name);
+                    template.push("template.toml");
+
+                    assert!(template.is_file(), "Template file not found: {}", template.display());
+                    let source = std::fs::read_to_string(template)?;
+                    let template : Template = toml::from_str(&source)?;
+                    Ok(template)
+                }
+
+                pub fn render(&self, config: &Config, ctx: &mut Context) -> Result<()> {
+                    let old_pwd = std::env::current_dir()?;
+                    std::env::set_current_dir(&*ctx.project.path)?;
+
+                    self.collect(config, ctx)?;
+                    debug!("Context: {:#?}", ctx);
+                    if ctx.prompt {
+                        self.prompt(config, ctx)?;
+                    }
+                    #render
+                    self.post_render(config, ctx)?;
+                    self.validate(config, ctx)?;
+
+                    std::env::set_current_dir(old_pwd)?;
+                    Ok(())
+                }
+
+                pub fn collect(&self, config: &Config, ctx: &mut Context) -> Result<()> {
+                    #collect
+                    Ok(())
+                }
 
-            pub fn render(&self, config: &Config, ctx: &mut Context) -> Result<()> {
-                let old_pwd = std::env::current_dir()?;
-                std::env::set_current_dir(&*ctx.project.path)?;
+                pub fn prompt(&self, config: &Config, ctx: &mut Context) -> Result<()> {
+                    #prompt
+                    Ok(())
+                }
+
+                pub fn post_render(&self, config: &Config, ctx: &Context) -> Result<()> {
+                    #post_render
+                    Ok(())
+                }
 
-                self.collect(config, ctx)?;
-                debug!("Context: {:#?}", ctx);
-                if ctx.prompt {
-                    self.prompt(config, ctx)?;
+                pub fn validate(&self, config: &Config, ctx: &Context) -> Result<()> {
+                    #validate
+                    Ok(())
                 }
-                #render
-                self.post_render(config, ctx)?;
-                self.validate(config, ctx)?;
 
-                std::env::set_current_dir(old_pwd)?;
-                Ok(())
             }
 
-            pub fn collect(&self, config: &Config, ctx: &mut Context) -> Result<()> {
-                #collect
-                Ok(())
+
+    impl fmt::Display for Template {
+        fn fmt(&self, format_buffer: &mut fmt::Formatter) -> fmt::Result {
+            write!(
+                format_buffer,
+                "Name:\n{}\n\nDescription:\n{}\n\n",
+                self.name, self.description
+            )?;
+
+            if let Some(repo) = &self.repo {
+                write!(format_buffer, "Repo:\n{}\n", repo)?;
+            } else {
+                write!(format_buffer, "Repo:\nNone\n\n")?;
+            }
+
+            if let Some(project_file) = &self.project_file {
+                write!(format_buffer, "Project File:\n{}\n", project_file)?;
+            } else {
+                write!(format_buffer, "Project File:\nNone\n\n")?;
+            }
+
+            if let Some(readme) = &self.readme {
+                write!(format_buffer, "Readme:\n{}\n", readme)?;
+            } else {
+                write!(format_buffer, "Readme:\nNone\n\n")?;
+            }
+
+            if let Some(src_dir) = &self.src_dir {
+                write!(format_buffer, "Source Directory:\n{}\n", src_dir)?;
+            } else {
+                write!(format_buffer, "Source Directory:\nNone\n\n")?;
             }
 
-            pub fn prompt(&self, config: &Config, ctx: &mut Context) -> Result<()> {
-                #prompt
-                Ok(())
+            if let Some(tests) = &self.tests {
+                write!(format_buffer, "Tests:\n{}\n", tests)?;
+            } else {
+                write!(format_buffer, "Tests:\nNone\n\n")?;
             }
 
-            pub fn post_render(&self, config: &Config, ctx: &Context) -> Result<()> {
-                #post_render
-                Ok(())
+            if let Some(license_dir) = &self.license {
+                write!(format_buffer, "License Template:\n{}\n", license_dir)?;
+            } else {
+                write!(format_buffer, "License Template:\nNone\n\n")?;
             }
 
-            pub fn validate(&self, config: &Config, ctx: &Context) -> Result<()> {
-                #validate
-                Ok(())
+            if let Some(citation) = &self.citation {
+                write!(format_buffer, "Citation:\n{}\n", citation)?;
+            } else {
+                write!(format_buffer, "Citation:\nNone\n\n")?;
             }
+
+            if let Some(documenter) = &self.documenter {
+                write!(format_buffer, "Documenter:\n{}\n", documenter)?;
+            } else {
+                write!(format_buffer, "Documenter:\nNone\n\n")?;
+            }
+
+            if let Some(codecov) = &self.codecov {
+                write!(format_buffer, "CodeCov:\n{}\n", codecov)?;
+            } else {
+                write!(format_buffer, "CodeCov:\nNone\n\n")?;
+            }
+
+            if let Some(coveralls) = &self.coveralls {
+                write!(format_buffer, "Coveralls:\n{}\n", coveralls)?;
+            } else {
+                write!(format_buffer, "Coveralls:\nNone\n\n")?;
+            }
+            if let Some(github) = &self.github {
+                write!(format_buffer, "Github:\n{}\n", github)?;
+            } else {
+                write!(format_buffer, "Github:\nNone\n")?;
+            }
+
+            Ok(())
         }
-    };
+    }
+
+
+        };
     gen.into()
 }
+
+// impl fmt::Display for Template {
+//     fn fmt(&self, format_buffer: &mut fmt::Formatter) -> fmt::Result {
+//         write!(
+//             format_buffer,
+//             "Name:\n{}\n\nDescription:\n{}\n\n",
+//             self.name, self.description
+//         )?;
+
+//         if let Some(repo) = &self.repo {
+//             write!(format_buffer, "Repo:\n{repo}\n")?;
+//         } else {
+//             write!(format_buffer, "Repo:\nNone\n\n")?;
+//         }
+
+//         if let Some(project_file) = &self.project_file {
+//             write!(format_buffer, "Project File:\n{project_file}\n")?;
+//         } else {
+//             write!(format_buffer, "Project File:\nNone\n\n")?;
+//         }
+
+//         if let Some(readme) = &self.readme {
+//             write!(format_buffer, "Readme:\n{readme}\n")?;
+//         } else {
+//             write!(format_buffer, "Readme:\nNone\n\n")?;
+//         }
+
+//         if let Some(src_dir) = &self.src_dir {
+//             write!(format_buffer, "Source Directory:\n{src_dir}\n")?;
+//         } else {
+//             write!(format_buffer, "Source Directory:\nNone\n\n")?;
+//         }
+
+//         if let Some(tests) = &self.tests {
+//             write!(format_buffer, "Tests:\n{tests}\n")?;
+//         } else {
+//             write!(format_buffer, "Tests:\nNone\n\n")?;
+//         }
+
+//         if let Some(license_dir) = &self.license {
+//             write!(format_buffer, "License Template:\n{license_dir}\n")?;
+//         } else {
+//             write!(format_buffer, "License Template:\nNone\n\n")?;
+//         }
+
+//         if let Some(citation) = &self.citation {
+//             write!(format_buffer, "Citation:\n{citation}\n")?;
+//         } else {
+//             write!(format_buffer, "Citation:\nNone\n\n")?;
+//         }
+
+//         if let Some(documenter) = &self.documenter {
+//             write!(format_buffer, "Documenter:\n{documenter}\n")?;
+//         } else {
+//             write!(format_buffer, "Documenter:\nNone\n\n")?;
+//         }
+
+//         if let Some(codecov) = &self.codecov {
+//             write!(format_buffer, "CodeCov:\n{codecov}\n")?;
+//         } else {
+//             write!(format_buffer, "CodeCov:\nNone\n\n")?;
+//         }
+
+//         if let Some(coveralls) = &self.coveralls {
+//             write!(format_buffer, "Coveralls:\n{coveralls}\n")?;
+//         } else {
+//             write!(format_buffer, "Coveralls:\nNone\n\n")?;
+//         }
+//         if let Some(github) = &self.github {
+//             write!(format_buffer, "Github:\n{github}\n")?;
+//         } else {
+//             write!(format_buffer, "Github:\nNone\n")?;
+//         }
+
+//         Ok(())
+//     }
+// }

src/bin/ion/commands/template.rs

@@ -16,7 +16,8 @@ pub fn cli() -> Command {
             Command::new("inspect")
                 .about("inspect the contents of a template")
                 .arg(arg!([TEMPLATE] "Selects which template to print out"))
-                .arg(arg!(--"all" "Inspect all installed templates")),
+                .arg(arg!(--"all" "Inspect all installed templates"))
+                .arg(arg!(verbose: -v --verbose "Inspect details of the template output")),
         )
         .arg_required_else_help(true)
 }
@@ -43,17 +44,21 @@ pub fn exec(config: &mut Config, matches: &ArgMatches) -> CliResult {
             RemoteTemplate::new(config).download()?;
         }
         Some(("inspect", matches)) => {
+            let all_flag = matches.get_flag("all");
+            let verbose_flag = matches.get_flag("verbose");
+
             download_templates(config)?;
-            // Iff a template name is provided, inspect template; otherwise, check for --all flag; if no --all, ask user to select template from list
 
+            // Iff a template name is provided, inspect template; otherwise, check for --all flag; if no --all, ask user to select template from list
             match matches.get_one::<String>("TEMPLATE") {
-                Some(template) => inspect_template(config, template.to_owned())?,
+                Some(template) => {
+                    inspect_template(config, template.to_owned(), verbose_flag)?;
+                }
                 None => {
-                    let all_flag = matches.get_flag("all");
                     if all_flag {
-                        inspect_all_templates(config)?;
+                        inspect_all_templates(config, verbose_flag)?;
                     } else {
-                        ask_inspect_template(config)?;
+                        ask_inspect_template(config, verbose_flag)?;
                     }
                 }
             };

src/ion/blueprints/components/citation.rs

@@ -3,6 +3,7 @@ use crate::{blueprints::*, config::Config};
 use chrono::Datelike;
 use dialoguer::{Confirm, Input};
 use serde_derive::{Deserialize, Serialize};
+use std::fmt;
 
 #[derive(Debug, Serialize, Clone)]
 pub struct Info {
@@ -116,3 +117,14 @@ impl Blueprint for Citation {
             .render(ctx, "CITATION.cff")
     }
 }
+
+impl fmt::Display for Citation {
+    fn fmt(&self, format_buffer: &mut fmt::Formatter) -> fmt::Result {
+        write!(
+            format_buffer,
+            "Template: {}\nReadme: {}\n",
+            self.template, self.readme
+        )?;
+        Ok(())
+    }
+}

src/ion/blueprints/components/codecov.rs

@@ -1,5 +1,6 @@
 use crate::blueprints::*;
 use serde_derive::{Deserialize, Serialize};
+use std::fmt;
 
 #[derive(Debug, Serialize, Clone)]
 pub struct Info;
@@ -18,3 +19,14 @@ impl Blueprint for Codecov {
         Ok(())
     }
 }
+
+impl fmt::Display for Codecov {
+    fn fmt(&self, format_buffer: &mut fmt::Formatter) -> fmt::Result {
+        if let Some(template) = &self.template {
+            writeln!(format_buffer, "CodeCov template: {template}")?;
+        } else {
+            writeln!(format_buffer, "CodeCov template: None")?;
+        }
+        Ok(())
+    }
+}

src/ion/blueprints/components/coveralls.rs

@@ -1,5 +1,6 @@
 use crate::blueprints::*;
 use serde_derive::{Deserialize, Serialize};
+use std::fmt;
 
 #[derive(Debug, Serialize, Clone)]
 pub struct Info;
@@ -20,3 +21,14 @@ impl Blueprint for Coveralls {
         Ok(())
     }
 }
+
+impl fmt::Display for Coveralls {
+    fn fmt(&self, format_buffer: &mut fmt::Formatter) -> fmt::Result {
+        if let Some(template) = &self.template {
+            writeln!(format_buffer, "Coveralls template: {template}")?;
+        } else {
+            writeln!(format_buffer, "Coveralls template: None")?;
+        }
+        Ok(())
+    }
+}

src/ion/blueprints/components/documenter.rs

@@ -1,8 +1,8 @@
 use crate::blueprints::*;
 use crate::utils::*;
 use crate::PackageSpec;
-use anyhow::Ok;
 use serde_derive::{Deserialize, Serialize};
+use std::fmt;
 
 #[derive(Debug, Serialize, Clone)]
 pub struct Info;
@@ -77,3 +77,14 @@ impl Badgeable for Documenter {
         }
     }
 }
+
+impl fmt::Display for Documenter {
+    fn fmt(&self, format_buffer: &mut fmt::Formatter) -> fmt::Result {
+        write!(
+            format_buffer,
+            "Make.jl template: {}\nIndex.md template: {}\nDoc project template: {}\nIgnore files: {:#?}\n",
+            self.make_jl, self.index_md, self.doc_project, self.ignore
+        )?;
+        Ok(())
+    }
+}