A functionally verbatim fork of the node-sanitize-filename package which is named sanitize-filename on npm.

The only changes which I have made are to the package.json file to add the module field and to the index.js file to add the export default statement.

This fork is intended to be used as a drop-in replacement for the original package when using ES modules.

I am using it as part of my Marchive product.

Following is the original README.md file from the original package, with updated examples;

Sanitize a string to be safe for use as a filename by removing directory paths and invalid characters.

npm: sanitize-filename

npm install sanitize-filename

import sanitize from "sanitize-filename";

// Some string that may be unsafe or invalid as a filename
const UNSAFE_USER_INPUT = "~/.\u0000ssh/authorized_keys";

// Sanitize the string to be safe for use as a filename.
const filename = sanitize(UNSAFE_USER_INPUT);
// -> "~.sshauthorized_keys"

sanitize-filename removes the following:

• Control characters (0x00–0x1f and 0x80–0x9f)
• Reserved characters (/, ?, <, >, \, :, *, |, and ")
• Unix reserved filenames (. and ..)
• Trailing periods and spaces (for Windows)
• Windows reserved filenames (CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9)

The resulting string is truncated to 255 bytes in length. The string will not contain any directory paths and will be safe to use as a filename.

An empty string "" can be returned. For example:

import sanitize from "sanitize-filename";
sanitize("..")
// -> ""

Two different inputs can return the same value. For example:

import sanitize from "sanitize-filename";
sanitize("file?")
// -> "file"
sanitize ("*file*")
// -> "file"

Sanitized filenames will be safe for use on modern Windows, OS X, and Unix file systems (NTFS, ext, etc.).

FAT 8.3 filenames are not supported.

The test program will use various strings (including the Big List of Naughty Strings) to create files in the working directory. Run npm test to run tests against your file system.

Sanitize inputString by removing or replacing invalid characters.

Options:

• options.replacement: optional, string/function, default: "". If passed as a string, it's used as the replacement for invalid characters. If passed as a function, the function will be called with the invalid characters and it's return value will be used as the replacement. See String.prototype.replace for more info.