4.0.0 (lots of QOL changes)

ryanabx · ryanabx · commit e3a48ca89c63 · 2024-09-09T13:30:41.000-05:00
- -f flag now requires the path to come after it, and removes the directory requirement
- remove unused --no-warn argument
- --clean argument now requires a directory specification instead of a file
- cleaned up code
- updated documentation (command reference)

Signed-off-by: Ryan Brue &lt;ryanbrue.dev@gmail.com&gt;
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,7 +4,7 @@ authors = ["Ryan Brue <ryanbrue.dev@gmail.com>"]
 repository = "https://github.com/ryanabx/simple-ssg"
 license = "MIT"
 readme = "README.md"
-version = "3.2.0"
+version = "4.0.0"
 edition = "2021"
 description = "Plain and simple static site generator for Djot and Markdown light markup languages"
 
diff --git a/docs/command_reference.dj b/docs/command_reference.dj
@@ -19,17 +19,17 @@ cargo build --release
 ## Usage
 
 ```shell
-simple-ssg [OPTIONS] <TARGET_PATH>
-```
+Plain and simple static site generator for Djot and Markdown light markup languages
 
-### Options
+Usage: simple-ssg [OPTIONS] [DIRECTORY]
+
+Arguments:
+  [DIRECTORY]  Path to the directory to use to generate the site (not required if -f is specified)
 
-```
 Options:
-  -f                             Process a single file instead of a directory
+  -f <FILE>                      Process a single file instead of a directory
   -o <OUTPUT_PATH>               Optional output path override. Defaults to ./output for directories
       --clean                    Clean the output directory before generating the site. Useful for multiple runs
-      --no-warn                  Disallow any warnings
       --web-prefix <WEB_PREFIX>  Specify the website prefix (defaults to local paths i.e. `./`)
   -t, --template <TEMPLATE>      Specify a built in template to use (will override a template.html in any directory!). defaults to whatever templates are found in template.html in the directories [possible values: github-markdown, force-none]
   -h, --help                     Print help
diff --git a/src/main.rs b/src/main.rs
@@ -7,7 +7,6 @@ use std::{
     path::{Path, PathBuf},
 };
 use templates::BuiltInTemplate;
-use utils::warn_or_error;
 use walkdir::WalkDir;
 
 use clap::Parser;
@@ -22,20 +21,17 @@ mod utils;
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]
 struct ConsoleArgs {
-    /// Path to the directory to use to generate the site
-    target_path: PathBuf,
+    /// Path to the directory to use to generate the site (not required if -f is specified)
+    directory: Option<PathBuf>,
     /// Process a single file instead of a directory
     #[arg(short, conflicts_with = "clean")]
-    file: bool,
+    file: Option<PathBuf>,
     /// Optional output path override. Defaults to ./output for directories
     #[arg(short)]
     output_path: Option<PathBuf>,
     /// Clean the output directory before generating the site. Useful for multiple runs
     #[arg(long, conflicts_with = "file")]
     clean: bool,
-    /// Disallow any warnings
-    #[arg(long)]
-    no_warn: bool,
     /// Specify the website prefix (defaults to local paths i.e. `./`)
     #[arg(long)]
     web_prefix: Option<String>,
@@ -54,19 +50,32 @@ fn main() -> anyhow::Result<()> {
 }
 
 fn run_program(args: ConsoleArgs) -> anyhow::Result<()> {
-    let output_path = args.output_path.unwrap_or(if args.file {
-        env::current_dir()?
+    let (target_path, output_path) = if args.directory.is_some() && args.file.is_some() {
+        return Err(anyhow!(
+            "Cannot specify both a directory and a path! (Specified {} and -f {})",
+            args.directory.unwrap().display(),
+            args.file.unwrap().display()
+        ));
+    } else if let Some(dir) = args.directory {
+        if dir.is_file() {
+            return Err(anyhow!(
+                "Path {} is a file. Specify -f <FILE> if this was intended.",
+                dir.display()
+            ));
+        }
+        (dir, env::current_dir()?.join("output"))
+    } else if let Some(path) = args.file {
+        if path.is_dir() {
+            return Err(anyhow!("Path {} is a directory. Specify <DIRECTORY> without the -f positional argument if this was intended.", path.display()));
+        }
+        (path, env::current_dir()?)
     } else {
-        env::current_dir()?.join("output")
-    });
-    if args.target_path.is_file() && !args.file {
         return Err(anyhow!(
-            "Target path {} is a file! If you meant to specify a file, please specify the -f flag.",
-            args.target_path.display()
+            "Must specify either a directory <DIRECTORY> or a path with -f <PATH>"
         ));
-    }
+    };
     // Clean the output directory if clean is specified
-    if args.clean && args.target_path.is_dir() {
+    if args.clean {
         log::debug!(
             "Clean argument specified, cleaning output path {:?}...",
             &output_path
@@ -78,9 +87,8 @@ fn run_program(args: ConsoleArgs) -> anyhow::Result<()> {
         }
     }
     generate_site(
-        &args.target_path,
+        &target_path,
         &output_path,
-        args.no_warn,
         args.web_prefix.as_deref(),
         args.template,
     )?;
@@ -103,7 +111,6 @@ pub enum FirstPassResult {
 fn generate_site(
     target_path: &Path,
     output_path: &Path,
-    no_warn: bool,
     web_prefix: Option<&str>,
     template: Option<BuiltInTemplate>,
 ) -> anyhow::Result<()> {
@@ -118,7 +125,7 @@ fn generate_site(
     log::info!("1/3: Site generation and indexing...");
     if target_path.is_dir() && output_path.is_dir() {
         if !utils::check_has_index(target_path) {
-            warn_or_error(SsgError::IndexPageNotFound, no_warn)?;
+            log::warn!("{}", SsgError::IndexPageNotFound);
         }
         for entry in WalkDir::new(target_path) {
             match entry {
@@ -128,12 +135,11 @@ fn generate_site(
                     output_path,
                     &template,
                     web_prefix,
-                    no_warn,
                     direntry.depth(),
                     &mut first_pass_results,
                 )?,
                 Err(e) => {
-                    warn_or_error(SsgError::DirEntryError(e), no_warn)?;
+                    log::warn!("{}", SsgError::DirEntryError(e));
                 }
             }
         }
@@ -144,7 +150,6 @@ fn generate_site(
             output_path,
             &template,
             web_prefix,
-            no_warn,
             1,
             &mut first_pass_results,
         )?;
@@ -192,14 +197,13 @@ fn process_path(
     output_path: &Path,
     template: &Option<BuiltInTemplate>,
     web_prefix: Option<&str>,
-    no_warn: bool,
     depth: usize,
     first_pass_results: &mut Vec<FirstPassResult>,
 ) -> anyhow::Result<()> {
     let relative = match entity.strip_prefix(target_path) {
         Ok(relative) => relative.to_path_buf(),
         Err(_) => {
-            warn_or_error(SsgError::PathNotRelative(entity.to_path_buf()), no_warn)?;
+            log::warn!("{}", SsgError::PathNotRelative(entity.to_path_buf()));
             return Ok(());
         }
     };
@@ -232,11 +236,9 @@ fn process_path(
             );
             let input_str = std::fs::read_to_string(entity)?;
             let html = match entity.extension().map(|x| x.to_str().unwrap()) {
-                Some("md") => {
-                    process_markdown(&input_str, entity.parent().unwrap(), no_warn, web_prefix)?
-                }
+                Some("md") => process_markdown(&input_str, entity.parent().unwrap(), web_prefix)?,
                 Some("dj") | Some("djot") => {
-                    process_djot(&input_str, entity.parent().unwrap(), no_warn, web_prefix)?
+                    process_djot(&input_str, entity.parent().unwrap(), web_prefix)?
                 }
                 _ => unreachable!(),
             };
@@ -257,7 +259,6 @@ fn process_path(
 fn process_markdown(
     markdown_input: &str,
     file_parent_dir: &Path,
-    no_warn: bool,
     web_prefix: Option<&str>,
 ) -> anyhow::Result<String> {
     let events = pulldown_cmark::Parser::new(markdown_input)
@@ -277,7 +278,7 @@ fn process_markdown(
                     {
                         let new_path = Path::new(&inner).with_extension("html");
                         if !referenced_path.exists() {
-                            warn_or_error(SsgError::LinkError(referenced_path), no_warn)?;
+                            log::warn!("{}", SsgError::LinkError(referenced_path))
                         }
                         let dest_url = CowStr::Boxed(
                             format!("{}{}", web_prefix.unwrap_or(""), new_path.to_string_lossy())
@@ -311,7 +312,6 @@ fn process_markdown(
 fn process_djot(
     djot_input: &str,
     file_parent_dir: &Path,
-    no_warn: bool,
     web_prefix: Option<&str>,
 ) -> anyhow::Result<String> {
     let events = jotdown::Parser::new(djot_input)
@@ -338,7 +338,7 @@ fn process_djot(
                                 attributes,
                             ))
                         } else {
-                            warn_or_error(SsgError::LinkError(referenced_path), no_warn)?;
+                            log::warn!("{}", SsgError::LinkError(referenced_path));
                             Ok(Event::Start(Container::Link(text, link_type), attributes))
                         }
                     } else {
diff --git a/src/tests.rs b/src/tests.rs
@@ -43,13 +43,12 @@ fn site_with_links() -> anyhow::Result<()> {
                 djot_file_3.flush()?;
                 log::trace!("Djot files written");
                 let args = ConsoleArgs {
-                    target_path: temp_dir.join("target"),
+                    directory: Some(temp_dir.join("target")),
+                    file: None,
                     output_path: Some(temp_dir.join("output")),
                     clean: false,
-                    no_warn: true,
                     web_prefix: None,
                     template: Some(crate::templates::BuiltInTemplate::ForceNone),
-                    file: false,
                 };
                 log::trace!("Running program");
                 crate::run_program(args)?;
@@ -98,13 +97,12 @@ fn site_warn_without_index() -> anyhow::Result<()> {
                 djot_file_2.flush()?;
 
                 let args = ConsoleArgs {
-                    target_path: temp_dir.join("target"),
+                    directory: Some(temp_dir.join("target")),
                     output_path: Some(temp_dir.join("output")),
                     clean: false,
-                    no_warn: true,
                     web_prefix: None,
                     template: Some(crate::templates::BuiltInTemplate::ForceNone),
-                    file: false,
+                    file: None,
                 };
                 crate::run_program(args)?;
                 Ok(())
diff --git a/src/utils.rs b/src/utils.rs
@@ -9,15 +9,6 @@ pub fn check_has_index(target_path: &Path) -> bool {
         || target_path.join("index.md").exists()
 }
 
-pub fn warn_or_error(error: crate::errors::SsgError, no_warn: bool) -> anyhow::Result<()> {
-    if no_warn {
-        Err(error.into())
-    } else {
-        log::warn!("{}", error);
-        Ok(())
-    }
-}
-
 pub fn get_template_if_exists(
     djot_document_path: &Path,
     root_path: &Path,
