feat(watcher()): Add the -w argument to a Bashdoc call to watch for changes on INPUT

dustinknopoff · dustinknopoff · commit 49d7b0c48b57 · 2018-12-14T08:29:44.000-05:00
Bashdoc output will be updated on change
diff --git a/Cargo.toml b/Cargo.toml
@@ -14,4 +14,5 @@ serde = "1.0.80"
 serde_json = "1.0.33"
 toml = "0.4.8"
 nom = "4.1.1"
-handlebars = "1.1.0"
+handlebars = "1.1.0"
+notify = "4.0.6"
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ Creates a "javadoc" like structure for bash. See github repo github.com/dustinkn
 formatting.
 
 USAGE:
-    bashdoc [FLAGS] [OPTIONS] <INPUT>
+    bashdoc [FLAGS] [OPTIONS] <INPUT> [SUBCOMMAND]
 
 FLAGS:
     -c, --color        toggles color
@@ -69,10 +69,13 @@ FLAGS:
     -V, --version      Prints version information
 
 OPTIONS:
-    -h, --html <html>            output html documentation
-    -j, --json <FILE>            print result as JSON
-    -o, --override <override>    override delimiters for this call.
+    -h, --html <html>    output html documentation
+    -j, --json <FILE>    print result as JSON
 
 ARGS:
     <INPUT>    Sets the input file to use
+
+SUBCOMMANDS:
+    help        Prints this message or the help of the given subcommand(s)
+    override    override the delimiters
 ```
diff --git a/cli.yml b/cli.yml
@@ -1,4 +1,7 @@
 about: 'Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.'
+author: "Dustin Knopoff <dustinknopoff@gmail.com>"
+name: bashdoc
+version: "1.0"
 args:
   - color:
       help: "toggles color"
@@ -18,16 +21,46 @@ args:
       short: j
       takes_value: true
       value_name: FILE
-  - override:
-      help: override delimiters for this call.
-      short: o
-      long: override
-      takes_value: true
   - html:
       help: output html documentation
       short: h
       long: html
       takes_value: true
-author: "Dustin Knopoff <dustinknopoff@gmail.com>"
-name: bashdoc
-version: "1.0"
+  - watch:
+      help: continuously update on change
+      short: w
+      long: watch
+subcommands:
+  - override:
+      about: override the delimiters
+      args:
+        - start:
+            short: s
+            long: start
+            help: delimiter for start
+            takes_value: true
+        - end:
+            short: e
+            long: end
+            help: delimiter for start
+            takes_value: true
+        - descriptor:
+            short: d
+            long: desc
+            help: delimiter for descriptors
+            takes_value: true
+        - params:
+            short: p
+            long: param
+            help: delimiter for parameters
+            takes_value: true
+        - returns:
+            short: r
+            long: ret
+            help: delimiter for return values
+            takes_value: true
+        - comment:
+            short: c
+            long: comment
+            help: delimiter for comments
+            takes_value: true
diff --git a/src/docs.rs b/src/docs.rs
@@ -1,3 +1,4 @@
+use clap::ArgMatches;
 use colored::*;
 use dirs::home_dir;
 use glob::glob;
@@ -115,9 +116,9 @@ fn parse_doc<'a>(input: &'a str, delims: Delimiters) -> IResult<&'a str, Doc> {
             >> (Doc {
                 short_description: short.to_string(),
                 long_description: long.unwrap_or("").to_string(),
-                descriptors: desc.unwrap_or(Vec::new()),
-                params: par.unwrap_or(Vec::new()),
-                returns: ret.unwrap_or(Vec::new()),
+                descriptors: desc.unwrap_or_default(),
+                params: par.unwrap_or_default(),
+                returns: ret.unwrap_or_default(),
             })
     )
 }
@@ -364,20 +365,26 @@ impl<'a> Default for Delimiters<'a> {
 
 impl<'a> Delimiters<'a> {
     /// Override default delimiters with passed in values
-    pub fn override_delims(overrides: String) -> Self {
+    pub fn override_delims(overrides: &'a ArgMatches<'a>) -> Self {
         let mut result: Delimiters = Delimiters::default();
-        let splitted: Vec<_> = Box::leak(overrides.into_boxed_str())
-            .split_whitespace()
-            .collect();
-        if splitted.len() != 6 {
-            panic!("Please enter the proper number of delimiters");
+        if overrides.is_present("start") {
+            result.start = overrides.value_of("start").unwrap();
+        }
+        if overrides.is_present("end") {
+            result.end = overrides.value_of("end").unwrap();
+        }
+        if overrides.is_present("descriptor") {
+            result.opt = overrides.value_of("descriptor").unwrap();
+        }
+        if overrides.is_present("params") {
+            result.params = overrides.value_of("params").unwrap();
+        }
+        if overrides.is_present("returns") {
+            result.ret = overrides.value_of("returns").unwrap();
+        }
+        if overrides.is_present("comment") {
+            result.comm = overrides.value_of("comment").unwrap();
         }
-        result.start = &splitted[0];
-        result.end = &splitted[1];
-        result.params = &splitted[2];
-        result.ret = &splitted[3];
-        result.opt = &splitted[4];
-        result.comm = &splitted[5];
         result
     }
 
diff --git a/src/main.rs b/src/main.rs
@@ -45,15 +45,26 @@
 //!
 mod docs;
 use crate::docs::*;
-use clap::{load_yaml, App};
+use clap::{load_yaml, App, ArgMatches};
+use dirs::home_dir;
+use notify::{RecommendedWatcher, RecursiveMode, Watcher};
+use std::sync::mpsc::channel;
+use std::time::Duration;
 
 fn main() {
     let yaml = load_yaml!("../cli.yml");
     let matches = App::from_yaml(yaml).get_matches();
-    let delims = if matches.is_present("override") {
-        Delimiters::override_delims(matches.value_of("override").unwrap().to_string())
+    if matches.is_present("watch") {
+        watcher(&matches);
     } else {
-        Delimiters::get_delims()
+        generate(&matches);
+    }
+}
+
+fn generate<'a>(matches: &'a ArgMatches<'a>) {
+    let delims = match matches.subcommand() {
+        ("override", Some(sub_m)) => Delimiters::override_delims(sub_m),
+        _ => Delimiters::get_delims(),
     };
     let all_em = if matches.is_present("directory") {
         start(
@@ -82,3 +93,23 @@ fn main() {
         }
     }
 }
+
+fn watcher<'a>(matches: &'a ArgMatches<'a>) {
+    generate(matches);
+    let (tx, rx) = channel();
+    let mut watcher: RecommendedWatcher = Watcher::new(tx, Duration::from_secs(2)).unwrap();
+    let path = matches
+        .value_of("INPUT")
+        .unwrap()
+        .replace("~", home_dir().unwrap().to_str().unwrap());
+    watcher.watch(&path, RecursiveMode::Recursive).unwrap();
+    println!("Watching for changes in {}...", path);
+    loop {
+        match rx.recv() {
+            Ok(_) => {
+                generate(&matches);
+            }
+            Err(e) => println!("watch error: {:?}", e),
+        }
+    }
+}
