nix-doc 0.5.3

Nix documentation grepping tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! A nix documentation search program

use nix_doc::{is_searchable, search, tags, Result};

use regex::Regex;
use structopt::StructOpt;

use std::{fs, io::BufWriter, path::PathBuf};

#[derive(StructOpt, Debug)]
#[structopt(about = "an AST based Nix documentation tool")]
enum Args {
    /// Search a directory of nix files for the given function
    Search {
        /// Regex to search with
        re: String,

        /// Directory to search
        #[structopt(default_value = ".")]
        dir: PathBuf,
    },

    /// Generates a ctags compatible database for a directory of nix files
    Tags {
        /// The directory
        #[structopt(default_value = ".")]
        dir: PathBuf,
    },
}

fn main() -> Result<()> {
    let args = Args::from_args();

    match args {
        Args::Search { re, dir } => {
            let re_match = Regex::new(&re)?;
            search(&dir, re_match, is_searchable);
        }

        Args::Tags { dir } => {
            let h = fs::OpenOptions::new()
                .write(true)
                .truncate(true)
                .create(true)
                .open("tags")?;
            let mut h = BufWriter::new(h);

            let res = tags::run_on_dir(&dir, &mut h);
            if let Err(e) = res {
                eprintln!("Failed while ctags'ing: {:?}", e);
            }
        }
    }
    Ok(())
}