Merge branch 'main' into refactor/node-test

Author: zachleat

.github/workflows/ci.yml

@@ -1,3 +1,4 @@
+name: Node Unit Tests
 on:
   push:
     branches-ignore:
@@ -8,14 +9,15 @@ jobs:
     strategy:
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
-        node: ["16", "18", "20"]
+        node: ["16", "18", "20", "22"]
     name: Node.js ${{ matrix.node }} on ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
+          # cache: npm
       - run: npm install
       - run: npm test
 env:

index.js

@@ -1,7 +1,11 @@
 const TemplatePath = require("./src/TemplatePath.js");
 const isPlainObject = require("./src/IsPlainObject.js");
+const Merge = require("./src/Merge.js");
+const { DeepCopy } = Merge;
 
 module.exports = {
   TemplatePath,
   isPlainObject,
+  Merge,
+  DeepCopy,
 };

package.json

@@ -1,8 +1,15 @@
 {
   "name": "@11ty/eleventy-utils",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Low level internal utilities to be shared amongst Eleventy projects",
   "main": "index.js",
+  "files": [
+    "src",
+    "src/**",
+    "index.js",
+    "!test",
+    "!test/**"
+  ],
   "scripts": {
     "test": "node --test"
   },
@@ -30,8 +37,5 @@
     "url": "git://github.com/11ty/eleventy-utils.git"
   },
   "bugs": "https://github.com/11ty/eleventy-utils/issues",
-  "homepage": "https://github.com/11ty/eleventy-utils/",
-  "dependencies": {
-    "normalize-path": "^3.0.0"
-  }
+  "homepage": "https://github.com/11ty/eleventy-utils/"
 }

src/Merge.js

@@ -0,0 +1,84 @@
+"use strict";
+// above is required for Object.freeze to fail correctly.
+
+const isPlainObject = require("./IsPlainObject.js");
+
+const OVERRIDE_PREFIX = "override:";
+
+function cleanKey(key, prefix) {
+	if (prefix && key.startsWith(prefix)) {
+		return key.slice(prefix.length);
+	}
+	return key;
+}
+
+function getMergedItem(target, source, prefixes = {}) {
+	let { override } = prefixes;
+
+	// Shortcut for frozen source (if target does not exist)
+	if (!target && isPlainObject(source) && Object.isFrozen(source)) {
+		return source;
+	}
+
+	let sourcePlainObjectShortcut;
+	if (!target && isPlainObject(source)) {
+		// deep copy objects to avoid sharing and to effect key renaming
+		target = {};
+		sourcePlainObjectShortcut = true;
+	}
+
+	if (Array.isArray(target) && Array.isArray(source)) {
+		return target.concat(source);
+	} else if (isPlainObject(target)) {
+		if (sourcePlainObjectShortcut || isPlainObject(source)) {
+			for (let key in source) {
+				let overrideKey = cleanKey(key, override);
+
+				// An error happens here if the target is frozen
+				target[overrideKey] = getMergedItem(target[key], source[key], prefixes);
+			}
+		}
+		return target;
+	}
+	// number, string, class instance, etc
+	return source;
+}
+
+// The same as Merge but without override prefixes
+function DeepCopy(targetObject, ...sources) {
+	for (let source of sources) {
+		if (!source) {
+			continue;
+		}
+
+		targetObject = getMergedItem(targetObject, source);
+	}
+	return targetObject;
+}
+
+function Merge(target, ...sources) {
+	// Remove override prefixes from root target.
+	if (isPlainObject(target)) {
+		for (let key in target) {
+			if (key.indexOf(OVERRIDE_PREFIX) === 0) {
+				target[key.slice(OVERRIDE_PREFIX.length)] = target[key];
+				delete target[key];
+			}
+		}
+	}
+
+	for (let source of sources) {
+		if (!source) {
+			continue;
+		}
+
+		target = getMergedItem(target, source, {
+			override: OVERRIDE_PREFIX,
+		});
+	}
+
+	return target;
+}
+
+module.exports = Merge;
+module.exports.DeepCopy = DeepCopy;

src/TemplatePath.js

@@ -1,5 +1,4 @@
 const path = require("path");
-const normalize = require("normalize-path");
 const fs = require("fs");
 
 function TemplatePath() {}
@@ -15,7 +14,7 @@ TemplatePath.getWorkingDir = function () {
  * Returns the directory portion of a path.
  * Works for directory and file paths and paths ending in a glob pattern.
  *
- * @param {String} path A path
+ * @param {String} path - A path
  * @returns {String} the directory portion of a path.
  */
 TemplatePath.getDir = function (path) {
@@ -34,8 +33,8 @@ TemplatePath.getDir = function (path) {
  *
  * [1]: https://nodejs.org/api/path.html#path_path_parse_path
  *
- * @param {String} path A path
  * @returns {String} the directory portion of a path.
+ * @param {String} filePath - A path
  */
 TemplatePath.getDirFromFilePath = function (filePath) {
   return path.parse(filePath).dir || ".";
@@ -48,7 +47,7 @@ TemplatePath.getDirFromFilePath = function (filePath) {
  *
  * [1]: https://nodejs.org/api/path.html#path_path_parse_path
  *
- * @param {String} path A path
+ * @param {String} path - A path
  * @returns {String} the last path segment in a path
  */
 TemplatePath.getLastPathSegment = function (path) {
@@ -59,11 +58,11 @@ TemplatePath.getLastPathSegment = function (path) {
   // Trim a trailing slash if there is one
   path = path.replace(/\/$/, "");
 
-  return path.substr(path.lastIndexOf("/") + 1);
+  return path.slice(path.lastIndexOf("/") + 1);
 };
 
 /**
- * @param {String} path A path
+ * @param {String} path - A path
  * @returns {String[]} an array of paths pointing to each path segment of the
  * provided `path`.
  */
@@ -89,34 +88,37 @@ TemplatePath.getAllDirs = function (path) {
  *
  * [1]: https://nodejs.org/api/path.html#path_path_normalize_path
  *
- * @param {String} thePath The path that should be normalized.
+ * @param {String} thePath - The path that should be normalized.
  * @returns {String} the normalized path.
  */
 TemplatePath.normalize = function (thePath) {
-  return normalize(path.normalize(thePath));
+  let filePath = path.normalize(thePath).split(path.sep).join("/");
+  if(filePath !== "/" && filePath.endsWith("/")) {
+    return filePath.slice(0, -1);
+  }
+  return filePath;
 };
 
 /**
  * Joins all given path segments together.
  *
- * It uses Node.js’ [`path.join`][1] method and the [normalize-path][2] package.
+ * It uses Node.js’ [`path.join`][1] method.
  *
  * [1]: https://nodejs.org/api/path.html#path_path_join_paths
- * [2]: https://www.npmjs.com/package/normalize-path
  *
- * @param {String[]} paths An arbitrary amount of path segments.
+ * @param {...String} paths - An arbitrary amount of path segments.
  * @returns {String} the normalized and joined path.
  */
 TemplatePath.join = function (...paths) {
-  return normalize(path.join(...paths));
+  return TemplatePath.normalize(path.join(...paths));
 };
 
 /**
  * Joins the given URL path segments and normalizes the resulting path.
  * Maintains a single trailing slash if the last URL path argument
  * had at least one.
  *
- * @param {String[]} urlPaths
+ * @param {...String} urlPaths
  * @returns {String} a normalized URL path described by the given URL path segments.
  */
 TemplatePath.normalizeUrlPath = function (...urlPaths) {
@@ -128,7 +130,7 @@ TemplatePath.normalizeUrlPath = function (...urlPaths) {
  * Joins the given path segments. Since the first path is absolute,
  * the resulting path will be absolute as well.
  *
- * @param {String[]} paths
+ * @param {...String} paths
  * @returns {String} the absolute path described by the given path segments.
  */
 TemplatePath.absolutePath = function (...paths) {
@@ -180,7 +182,7 @@ TemplatePath.addLeadingDotSlashArray = function (paths) {
 /**
  * Adds a leading dot-slash segment to `path`.
  *
- * @param {String} path
+ * @param {String} pathArg
  * @returns {String}
  */
 TemplatePath.addLeadingDotSlash = function (pathArg) {
@@ -212,8 +214,8 @@ TemplatePath.stripLeadingDotSlash = function (path) {
 /**
  * Determines whether a path starts with a given sub path.
  *
- * @param {String} path A path
- * @param {String} subPath A path
+ * @param {String} path - A path
+ * @param {String} subPath - A path
  * @returns {Boolean} whether `path` starts with `subPath`.
  */
 TemplatePath.startsWithSubPath = function (path, subPath) {
@@ -227,31 +229,31 @@ TemplatePath.startsWithSubPath = function (path, subPath) {
  * Removes the `subPath` at the start of `path` if present
  * and returns the remainding path.
  *
- * @param {String} path A path
- * @param {String} subPath A path
+ * @param {String} path - A path
+ * @param {String} subPath - A path
  * @returns {String} the `path` without `subPath` at the start of it.
  */
 TemplatePath.stripLeadingSubPath = function (path, subPath) {
   path = TemplatePath.normalize(path);
   subPath = TemplatePath.normalize(subPath);
 
   if (subPath !== "." && path.startsWith(subPath)) {
-    return path.substr(subPath.length + 1);
+    return path.slice(subPath.length + 1);
   }
 
   return path;
 };
 
 /**
- * @param {String} path A path
+ * @param {String} path - A path
  * @returns {Boolean} whether `path` points to an existing directory.
  */
 TemplatePath.isDirectorySync = function (path) {
   return fs.existsSync(path) && fs.statSync(path).isDirectory();
 };
 
 /**
- * @param {String} path A path
+ * @param {String} path - A path
  * @returns {Boolean} whether `path` points to an existing directory.
  */
 TemplatePath.isDirectory = async function (path) {
@@ -325,7 +327,7 @@ TemplatePath.getExtension = function (thePath) {
  * Removes the extension from a path.
  *
  * @param {String} path
- * @param {String} extension
+ * @param {String} [extension]
  * @returns {String}
  */
 TemplatePath.removeExtension = function (path, extension = undefined) {
@@ -347,6 +349,7 @@ TemplatePath.removeExtension = function (path, extension = undefined) {
  * e.g. `./my/dir/` stays `./my/dir/` on *nix and becomes `.\\my\\dir\\` on Windows
  *
  * @param {String} filePath
+ * @param {String} [sep="/"]
  * @returns {String} a file path with the correct local directory separator.
  */
 TemplatePath.normalizeOperatingSystemFilePath = function (filePath, sep = "/") {
@@ -359,6 +362,7 @@ TemplatePath.normalizeOperatingSystemFilePath = function (filePath, sep = "/") {
  * e.g. `./my/dir/` stays `./my/dir/` on *nix and becomes `.\\my\\dir\\` on Windows
  *
  * @param {String} filePath
+ * @param {String} [sep="/"]
  * @returns {String} a file path with the correct local directory separator.
  */
 TemplatePath.standardizeFilePath = function (filePath, sep = "/") {