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

//! parfit — paragraph fit.
//!
//! Reflow prose in code comments to a target width using optimal-fit
//! line breaking. Lines that look like directives (`//go:generate`,
//! `// eslint-disable`, `#!/usr/bin/env bash`, `#[derive(…)]`, …)
//! pass through unchanged. Words that look like URLs never split.
//!
//! Two entry points:
//!
//! - [`reflow`]: treat the whole input as prose and wrap each
//!   paragraph. Used when the input is plain text (a README, an
//!   email, a comment block the caller has already extracted) or
//!   when no language context is available.
//! - [`reflow_source`]: given a source file and a [`Language`],
//!   reflow only the comment blocks and leave the code untouched.

mod directives;
mod lang;
mod options;
mod prefix;
mod reflow;
mod source;

pub use lang::Language;
pub use options::Options;
pub use reflow::reflow;
pub use source::reflow_source;