@cjser/filenamify 7.0.2-cjser.2 → 7.0.3-cjser.2

package/dist-cjser/browser.cjs

@@ -26,7 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/@cjser/filenamify.tmp-26-1781714412105/filenamify.js
+// packages/@cjser/filenamify.tmp-25-1788284040504/filenamify.js
 var filenamify_exports = {};
 __export(filenamify_exports, {
   default: () => filenamify
@@ -36,6 +36,8 @@ var import_filename_reserved_regex = __toESM(require("@cjser/filename-reserved-r
 var MAX_FILENAME_LENGTH = 100;
 var reRelativePath = /^\.+(\\|\/)|^\.+$/;
 var reTrailingDotsAndSpaces = /[. ]+$/;
+var reTrailingSpaces = / +$/;
+var reWindowsReservedName = (0, import_filename_reserved_regex.windowsReservedNameRegex)();
 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";
@@ -59,15 +61,18 @@ function truncateFilename(filename, maxLength) {
   const extension = filename.slice(extensionIndex);
   const baseBudget = Math.max(0, maxLength - extension.length);
   const truncatedBase = truncateByGraphemeBudget(base, baseBudget);
-  return truncatedBase.replace(/ +$/, "") + extension;
+  return truncatedBase.replace(reTrailingSpaces, "") + extension;
 }
 function ensureNonWindowsReservedName(filename, replacement) {
-  const extensionIndex = filename.indexOf(".");
-  const base = extensionIndex === -1 ? filename : filename.slice(0, extensionIndex);
-  if (!(0, import_filename_reserved_regex.windowsReservedNameRegex)().test(base)) {
+  if (!reWindowsReservedName.test(filename)) {
     return filename;
   }
-  return extensionIndex === -1 ? filename + replacement : base + replacement + filename.slice(extensionIndex);
+  const extensionIndex = filename.indexOf(".");
+  const base = extensionIndex === -1 ? filename : filename.slice(0, extensionIndex);
+  const baseWithoutTrailingSpaces = base.replace(reTrailingSpaces, "");
+  const extension = extensionIndex === -1 ? "" : filename.slice(extensionIndex);
+  const candidate = (baseWithoutTrailingSpaces + replacement + extension).replace(reTrailingDotsAndSpaces, "");
+  return reWindowsReservedName.test(candidate) ? baseWithoutTrailingSpaces + "!" + extension : candidate;
 }
 function filenamify(string, options = {}) {
   if (typeof string !== "string") {
@@ -85,8 +90,8 @@ function filenamify(string, options = {}) {
     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.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) {

package/dist-cjser/index.cjs

@@ -26,7 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/@cjser/filenamify.tmp-26-1781714412105/index.js
+// packages/@cjser/filenamify.tmp-25-1788284040504/index.js
 var index_exports = {};
 __export(index_exports, {
   default: () => filenamify,
@@ -34,11 +34,13 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// packages/@cjser/filenamify.tmp-26-1781714412105/filenamify.js
+// packages/@cjser/filenamify.tmp-25-1788284040504/filenamify.js
 var import_filename_reserved_regex = __toESM(require("@cjser/filename-reserved-regex"), 1);
 var MAX_FILENAME_LENGTH = 100;
 var reRelativePath = /^\.+(\\|\/)|^\.+$/;
 var reTrailingDotsAndSpaces = /[. ]+$/;
+var reTrailingSpaces = / +$/;
+var reWindowsReservedName = (0, import_filename_reserved_regex.windowsReservedNameRegex)();
 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";
@@ -62,15 +64,18 @@ function truncateFilename(filename, maxLength) {
   const extension = filename.slice(extensionIndex);
   const baseBudget = Math.max(0, maxLength - extension.length);
   const truncatedBase = truncateByGraphemeBudget(base, baseBudget);
-  return truncatedBase.replace(/ +$/, "") + extension;
+  return truncatedBase.replace(reTrailingSpaces, "") + extension;
 }
 function ensureNonWindowsReservedName(filename, replacement) {
-  const extensionIndex = filename.indexOf(".");
-  const base = extensionIndex === -1 ? filename : filename.slice(0, extensionIndex);
-  if (!(0, import_filename_reserved_regex.windowsReservedNameRegex)().test(base)) {
+  if (!reWindowsReservedName.test(filename)) {
     return filename;
   }
-  return extensionIndex === -1 ? filename + replacement : base + replacement + filename.slice(extensionIndex);
+  const extensionIndex = filename.indexOf(".");
+  const base = extensionIndex === -1 ? filename : filename.slice(0, extensionIndex);
+  const baseWithoutTrailingSpaces = base.replace(reTrailingSpaces, "");
+  const extension = extensionIndex === -1 ? "" : filename.slice(extensionIndex);
+  const candidate = (baseWithoutTrailingSpaces + replacement + extension).replace(reTrailingDotsAndSpaces, "");
+  return reWindowsReservedName.test(candidate) ? baseWithoutTrailingSpaces + "!" + extension : candidate;
 }
 function filenamify(string, options = {}) {
   if (typeof string !== "string") {
@@ -88,8 +93,8 @@ function filenamify(string, options = {}) {
     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.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) {
@@ -121,7 +126,7 @@ function truncateByGraphemeBudget(input, budget) {
   return output;
 }
 
-// packages/@cjser/filenamify.tmp-26-1781714412105/filenamify-path.js
+// packages/@cjser/filenamify.tmp-25-1788284040504/filenamify-path.js
 var import_node_path = __toESM(require("node:path"), 1);
 function filenamifyPath(filePath, options) {
   filePath = import_node_path.default.resolve(filePath);

package/filenamify.d.ts

@@ -4,6 +4,8 @@ export type Options = {
 
 	Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*` or control characters.
 
+	If the replacement would leave the result as a Windows reserved name, `!` is used instead.
+
 	@default '!'
 	*/
 	readonly replacement?: string;
@@ -13,6 +15,8 @@ export type Options = {
 
 	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.
 
+	The result may also exceed `maxLength` when a suffix is needed to avoid a Windows reserved name.
+
 	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.

package/filenamify.js

@@ -5,6 +5,8 @@ const MAX_FILENAME_LENGTH = 100;
 
 const reRelativePath = /^\.+(\\|\/)|^\.+$/;
 const reTrailingDotsAndSpaces = /[. ]+$/;
+const reTrailingSpaces = / +$/;
+const reWindowsReservedName = windowsReservedNameRegex();
 
 // 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;
@@ -44,20 +46,23 @@ function truncateFilename(filename, maxLength) {
 	const truncatedBase = truncateByGraphemeBudget(base, baseBudget);
 
 	// Strip trailing spaces from base (not periods - they're not trailing in final filename)
-	return truncatedBase.replace(/ +$/, '') + extension;
+	return truncatedBase.replace(reTrailingSpaces, '') + extension;
 }
 
 function ensureNonWindowsReservedName(filename, replacement) {
-	const extensionIndex = filename.indexOf('.');
-	const base = extensionIndex === -1 ? filename : filename.slice(0, extensionIndex);
-
-	if (!windowsReservedNameRegex().test(base)) {
+	if (!reWindowsReservedName.test(filename)) {
 		return filename;
 	}
 
-	return extensionIndex === -1
-		? filename + replacement
-		: base + replacement + filename.slice(extensionIndex);
+	const extensionIndex = filename.indexOf('.');
+	const base = extensionIndex === -1 ? filename : filename.slice(0, extensionIndex);
+	const baseWithoutTrailingSpaces = base.replace(reTrailingSpaces, '');
+	const extension = extensionIndex === -1 ? '' : filename.slice(extensionIndex);
+	const candidate = (baseWithoutTrailingSpaces + replacement + extension).replace(reTrailingDotsAndSpaces, '');
+
+	return reWindowsReservedName.test(candidate)
+		? baseWithoutTrailingSpaces + '!' + extension
+		: candidate;
 }
 
 export default function filenamify(string, options = {}) {
@@ -88,8 +93,8 @@ export default function filenamify(string, options = {}) {
 	// so they get stripped rather than replaced
 	string = string.replace(reTrailingDotsAndSpaces, '');
 
-	string = string.replace(reRelativePath, replacement);
-	string = string.replace(filenameReservedRegex(), replacement);
+	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)
@@ -112,7 +117,7 @@ export default function filenamify(string, options = {}) {
 	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
+	// Windows compatibility takes precedence over maxLength, so the result may exceed it
 	string = ensureNonWindowsReservedName(string, replacement);
 
 	return string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cjser/filenamify",
-  "version": "7.0.2-cjser.2",
+  "version": "7.0.3-cjser.2",
   "description": "Convert a string to a valid safe filename",
   "license": "MIT",
   "repository": {
@@ -56,7 +56,7 @@
     "dirname"
   ],
   "dependencies": {
-    "@cjser/filename-reserved-regex": "4.0.0-cjser.2"
+    "@cjser/filename-reserved-regex": "4.0.1-cjser.2"
   },
   "devDependencies": {
     "ava": "^6.4.1",
@@ -65,11 +65,11 @@
   "types": "./index.d.ts",
   "main": "./dist-cjser/index.cjs",
   "cjser": {
-    "sourceVersion": "7.0.2",
+    "sourceVersion": "7.0.3",
     "cjserVersion": 2,
     "original": {
       "name": "filenamify",
-      "version": "7.0.2",
+      "version": "7.0.3",
       "exports": {
         ".": {
           "types": "./index.d.ts",
@@ -82,7 +82,7 @@
       },
       "repository": "sindresorhus/filenamify",
       "dependencies": {
-        "filename-reserved-regex": "^4.0.0"
+        "filename-reserved-regex": "^4.0.1"
       },
       "files": [
         "filenamify-path.d.ts",

package/readme.md

@@ -54,6 +54,8 @@ String to use as replacement for reserved filename characters.
 
 Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*` or control characters.
 
+If the replacement would leave the result as a Windows reserved name, `!` is used instead.
+
 ##### maxLength
 
 Type: `number`\
@@ -63,6 +65,8 @@ 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.
 
+The result may also exceed `maxLength` when a suffix is needed to avoid a Windows reserved name.
+
 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.