@nomicfoundation/hardhat-utils 4.1.1 → 4.1.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @nomicfoundation/hardhat-utils
 
+## 4.1.2
+
+### Patch Changes
+
+- [#8264](https://github.com/NomicFoundation/hardhat/pull/8264) [`8452f97`](https://github.com/NomicFoundation/hardhat/commit/8452f9726205540e1684d3f8458bfd145e790226) Thanks [@alcuadrado](https://github.com/alcuadrado)! - Export `./package.json` so consumers can import the package's manifest.
+
 ## 4.1.1
 
 ### Patch Changes

package/dist/src/path.d.ts

@@ -23,4 +23,17 @@ export declare function resolveFromRoot(root: string, target: string): string;
  * @returns The shorter path, if possible, or the original path.
  */
 export declare function shortenPath(absolutePath: string): string;
+/**
+ * Returns a version of {@link name} that is safe to use as a single filename
+ * component on POSIX, macOS, and Windows.
+ *
+ * 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 `.` / `..`.
+ *
+ * @param name The string to sanitize.
+ * @returns A non-empty filename-safe string.
+ */
+export declare function sanitizeFilename(name: string): string;
 //# sourceMappingURL=path.d.ts.map

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"}
+{"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"}

package/dist/src/path.js

@@ -44,4 +44,24 @@ export function shortenPath(absolutePath) {
     }
     return absolutePath;
 }
+/**
+ * Returns a version of {@link name} that is safe to use as a single filename
+ * component on POSIX, macOS, and Windows.
+ *
+ * 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 `.` / `..`.
+ *
+ * @param name The string to sanitize.
+ * @returns A non-empty filename-safe string.
+ */
+export function sanitizeFilename(name) {
+    let result = name.replace(/[<>:"/\\|?*\x00-\x1F\x7F]/g, "");
+    result = result.replace(/[\s.]+$/, "");
+    if (result === "" || result === "." || result === "..") {
+        result = "_";
+    }
+    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"}
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nomicfoundation/hardhat-utils",
-  "version": "4.1.1",
+  "version": "4.1.2",
   "description": "Utilities for Hardhat and its plugins",
   "homepage": "https://github.com/NomicFoundation/hardhat/tree/main/packages/hardhat-utils",
   "repository": {
@@ -39,7 +39,8 @@
     "./stream": "./dist/src/stream.js",
     "./subprocess": "./dist/src/subprocess.js",
     "./synchronization": "./dist/src/synchronization.js",
-    "./spinner": "./dist/src/spinner.js"
+    "./spinner": "./dist/src/spinner.js",
+    "./package.json": "./package.json"
   },
   "keywords": [
     "ethereum",
@@ -54,7 +55,7 @@
     "README.md"
   ],
   "devDependencies": {
-    "@nomicfoundation/hardhat-node-test-reporter": "^3.0.6",
+    "@nomicfoundation/hardhat-node-test-reporter": "^3.0.7",
     "@types/bn.js": "^5.1.5",
     "@types/node": "^22.0.0",
     "c8": "^9.1.0",
@@ -63,7 +64,7 @@
     "prettier": "3.2.5",
     "rimraf": "^5.0.5",
     "tsx": "^4.19.3",
-    "typescript": "~5.8.0"
+    "typescript": "~6.0.3"
   },
   "dependencies": {
     "@streamparser/json-node": "^0.0.22",
@@ -75,8 +76,8 @@
     "undici": "^6.16.1"
   },
   "scripts": {
-    "lint": "pnpm prettier --check && pnpm eslint",
-    "lint:fix": "pnpm prettier --write && pnpm eslint --fix",
+    "lint": "pnpm eslint && pnpm prettier --check",
+    "lint:fix": "pnpm eslint --fix && pnpm prettier --write",
     "eslint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "prettier": "prettier \"**/*.{ts,js,md,json}\"",
     "test": "node --import tsx/esm --test --test-reporter=@nomicfoundation/hardhat-node-test-reporter \"test/*.ts\" \"test/!(fixture-projects|helpers)/**/*.ts\"",

package/src/path.ts

@@ -53,3 +53,26 @@ export function shortenPath(absolutePath: string): string {
 
   return absolutePath;
 }
+
+/**
+ * Returns a version of {@link name} that is safe to use as a single filename
+ * component on POSIX, macOS, and Windows.
+ *
+ * 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 `.` / `..`.
+ *
+ * @param name The string to sanitize.
+ * @returns A non-empty filename-safe string.
+ */
+export function sanitizeFilename(name: string): string {
+  let result = name.replace(/[<>:"/\\|?*\x00-\x1F\x7F]/g, "");
+  result = result.replace(/[\s.]+$/, "");
+
+  if (result === "" || result === "." || result === "..") {
+    result = "_";
+  }
+
+  return result;
+}