feat(Extracted): Parsing of bashdocs from text now includes the line number of the function extract

Author: dustinknopoff

Cargo.toml

@@ -15,4 +15,5 @@ serde_json = "1.0.33"
 toml = "0.4.8"
 nom = "4.1.1"
 handlebars = "1.1.0"
-notify = "4.0.6"
+notify = "4.0.6"
+nom_locate = "0.3.1"

example/zshrc.json

@@ -7,84 +7,96 @@
           "long_description": "re-initialize .zshrc file",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 26
         },
         {
           "short_description": "zshconfig",
           "long_description": "open .zshrc in VSCode",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 32
         },
         {
           "short_description": "vimconfig",
           "long_description": "open .vimrc in vim",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 38
         },
         {
           "short_description": "docs",
           "long_description": "shortcut to ~/Documents folder",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 47
         },
         {
           "short_description": "svenv",
           "long_description": "activate virtual python environment",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 53
         },
         {
           "short_description": "update",
           "long_description": "update Operating System, Brew, NPM, Applications, and Pip",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 63
         },
         {
           "short_description": "cleanup",
           "long_description": "remove .DS_Store files from current directory",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 69
         },
         {
           "short_description": "emptytrash",
           "long_description": "clean the trash",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 75
         },
         {
           "short_description": "helpme",
           "long_description": "access cht.sh for help with commands and languages",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 82
         },
         {
           "short_description": "cloud",
           "long_description": "shortcut to iCloud documents",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 88
         },
         {
           "short_description": "notes",
           "long_description": "shortcut to exported Notes",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 94
         },
         {
           "short_description": "gits",
           "long_description": "Shortcut to ~/Documents/Gits",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 100
         },
         {
           "short_description": "glsnips()",
@@ -96,14 +108,16 @@
               "value": "Optional keyword to fuzzy search"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 125
         },
         {
           "short_description": "bip()",
           "long_description": "Fuzzy search brew",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 151
         },
         {
           "short_description": "allgits()",
@@ -115,7 +129,8 @@
               "value": "commit message"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 166
         },
         {
           "short_description": "xi()",
@@ -127,7 +142,8 @@
               "value": "file path to open"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 175
         },
         {
           "short_description": "fs()",
@@ -159,7 +175,8 @@
             }
           ],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 200
         },
         {
           "short_description": "2mp4()",
@@ -171,7 +188,8 @@
               "value": "mp4 or gif"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 246
         },
         {
           "short_description": "gitrm()",
@@ -183,35 +201,40 @@
               "value": "file type to be removed from this folder"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 263
         },
         {
           "short_description": "pygnore()",
           "long_description": "Generate a .gitignore file for python projects",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 272
         },
         {
           "short_description": "fbr()",
           "long_description": "Fuzzy search git branches",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 281
         },
         {
           "short_description": "fshow()",
           "long_description": "Preview git tree",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 294
         },
         {
           "short_description": "fstat()",
           "long_description": "Show uncommitted files",
           "descriptors": [],
           "params": [],
-          "returns": []
+          "returns": [],
+          "position": 311
         },
         {
           "short_description": "gi()",
@@ -223,7 +246,8 @@
               "value": "list of types to generator gitignore of"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 333
         },
         {
           "short_description": "setgit()",
@@ -235,7 +259,8 @@
               "value": "url of git repo push to"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 343
         },
         {
           "short_description": "gup()",
@@ -247,7 +272,8 @@
               "value": "name of branch"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 352
         },
         {
           "short_description": "psman()",
@@ -259,10 +285,11 @@
               "value": "command line function to call man on"
             }
           ],
-          "returns": []
+          "returns": [],
+          "position": 362
         }
       ],
-      "filename": ".zshrc"
+      "filename": "zshrc"
     }
   ]
 }

src/docs.rs

@@ -3,7 +3,9 @@ use colored::*;
 use dirs::home_dir;
 use glob::glob;
 use handlebars::{to_json, Handlebars};
+use nom::types::CompleteStr;
 use nom::*;
+use nom_locate::{position, LocatedSpan};
 use rayon::prelude::*;
 use serde_derive::*;
 use std::collections::HashMap;
@@ -13,6 +15,8 @@ use std::fs::File;
 use std::io::prelude::*;
 use std::path::Path;
 
+type Span<'a> = LocatedSpan<CompleteStr<'a>>;
+
 /// Represents a simple Key, Value pair
 #[derive(Debug, Default, Serialize, Deserialize, Clone)]
 struct KV {
@@ -34,13 +38,14 @@ impl KV {
 }
 
 /// Represents a docstring
-#[derive(Debug, Default, Serialize, Deserialize, Clone)]
+#[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct Doc {
     short_description: String,
     long_description: String,
     descriptors: Vec<KV>,
     params: Vec<KV>,
     returns: Vec<KV>,
+    position: u32,
 }
 
 impl PartialEq for Doc {
@@ -119,17 +124,20 @@ fn parse_doc<'a>(input: &'a str, delims: Delimiters) -> IResult<&'a str, Doc> {
                 descriptors: desc.unwrap_or_default(),
                 params: par.unwrap_or_default(),
                 returns: ret.unwrap_or_default(),
+                position: 0
             })
     )
 }
 
 impl Doc {
     /// Build a `Doc` from an array of strings
     /// Parse `Doc` fields.
-    pub fn make_doc(vector: String, delims: Delimiters) -> Doc {
+    fn make_doc(vector: &Extracted, delims: Delimiters) -> Doc {
         // println!("{:#?}", vector);
-        let result = parse_doc(&vector, delims);
-        result.expect("Parsing error.").1
+        let parsed = parse_doc(&vector.content, delims);
+        let mut result = parsed.expect("Parsing error.").1;
+        result.position = vector.position.line + 1;
+        result
     }
 }
 
@@ -148,14 +156,30 @@ impl DocFile {
     }
 }
 
+struct Extracted<'a> {
+    position: Span<'a>,
+    content: String,
+}
+
 /// Nom function to extract all docstring from a file.
-fn getinfo(input: &'static str, delims: Delimiters) -> IResult<&'static str, Vec<&'static str>> {
+fn getinfo(
+    input: Span<'static>,
+    delims: Delimiters,
+) -> IResult<Span<'static>, Vec<Extracted<'static>>> {
     many0!(
         input,
-        complete!(preceded!(
-            take_until_and_consume!(delims.start),
-            take_until_and_consume!(delims.end)
-        ))
+        do_parse!(
+            content:
+                complete!(preceded!(
+                    take_until_and_consume!(delims.start),
+                    take_until_and_consume!(delims.end)
+                ))
+                >> pos: position!()
+                >> (Extracted {
+                    position: pos,
+                    content: content.to_string()
+                })
+        )
     )
 }
 
@@ -165,25 +189,25 @@ fn getinfo(input: &'static str, delims: Delimiters) -> IResult<&'static str, Vec
 /// and adds every line to a `Vec` until the end delimiter.
 ///
 /// A final `Vec` of the collected comment strings is returned.
-fn get_info<'a>(p: &Path, delims: Delimiters) -> Vec<&'a str> {
+fn get_info<'a>(p: &Path, delims: Delimiters) -> Vec<Extracted<'a>> {
     let mut f = File::open(&p).expect("file not found.");
     let mut buffer = String::new();
     f.read_to_string(&mut buffer).unwrap();
     let used = Box::leak(buffer.into_boxed_str());
     // println!("{:#?}", used);
-    let result = getinfo(used, delims);
+    let result = getinfo(Span::new(CompleteStr(used)), delims);
     // println!("{:#?}", result);
     result.unwrap().1
 }
 
 /// Given a `Vec<str>` make a `DocFile`
-fn generate_doc_file(docs: &[&str], fname: String, delims: Delimiters) -> DocFile {
+fn generate_doc_file(docs: &Vec<Extracted<'static>>, fname: String, delims: Delimiters) -> DocFile {
     let mut all_docs: DocFile = Default::default();
     all_docs.filename = fname;
     let collected: Vec<Doc> = docs
         .par_iter()
-        .filter(|x| !x.is_empty())
-        .map(|x| Doc::make_doc(x.to_string(), delims))
+        .filter(|x| !x.content.is_empty())
+        .map(|x| Doc::make_doc(x, delims))
         .collect();
     all_docs.thedocs = collected;
     all_docs