drft-cli 0.11.0

A structural integrity checker for linked file systems
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

//! Text parsers: the link/metadata extractors the text builders wrap.
//! `markdown` extracts body links; `frontmatter` extracts YAML frontmatter links
//! and the metadata block.

pub mod frontmatter;
pub mod markdown;

/// One link discovered by a parser: its raw target string as it appears in the
/// source, plus the 1-based source line where it occurs (`None` when the parser
/// cannot locate it). The builder handles normalization (fragment stripping,
/// anchor filtering, URI detection) and aggregates lines onto the edge.
#[derive(Debug, Clone)]
pub struct Link {
    pub target: String,
    pub line: Option<usize>,
}

/// Combined output from parsing a single file: links + optional metadata.
#[derive(Debug, Clone, Default)]
pub struct ParseResult {
    pub links: Vec<Link>,
    /// Structured metadata extracted from the file.
    pub metadata: Option<serde_json::Value>,
}

/// Trait implemented by the built-in text parsers.
pub trait Parser {
    /// Check whether this parser should run on a given file path.
    fn matches(&self, path: &str) -> bool;
    /// Parse a file's content and return discovered links + optional metadata.
    fn parse(&self, path: &str, content: &str) -> ParseResult;
}