parfit 0.4.4

Paragraph fit — a codebase-aware comment reflow tool that wraps prose with optimal-fit line breaking and leaves directives alone. Inspired by par.
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Configuration for [`reflow`](crate::reflow).

use regex::Regex;

use crate::directives::is_default_directive;
use crate::lang::{Fence, Spec};

/// Options controlling how parfit reflows a block of text.
#[derive(Clone, Debug)]
pub struct Options {
    /// Target width in columns, inclusive of the detected prefix.
    pub width: usize,
    /// When set, overrides prefix auto-detection.
    pub forced_prefix: Option<String>,
    pub(crate) default_skips: bool,
    pub(crate) extra_skips: Vec<Regex>,
    pub(crate) ignore_markers: &'static [&'static str],
    pub(crate) fences: &'static [Fence],
}

impl Options {
    /// Build a default configuration at the given width. The
    /// built-in skip list is on by default.
    pub fn new(width: usize) -> Self {
        Self {
            width,
            forced_prefix: None,
            default_skips: true,
            extra_skips: Vec::new(),
            ignore_markers: &[],
            fences: &[],
        }
    }

    /// Toggle the built-in directive skip list.
    pub fn with_default_skips(mut self, on: bool) -> Self {
        self.default_skips = on;
        self
    }

    /// Force an exact comment prefix for every paragraph.
    pub fn with_forced_prefix(mut self, prefix: String) -> Self {
        self.forced_prefix = Some(prefix);
        self
    }

    /// Add a user regex to the skip list. Matching lines pass
    /// through unchanged.
    pub fn with_skip(mut self, pattern: &str) -> Result<Self, regex::Error> {
        self.extra_skips.push(Regex::new(pattern)?);
        Ok(self)
    }

    /// Overlay a language [`Spec`] onto these options so the
    /// reflow pipeline honours that language's `ignore_markers`
    /// and `fences`. Line-comment markers are consumed by the
    /// source-mode walker separately and are not threaded here.
    pub(crate) fn with_spec(mut self, spec: Spec) -> Self {
        self.ignore_markers = spec.ignore_markers;
        self.fences = spec.fences;
        self
    }

    pub(crate) fn matches_skip(&self, line: &str) -> bool {
        let trimmed = line.trim_start();
        if self.default_skips && is_default_directive(trimmed) {
            return true;
        }
        self.extra_skips.iter().any(|r| r.is_match(line))
    }

    pub(crate) fn matches_ignore_marker(&self, line: &str) -> bool {
        let trimmed = line.trim_start();
        self.ignore_markers.iter().any(|m| trimmed.starts_with(m))
    }
}