@cjser/filenamify 7.0.1-cjser.2

package/dist-cjser/browser.cjs

@@ -0,0 +1,113 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/filenamify.tmp-26-1778150437771/filenamify.js
+var filenamify_exports = {};
+__export(filenamify_exports, {
+  default: () => filenamify
+});
+module.exports = __toCommonJS(filenamify_exports);
+var import_filename_reserved_regex = __toESM(require("@cjser/filename-reserved-regex"), 1);
+var MAX_FILENAME_LENGTH = 100;
+var reRelativePath = /^\.+(\\|\/)|^\.+$/;
+var reTrailingDotsAndSpaces = /[. ]+$/;
+var reControlChars = /[\p{Control}\p{Format}\p{Zl}\p{Zp}\uFFF0-\uFFFF]/gu;
+var reControlCharsTest = /[\p{Control}\p{Format}\p{Zl}\p{Zp}\uFFF0-\uFFFF]/u;
+var isZeroWidthJoiner = (char) => char === "\u200D";
+var reRepeatedReservedCharacters = /([<>:"/\\|?*\u0000-\u001F]){2,}/g;
+var reReplacementReservedCharacters = /[<>:"/\\|?*\u0000-\u001F]/;
+var reUnicodeWhitespace = /[\t\n\r\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]+/g;
+var segmenter;
+function getSegmenter() {
+  segmenter ??= new Intl.Segmenter(void 0, { granularity: "grapheme" });
+  return segmenter;
+}
+function truncateFilename(filename, maxLength) {
+  if (filename.length <= maxLength) {
+    return filename;
+  }
+  const extensionIndex = filename.lastIndexOf(".");
+  if (extensionIndex === -1) {
+    return truncateByGraphemeBudget(filename, maxLength);
+  }
+  const base = filename.slice(0, extensionIndex);
+  const extension = filename.slice(extensionIndex);
+  const baseBudget = Math.max(0, maxLength - extension.length);
+  const truncatedBase = truncateByGraphemeBudget(base, baseBudget);
+  return truncatedBase.replace(/ +$/, "") + extension;
+}
+function filenamify(string, options = {}) {
+  if (typeof string !== "string") {
+    throw new TypeError("Expected a string");
+  }
+  const replacement = options.replacement ?? "!";
+  const hasReservedChars = reReplacementReservedCharacters.test(replacement);
+  const hasControlChars = [...replacement].some((char) => reControlCharsTest.test(char) && !isZeroWidthJoiner(char));
+  if (hasReservedChars || hasControlChars) {
+    throw new Error("Replacement string cannot contain reserved filename characters");
+  }
+  string = string.normalize("NFC");
+  string = string.replaceAll(reUnicodeWhitespace, " ");
+  if (replacement.length > 0) {
+    string = string.replaceAll(reRepeatedReservedCharacters, "$1");
+  }
+  string = string.replace(reTrailingDotsAndSpaces, "");
+  string = string.replace(reRelativePath, replacement);
+  string = string.replace((0, import_filename_reserved_regex.default)(), replacement);
+  string = string.replaceAll(reControlChars, (char) => isZeroWidthJoiner(char) ? char : replacement);
+  string = string.replace(reTrailingDotsAndSpaces, "");
+  if (string.length === 0) {
+    string = replacement.replace(reTrailingDotsAndSpaces, "");
+    if (string.length === 0 && replacement.length > 0) {
+      string = "!";
+    }
+  }
+  const allowedLength = typeof options.maxLength === "number" ? options.maxLength : MAX_FILENAME_LENGTH;
+  string = truncateFilename(string, allowedLength);
+  string = string.replace(reTrailingDotsAndSpaces, "");
+  if ((0, import_filename_reserved_regex.windowsReservedNameRegex)().test(string)) {
+    string += replacement;
+  }
+  return string;
+}
+function truncateByGraphemeBudget(input, budget) {
+  if (input.length <= budget) {
+    return input;
+  }
+  let count = 0;
+  let output = "";
+  for (const { segment } of getSegmenter().segment(input)) {
+    const next = count + segment.length;
+    if (next > budget) {
+      break;
+    }
+    output += segment;
+    count = next;
+  }
+  return output;
+}

package/dist-cjser/index.cjs

@@ -0,0 +1,127 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/filenamify.tmp-26-1778150437771/index.js
+var index_exports = {};
+__export(index_exports, {
+  default: () => filenamify,
+  filenamifyPath: () => filenamifyPath
+});
+module.exports = __toCommonJS(index_exports);
+
+// packages/@cjser/filenamify.tmp-26-1778150437771/filenamify.js
+var import_filename_reserved_regex = __toESM(require("@cjser/filename-reserved-regex"), 1);
+var MAX_FILENAME_LENGTH = 100;
+var reRelativePath = /^\.+(\\|\/)|^\.+$/;
+var reTrailingDotsAndSpaces = /[. ]+$/;
+var reControlChars = /[\p{Control}\p{Format}\p{Zl}\p{Zp}\uFFF0-\uFFFF]/gu;
+var reControlCharsTest = /[\p{Control}\p{Format}\p{Zl}\p{Zp}\uFFF0-\uFFFF]/u;
+var isZeroWidthJoiner = (char) => char === "\u200D";
+var reRepeatedReservedCharacters = /([<>:"/\\|?*\u0000-\u001F]){2,}/g;
+var reReplacementReservedCharacters = /[<>:"/\\|?*\u0000-\u001F]/;
+var reUnicodeWhitespace = /[\t\n\r\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]+/g;
+var segmenter;
+function getSegmenter() {
+  segmenter ??= new Intl.Segmenter(void 0, { granularity: "grapheme" });
+  return segmenter;
+}
+function truncateFilename(filename, maxLength) {
+  if (filename.length <= maxLength) {
+    return filename;
+  }
+  const extensionIndex = filename.lastIndexOf(".");
+  if (extensionIndex === -1) {
+    return truncateByGraphemeBudget(filename, maxLength);
+  }
+  const base = filename.slice(0, extensionIndex);
+  const extension = filename.slice(extensionIndex);
+  const baseBudget = Math.max(0, maxLength - extension.length);
+  const truncatedBase = truncateByGraphemeBudget(base, baseBudget);
+  return truncatedBase.replace(/ +$/, "") + extension;
+}
+function filenamify(string, options = {}) {
+  if (typeof string !== "string") {
+    throw new TypeError("Expected a string");
+  }
+  const replacement = options.replacement ?? "!";
+  const hasReservedChars = reReplacementReservedCharacters.test(replacement);
+  const hasControlChars = [...replacement].some((char) => reControlCharsTest.test(char) && !isZeroWidthJoiner(char));
+  if (hasReservedChars || hasControlChars) {
+    throw new Error("Replacement string cannot contain reserved filename characters");
+  }
+  string = string.normalize("NFC");
+  string = string.replaceAll(reUnicodeWhitespace, " ");
+  if (replacement.length > 0) {
+    string = string.replaceAll(reRepeatedReservedCharacters, "$1");
+  }
+  string = string.replace(reTrailingDotsAndSpaces, "");
+  string = string.replace(reRelativePath, replacement);
+  string = string.replace((0, import_filename_reserved_regex.default)(), replacement);
+  string = string.replaceAll(reControlChars, (char) => isZeroWidthJoiner(char) ? char : replacement);
+  string = string.replace(reTrailingDotsAndSpaces, "");
+  if (string.length === 0) {
+    string = replacement.replace(reTrailingDotsAndSpaces, "");
+    if (string.length === 0 && replacement.length > 0) {
+      string = "!";
+    }
+  }
+  const allowedLength = typeof options.maxLength === "number" ? options.maxLength : MAX_FILENAME_LENGTH;
+  string = truncateFilename(string, allowedLength);
+  string = string.replace(reTrailingDotsAndSpaces, "");
+  if ((0, import_filename_reserved_regex.windowsReservedNameRegex)().test(string)) {
+    string += replacement;
+  }
+  return string;
+}
+function truncateByGraphemeBudget(input, budget) {
+  if (input.length <= budget) {
+    return input;
+  }
+  let count = 0;
+  let output = "";
+  for (const { segment } of getSegmenter().segment(input)) {
+    const next = count + segment.length;
+    if (next > budget) {
+      break;
+    }
+    output += segment;
+    count = next;
+  }
+  return output;
+}
+
+// packages/@cjser/filenamify.tmp-26-1778150437771/filenamify-path.js
+var import_node_path = __toESM(require("node:path"), 1);
+function filenamifyPath(filePath, options) {
+  filePath = import_node_path.default.resolve(filePath);
+  return import_node_path.default.join(import_node_path.default.dirname(filePath), filenamify(import_node_path.default.basename(filePath), options));
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  filenamifyPath
+});

package/filenamify-path.d.ts

@@ -0,0 +1,16 @@
+import {type Options} from './filenamify.js';
+
+/**
+Convert the filename in a path to a valid filename and return the augmented path.
+
+@example
+```
+import {filenamifyPath} from '@cjser/filenamify';
+
+filenamifyPath('foo:bar');
+//=> 'foo!bar'
+```
+*/
+export default function filenamifyPath(path: string, options?: Options): string;
+
+export type {Options} from './filenamify.js';

package/filenamify-path.js

@@ -0,0 +1,7 @@
+import path from 'node:path';
+import filenamify from './filenamify.js';
+
+export default function filenamifyPath(filePath, options) {
+	filePath = path.resolve(filePath);
+	return path.join(path.dirname(filePath), filenamify(path.basename(filePath), options));
+}

package/filenamify.d.ts

@@ -0,0 +1,39 @@
+export type Options = {
+	/**
+	String to use as replacement for reserved filename characters.
+
+	Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*` or control characters.
+
+	@default '!'
+	*/
+	readonly replacement?: string;
+
+	/**
+	Truncate the filename to the given length.
+
+	Only the base of the filename is truncated, preserving the extension. If the extension itself is longer than `maxLength`, you will get a string that is longer than `maxLength`, so you need to check for that if you allow arbitrary extensions.
+
+	Truncation is grapheme-aware and will not split Unicode characters (surrogate pairs or extended grapheme clusters). If the remaining budget (after accounting for the extension) is smaller than a whole grapheme, the base filename may be truncated to an empty string to avoid splitting.
+
+	Systems generally allow up to 255 characters, but we default to 100 for usability reasons.
+
+	@default 100
+	*/
+	readonly maxLength?: number;
+};
+
+/**
+Convert a string to a valid filename.
+
+@example
+```
+import filenamify from '@cjser/filenamify';
+
+filenamify('<foo/bar>');
+//=> '!foo!bar!'
+
+filenamify('foo:"bar"', {replacement: '🐴'});
+//=> 'foo🐴bar🐴'
+```
+*/
+export default function filenamify(string: string, options?: Options): string;

package/filenamify.js

@@ -0,0 +1,128 @@
+import filenameReservedRegex, {windowsReservedNameRegex} from '@cjser/filename-reserved-regex';
+
+// Doesn't make sense to have longer filenames
+const MAX_FILENAME_LENGTH = 100;
+
+const reRelativePath = /^\.+(\\|\/)|^\.+$/;
+const reTrailingDotsAndSpaces = /[. ]+$/;
+
+// Remove all problematic characters except zero-width joiner (\u200D) needed for emoji
+const reControlChars = /[\p{Control}\p{Format}\p{Zl}\p{Zp}\uFFF0-\uFFFF]/gu;
+const reControlCharsTest = /[\p{Control}\p{Format}\p{Zl}\p{Zp}\uFFF0-\uFFFF]/u;
+const isZeroWidthJoiner = char => char === '\u200D';
+const reRepeatedReservedCharacters = /([<>:"/\\|?*\u0000-\u001F]){2,}/g; // eslint-disable-line no-control-regex
+
+// For validating replacement string - only truly reserved characters, not trailing spaces/periods
+const reReplacementReservedCharacters = /[<>:"/\\|?*\u0000-\u001F]/; // eslint-disable-line no-control-regex
+
+// Normalize various Unicode whitespace characters to regular space
+// Using specific characters instead of \s to avoid matching regular spaces
+const reUnicodeWhitespace = /[\t\n\r\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]+/g;
+
+let segmenter;
+function getSegmenter() {
+	segmenter ??= new Intl.Segmenter(undefined, {granularity: 'grapheme'});
+	return segmenter;
+}
+
+function truncateFilename(filename, maxLength) {
+	if (filename.length <= maxLength) {
+		return filename;
+	}
+
+	const extensionIndex = filename.lastIndexOf('.');
+
+	// No extension - simple truncation
+	if (extensionIndex === -1) {
+		return truncateByGraphemeBudget(filename, maxLength);
+	}
+
+	// Has extension - preserve it and truncate base
+	const base = filename.slice(0, extensionIndex);
+	const extension = filename.slice(extensionIndex);
+	const baseBudget = Math.max(0, maxLength - extension.length);
+	const truncatedBase = truncateByGraphemeBudget(base, baseBudget);
+
+	// Strip trailing spaces from base (not periods - they're not trailing in final filename)
+	return truncatedBase.replace(/ +$/, '') + extension;
+}
+
+export default function filenamify(string, options = {}) {
+	if (typeof string !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	const replacement = options.replacement ?? '!';
+
+	const hasReservedChars = reReplacementReservedCharacters.test(replacement);
+	const hasControlChars = [...replacement].some(char => reControlCharsTest.test(char) && !isZeroWidthJoiner(char));
+
+	if (hasReservedChars || hasControlChars) {
+		throw new Error('Replacement string cannot contain reserved filename characters');
+	}
+
+	// Normalize to NFC first to stabilize byte representation and length calculations across platforms.
+	string = string.normalize('NFC');
+
+	// Normalize Unicode whitespace to single spaces
+	string = string.replaceAll(reUnicodeWhitespace, ' ');
+
+	if (replacement.length > 0) {
+		string = string.replaceAll(reRepeatedReservedCharacters, '$1');
+	}
+
+	// Trim trailing spaces and periods (Windows rule) - do this BEFORE replacements
+	// so they get stripped rather than replaced
+	string = string.replace(reTrailingDotsAndSpaces, '');
+
+	string = string.replace(reRelativePath, replacement);
+	string = string.replace(filenameReservedRegex(), replacement);
+	string = string.replaceAll(reControlChars, char => isZeroWidthJoiner(char) ? char : replacement);
+
+	// Trim trailing spaces and periods again (in case replacement created new ones)
+	string = string.replace(reTrailingDotsAndSpaces, '');
+
+	// If the string is now empty, use replacement with trailing spaces/periods stripped
+	if (string.length === 0) {
+		string = replacement.replace(reTrailingDotsAndSpaces, '');
+		// If still empty and replacement wasn't explicitly empty, use '!' as fallback
+		if (string.length === 0 && replacement.length > 0) {
+			string = '!';
+		}
+	}
+
+	// Truncate before Windows reserved name check (truncation can create reserved names)
+	const allowedLength = typeof options.maxLength === 'number' ? options.maxLength : MAX_FILENAME_LENGTH;
+	string = truncateFilename(string, allowedLength);
+
+	// Strip trailing spaces/periods after truncation (truncation can create them)
+	string = string.replace(reTrailingDotsAndSpaces, '');
+
+	// Check for Windows reserved names after truncation and stripping
+	// Windows compatibility takes precedence over maxLength, so we add suffix even if it exceeds limit
+	if (windowsReservedNameRegex().test(string)) {
+		string += replacement;
+	}
+
+	return string;
+}
+
+function truncateByGraphemeBudget(input, budget) {
+	if (input.length <= budget) {
+		return input;
+	}
+
+	let count = 0;
+	let output = '';
+	for (const {segment} of getSegmenter().segment(input)) {
+		const next = count + segment.length;
+		if (next > budget) {
+			break;
+		}
+
+		output += segment;
+		count = next;
+	}
+
+	return output;
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export {default} from './filenamify.js';
+export * from './filenamify.js';
+export {default as filenamifyPath} from './filenamify-path.js';

package/index.js

@@ -0,0 +1,2 @@
+export {default} from './filenamify.js';
+export {default as filenamifyPath} from './filenamify-path.js';

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@cjser/filenamify",
+  "version": "7.0.1-cjser.2",
+  "description": "Convert a string to a valid safe filename",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./dist-cjser/index.cjs",
+      "default": "./index.js"
+    },
+    "./browser": {
+      "types": "./filenamify.d.ts",
+      "require": "./dist-cjser/browser.cjs",
+      "default": "./filenamify.js"
+    }
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "test": "xo && ava"
+  },
+  "files": [
+    "filenamify-path.d.ts",
+    "filenamify-path.js",
+    "filenamify.d.ts",
+    "filenamify.js",
+    "index.d.ts",
+    "index.js",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "filename",
+    "safe",
+    "sanitize",
+    "file",
+    "name",
+    "string",
+    "path",
+    "filepath",
+    "convert",
+    "valid",
+    "dirname"
+  ],
+  "dependencies": {
+    "@cjser/filename-reserved-regex": "4.0.0-cjser.2"
+  },
+  "devDependencies": {
+    "ava": "^6.4.1",
+    "xo": "^1.2.2"
+  },
+  "types": "./index.d.ts",
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "7.0.1",
+    "cjserVersion": 2,
+    "original": {
+      "name": "filenamify",
+      "version": "7.0.1",
+      "exports": {
+        ".": {
+          "types": "./index.d.ts",
+          "default": "./index.js"
+        },
+        "./browser": {
+          "types": "./filenamify.d.ts",
+          "default": "./filenamify.js"
+        }
+      },
+      "repository": "sindresorhus/filenamify",
+      "dependencies": {
+        "filename-reserved-regex": "^4.0.0"
+      },
+      "files": [
+        "filenamify-path.d.ts",
+        "filenamify-path.js",
+        "filenamify.d.ts",
+        "filenamify.js",
+        "index.d.ts",
+        "index.js"
+      ],
+      "scripts": {
+        "test": "xo && ava"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,92 @@
+# filenamify
+
+> Convert a string to a valid safe filename
+
+On Unix-like systems, `/` is reserved. On Windows, [`<>:"/\|?*`](http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29#naming_conventions) along with trailing periods and spaces are reserved.
+
+This module also removes non-printable control characters (including Unicode bidirectional marks) and normalizes Unicode whitespace.
+
+## Install
+
+```sh
+npm install filenamify
+```
+
+## Usage
+
+```js
+import filenamify from 'filenamify';
+
+filenamify('<foo/bar>');
+//=> '!foo!bar!'
+
+filenamify('foo:"bar"', {replacement: '🐴'});
+//=> 'foo🐴bar🐴'
+```
+
+## API
+
+### filenamify(string, options?)
+
+Convert a string to a valid filename.
+
+### filenamifyPath(path, options?)
+
+Convert the filename in a path to a valid filename and return the augmented path.
+
+```js
+import {filenamifyPath} from 'filenamify';
+
+filenamifyPath('foo:bar');
+//=> 'foo!bar'
+```
+
+#### options
+
+Type: `object`
+
+##### replacement
+
+Type: `string`\
+Default: `'!'`
+
+String to use as replacement for reserved filename characters.
+
+Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*` or control characters.
+
+##### maxLength
+
+Type: `number`\
+Default: `100`
+
+Truncate the filename to the given length.
+
+Only the base of the filename is truncated, preserving the extension. If the extension itself is longer than `maxLength`, you will get a string that is longer than `maxLength`, so you need to check for that if you allow arbitrary extensions.
+
+Truncation is grapheme-aware and will not split Unicode characters (surrogate pairs or extended grapheme clusters). If the remaining budget (after accounting for the extension) is smaller than a whole grapheme, the base filename may be truncated to an empty string to avoid splitting.
+
+Systems generally allow up to 255 characters, but we default to 100 for usability reasons.
+
+## Browser-only import
+
+You can also import `filenamify/browser`, which only imports `filenamify` and not `filenamifyPath`, which relies on `path` being available or polyfilled. Importing `filenamify` this way is therefore useful when it is shipped using `webpack` or similar tools, and if `filenamifyPath` is not needed.
+
+```js
+import filenamify from 'filenamify/browser';
+
+filenamify('<foo/bar>');
+//=> '!foo!bar!'
+```
+
+## Related
+
+- [filenamify-cli](https://github.com/sindresorhus/filenamify-cli) - CLI for this module
+- [filenamify-url](https://github.com/sindresorhus/filenamify-url) - Convert a URL to a valid filename
+- [valid-filename](https://github.com/sindresorhus/valid-filename) - Check if a string is a valid filename
+- [unused-filename](https://github.com/sindresorhus/unused-filename) - Get a unused filename by appending a number if it exists
+- [slugify](https://github.com/sindresorhus/slugify) - Slugify a string
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/filenamify