txt-cleaner 0.1.0

A smarter text cleanup library for Rust that trims whitespace, removes BOM/zero-width chars, and cleans markdown/html artifacts.
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

# txt-cleaner


`txt-cleaner` is a small Rust library for smarter cleanup of text data.
It goes beyond `trim()` to normalize whitespace, remove invisible characters, and strip stray markdown/html artifacts from the edges of a string.

## Features


- Remove BOM and zero-width characters like `\u{200B}`
- Collapse consecutive spaces, tabs, and newlines
- Preserve paragraph structure or collapse all whitespace to a single space
- Strip common markdown/html edge artifacts such as headings, unclosed wrappers, and stray tags
- Builder-style configuration API

## Usage


```rust
use txt_cleaner::{clean, CleanOptions};

let raw = "\u{feff}**\n  Hello   \n\n\n  world!  **\u{200B} ";
let cleaned = clean(raw);
assert_eq!(cleaned, "Hello\n\nworld!");

let options = CleanOptions::builder()
    .strip_invisible_chars(true)
    .strip_markdown_artifacts(true)
    .preserve_paragraphs(false)
    .collapse_all_whitespace(true)
    .build();

let cleaned_single_line = txt_cleaner::clean_with_options(raw, options);
assert_eq!(cleaned_single_line, "Hello world!");
```

## License


MIT