#filename #sanitizer #node #name #file #replace #windows

bin+lib sanitize-filename

A simple filename sanitizer, based on Node's sanitize-filename

6 releases (breaking)

Uses old Rust 2015

0.5.0 Jul 31, 2023
0.4.0 May 7, 2022
0.3.0 Oct 18, 2020
0.2.1 Oct 24, 2018
0.1.0 Oct 24, 2018

#95 in Parser implementations

Download history 23591/week @ 2024-01-15 22946/week @ 2024-01-22 20921/week @ 2024-01-29 20284/week @ 2024-02-05 21530/week @ 2024-02-12 20412/week @ 2024-02-19 19785/week @ 2024-02-26 21382/week @ 2024-03-04 21156/week @ 2024-03-11 24070/week @ 2024-03-18 27411/week @ 2024-03-25 26974/week @ 2024-04-01 22226/week @ 2024-04-08 25298/week @ 2024-04-15 24241/week @ 2024-04-22 25475/week @ 2024-04-29

98,874 downloads per month
Used in 125 crates (55 directly)

MIT license

12KB
308 lines

sanitize-filename

A basic filename sanitizer, based on Node's sanitize-filename.

Use like:

extern crate sanitize_filename;

fn main() {
    println!("{}", sanitize_filename::sanitize("some-user-defined/../../../string"));
    // prints some-user-defined......string
}

You can also configure a few basic options:

let options = sanitize_filename::Options {
    truncate: true, // true by default, truncates to 255 bytes
    windows: true, // default value depends on the OS, removes reserved names like `con` from start of strings on Windows
    replacement: "" // str to replace sanitized chars/strings
};

let sanitized = sanitize_filename::sanitize_with_options("some-user-defined/../../../string", options);

Also provides a basic command line binary. Use like:

cargo install sanitize-filename
sanitize-filename my_filename.txt
Pass a file name to clean to the program (also reads STDIN)

FLAGS:
    -r, --replace <r>          Replacement characters
    --windows, --no-windows    Whether to handle filenames for Windows
    --truncate, --no-truncate  Whether to truncate file names to 255 bytes

Dependencies

~2.8–4MB
~67K SLoC