#filename #sanitizer #remove #name #node #file #command-line

bin+lib sanitize-filename

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

7 releases (breaking)

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

#50 in Parser implementations

Download history 26399/week @ 2024-07-31 25622/week @ 2024-08-07 25210/week @ 2024-08-14 23723/week @ 2024-08-21 25788/week @ 2024-08-28 27985/week @ 2024-09-04 25478/week @ 2024-09-11 23042/week @ 2024-09-18 30119/week @ 2024-09-25 30136/week @ 2024-10-02 28299/week @ 2024-10-09 33427/week @ 2024-10-16 38579/week @ 2024-10-23 36718/week @ 2024-10-30 36574/week @ 2024-11-06 34380/week @ 2024-11-13

152,632 downloads per month
Used in 196 crates (68 directly)

MIT license

12KB
298 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.7–4MB
~66K SLoC