#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

#78 in Parser implementations

Download history 21828/week @ 2024-03-14 27645/week @ 2024-03-21 26107/week @ 2024-03-28 24623/week @ 2024-04-04 22339/week @ 2024-04-11 25493/week @ 2024-04-18 25633/week @ 2024-04-25 24965/week @ 2024-05-02 25801/week @ 2024-05-09 23801/week @ 2024-05-16 23923/week @ 2024-05-23 22544/week @ 2024-05-30 23201/week @ 2024-06-06 25259/week @ 2024-06-13 24331/week @ 2024-06-20 18396/week @ 2024-06-27

94,618 downloads per month
Used in 122 crates (56 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