@nomicfoundation/hardhat-utils 4.1.3 → 4.1.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @nomicfoundation/hardhat-utils
 
+## 4.1.4
+
+### Patch Changes
+
+- [#8402](https://github.com/NomicFoundation/hardhat/pull/8402) [`afa9bc4`](https://github.com/NomicFoundation/hardhat/commit/afa9bc44e14563c1fd77440228ef6fbc785774b4) Thanks [@flag4table](https://github.com/flag4table)! - Make `sanitizeFilename` avoid Windows reserved device names while preserving filename extensions.
+
 ## 4.1.3
 
 ### Patch Changes

package/dist/src/path.d.ts

@@ -29,8 +29,9 @@ export declare function shortenPath(absolutePath: string): string;
  *
  * Strips characters that are reserved on at least one of those platforms
  * (`<>:"/\|?*` and ASCII control chars), trims trailing dots and whitespace
- * (Windows silently strips them on write), and falls back to `_` if the
- * result is empty or one of the path-traversal literals `.` / `..`.
+ * (Windows silently strips them on write), avoids Windows reserved device
+ * names, and falls back to `_` if the result is empty or one of the
+ * path-traversal literals `.` / `..`.
  *
  * @param name The string to sanitize.
  * @returns A non-empty filename-safe string.

package/dist/src/path.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMpE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAqBxD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CASrD"}
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAKA;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMpE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAqBxD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAqBrD"}

package/dist/src/path.js

@@ -1,4 +1,5 @@
 import path from "node:path";
+const WINDOWS_RESERVED_FILENAME_PATTERN = /^(con|prn|aux|nul|com[1-9]|lpt[1-9])(\..*)?$/i;
 /**
  * Resolves a user-provided path into an absolute path.
  *
@@ -50,8 +51,9 @@ export function shortenPath(absolutePath) {
  *
  * Strips characters that are reserved on at least one of those platforms
  * (`<>:"/\|?*` and ASCII control chars), trims trailing dots and whitespace
- * (Windows silently strips them on write), and falls back to `_` if the
- * result is empty or one of the path-traversal literals `.` / `..`.
+ * (Windows silently strips them on write), avoids Windows reserved device
+ * names, and falls back to `_` if the result is empty or one of the
+ * path-traversal literals `.` / `..`.
  *
  * @param name The string to sanitize.
  * @returns A non-empty filename-safe string.
@@ -62,6 +64,15 @@ export function sanitizeFilename(name) {
     if (result === "" || result === "." || result === "..") {
         result = "_";
     }
+    if (WINDOWS_RESERVED_FILENAME_PATTERN.test(result)) {
+        const extensionIndex = result.indexOf(".");
+        if (extensionIndex === -1) {
+            result = `${result}_`;
+        }
+        else {
+            result = `${result.slice(0, extensionIndex)}_${result.slice(extensionIndex)}`;
+        }
+    }
     return result;
 }
 //# sourceMappingURL=path.js.map

package/dist/src/path.js.map

@@ -1 +1 @@
-{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,MAAc;IAC1D,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CAAC,YAAoB;IAC9C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,IAAI,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAEpD,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,IACE,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;QACzC,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACxC,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAC9B,CAAC;QACD,YAAY,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC;IAC/C,CAAC;IAED,IAAI,YAAY,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;QAC9C,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IAC5D,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAEvC,IAAI,MAAM,KAAK,EAAE,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACvD,MAAM,GAAG,GAAG,CAAC;IACf,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,iCAAiC,GACrC,+CAA+C,CAAC;AAElD;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,MAAc;IAC1D,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CAAC,YAAoB;IAC9C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,IAAI,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAEpD,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,IACE,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;QACzC,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACxC,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAC9B,CAAC;QACD,YAAY,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC;IAC/C,CAAC;IAED,IAAI,YAAY,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;QAC9C,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IAC5D,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAEvC,IAAI,MAAM,KAAK,EAAE,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACvD,MAAM,GAAG,GAAG,CAAC;IACf,CAAC;IAED,IAAI,iCAAiC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAE3C,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,IAAI,MAAM,CAAC,KAAK,CACzD,cAAc,CACf,EAAE,CAAC;QACN,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nomicfoundation/hardhat-utils",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "Utilities for Hardhat and its plugins",
   "homepage": "https://github.com/NomicFoundation/hardhat/tree/main/packages/hardhat-utils",
   "repository": {

package/src/path.ts

@@ -1,5 +1,8 @@
 import path from "node:path";
 
+const WINDOWS_RESERVED_FILENAME_PATTERN =
+  /^(con|prn|aux|nul|com[1-9]|lpt[1-9])(\..*)?$/i;
+
 /**
  * Resolves a user-provided path into an absolute path.
  *
@@ -60,8 +63,9 @@ export function shortenPath(absolutePath: string): string {
  *
  * Strips characters that are reserved on at least one of those platforms
  * (`<>:"/\|?*` and ASCII control chars), trims trailing dots and whitespace
- * (Windows silently strips them on write), and falls back to `_` if the
- * result is empty or one of the path-traversal literals `.` / `..`.
+ * (Windows silently strips them on write), avoids Windows reserved device
+ * names, and falls back to `_` if the result is empty or one of the
+ * path-traversal literals `.` / `..`.
  *
  * @param name The string to sanitize.
  * @returns A non-empty filename-safe string.
@@ -74,5 +78,17 @@ export function sanitizeFilename(name: string): string {
     result = "_";
   }
 
+  if (WINDOWS_RESERVED_FILENAME_PATTERN.test(result)) {
+    const extensionIndex = result.indexOf(".");
+
+    if (extensionIndex === -1) {
+      result = `${result}_`;
+    } else {
+      result = `${result.slice(0, extensionIndex)}_${result.slice(
+        extensionIndex,
+      )}`;
+    }
+  }
+
   return result;
 }