feat: add support for win32 paths

davakh · davakh · commit 773fe09628b7 · 2024-02-05T03:10:32.000+04:00
diff --git a/lib/DescriptionFilePlugin.js b/lib/DescriptionFilePlugin.js
@@ -63,8 +63,7 @@ module.exports = class DescriptionFilePlugin {
 									);
 								return callback();
 							}
-							const relativePath =
-								"." + path.slice(result.directory.length).replace(/\\/g, "/");
+							const relativePath = "." + path.slice(result.directory.length);
 							/** @type {ResolveRequest} */
 							const obj = {
 								...request,
diff --git a/lib/DescriptionFileUtils.js b/lib/DescriptionFileUtils.js
@@ -5,6 +5,7 @@
 
 "use strict";
 
+const path = require("path");
 const forEachBail = require("./forEachBail");
 
 /** @typedef {import("./Resolver")} Resolver */
@@ -185,12 +186,10 @@ function getField(content, field) {
  * @returns {string|null} parent directory or null
  */
 function cdUp(directory) {
-	if (directory === "/") return null;
-	const i = directory.lastIndexOf("/"),
-		j = directory.lastIndexOf("\\");
-	const p = i < 0 ? j : j < 0 ? i : i < j ? j : i;
-	if (p < 0) return null;
-	return directory.slice(0, p || 1);
+	if (directory === path.sep) return null;
+	const i = directory.lastIndexOf(path.sep);
+	if (i < 0) return null;
+	return directory.slice(0, i || 1);
 }
 
 exports.loadDescriptionFile = loadDescriptionFile;
diff --git a/lib/Resolver.js b/lib/Resolver.js
@@ -5,6 +5,7 @@
 
 "use strict";
 
+const nodePath = require("path");
 const { AsyncSeriesBailHook, AsyncSeriesHook, SyncHook } = require("tapable");
 const createInnerContext = require("./createInnerContext");
 const { parseIdentifier } = require("./util/identifier");
@@ -577,7 +578,7 @@ class Resolver {
 	 * @returns {boolean} true, if the path is a directory path
 	 */
 	isDirectory(path) {
-		return path.endsWith("/");
+		return path.endsWith(nodePath.sep);
 	}
 
 	/**
diff --git a/lib/ResolverFactory.js b/lib/ResolverFactory.js
@@ -235,7 +235,11 @@ function createOptions(options) {
 				: ["node_modules"],
 			item => {
 				const type = getType(item);
-				return type === PathType.Normal || type === PathType.Relative;
+				return (
+					type === PathType.Normal ||
+					type === PathType.RelativePosix ||
+					type === PathType.RelativeWin
+				);
 			}
 		),
 		mainFields,
diff --git a/lib/RestrictionsPlugin.js b/lib/RestrictionsPlugin.js
@@ -5,11 +5,12 @@
 
 "use strict";
 
+const path = require("path");
+
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
 
-const slashCode = "/".charCodeAt(0);
-const backslashCode = "\\".charCodeAt(0);
+const separatorCode = path.sep.charCodeAt(0);
 
 /**
  * @param {string} path path
@@ -20,7 +21,7 @@ const isInside = (path, parent) => {
 	if (!path.startsWith(parent)) return false;
 	if (path.length === parent.length) return true;
 	const charCode = path.charCodeAt(parent.length);
-	return charCode === slashCode || charCode === backslashCode;
+	return charCode === separatorCode;
 };
 
 module.exports = class RestrictionsPlugin {
diff --git a/lib/RootsPlugin.js b/lib/RootsPlugin.js
@@ -5,6 +5,7 @@
 
 "use strict";
 
+const path = require("path");
 const forEachBail = require("./forEachBail");
 
 /** @typedef {import("./Resolver")} Resolver */
@@ -35,7 +36,7 @@ class RootsPlugin {
 			.tapAsync("RootsPlugin", (request, resolveContext, callback) => {
 				const req = request.request;
 				if (!req) return callback();
-				if (!req.startsWith("/")) return callback();
+				if (!req.startsWith(path.sep)) return callback();
 
 				forEachBail(
 					this.roots,
diff --git a/lib/SelfReferencePlugin.js b/lib/SelfReferencePlugin.js
@@ -5,14 +5,15 @@
 
 "use strict";
 
+const path = require("path");
 const DescriptionFileUtils = require("./DescriptionFileUtils");
 
 /** @typedef {import("./Resolver")} Resolver */
 /** @typedef {import("./Resolver").JsonObject} JsonObject */
 /** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
 /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
 
-const slashCode = "/".charCodeAt(0);
+const separatorCode = path.sep.charCodeAt(0);
 
 module.exports = class SelfReferencePlugin {
 	/**
@@ -56,7 +57,7 @@ module.exports = class SelfReferencePlugin {
 				if (
 					req.startsWith(name) &&
 					(req.length === name.length ||
-						req.charCodeAt(name.length) === slashCode)
+						req.charCodeAt(name.length) === separatorCode)
 				) {
 					const remainingRequest = `.${req.slice(name.length)}`;
 					/** @type {ResolveRequest} */
diff --git a/lib/getPaths.js b/lib/getPaths.js
@@ -5,12 +5,14 @@
 
 "use strict";
 
+const nodePath = require("path");
+
 /**
  * @param {string} path path
  * @returns {{paths: string[], segments: string[]}}} paths and segments
  */
 module.exports = function getPaths(path) {
-	if (path === "/") return { paths: ["/"], segments: [""] };
+	if (path === nodePath.sep) return { paths: [nodePath.sep], segments: [""] };
 	const parts = path.split(/(.*?[\\/]+)/);
 	const paths = [path];
 	const segments = [parts[parts.length - 1]];
@@ -19,7 +21,7 @@ module.exports = function getPaths(path) {
 	for (let i = parts.length - 2; i > 2; i -= 2) {
 		paths.push(path);
 		part = parts[i];
-		path = path.substring(0, path.length - part.length) || "/";
+		path = path.substring(0, path.length - part.length) || nodePath.sep;
 		segments.push(part.slice(0, -1));
 	}
 	part = parts[1];
@@ -36,10 +38,8 @@ module.exports = function getPaths(path) {
  * @returns {string|null} basename or null
  */
 module.exports.basename = function basename(path) {
-	const i = path.lastIndexOf("/"),
-		j = path.lastIndexOf("\\");
-	const p = i < 0 ? j : j < 0 ? i : i < j ? j : i;
-	if (p < 0) return null;
-	const s = path.slice(p + 1);
+	const i = path.lastIndexOf(nodePath.sep);
+	if (i < 0) return null;
+	const s = path.slice(i + 1);
 	return s;
 };
diff --git a/lib/util/path.js b/lib/util/path.js
@@ -26,7 +26,8 @@ const winNormalize = path.win32.normalize;
 const PathType = Object.freeze({
 	Empty: 0,
 	Normal: 1,
-	Relative: 2,
+	RelativeWin: 6,
+	RelativePosix: 2,
 	AbsoluteWin: 3,
 	AbsolutePosix: 4,
 	Internal: 5
@@ -45,7 +46,9 @@ const getType = p => {
 			const c0 = p.charCodeAt(0);
 			switch (c0) {
 				case CHAR_DOT:
-					return PathType.Relative;
+					return path.sep.charCodeAt(0) === CHAR_SLASH
+						? PathType.RelativePosix
+						: PathType.RelativeWin;
 				case CHAR_SLASH:
 					return PathType.AbsolutePosix;
 				case CHAR_HASH:
@@ -60,8 +63,13 @@ const getType = p => {
 					const c1 = p.charCodeAt(1);
 					switch (c1) {
 						case CHAR_DOT:
+							return path.sep.charCodeAt(0) === CHAR_SLASH
+								? PathType.RelativePosix
+								: PathType.RelativeWin;
 						case CHAR_SLASH:
-							return PathType.Relative;
+							return PathType.RelativePosix;
+						case CHAR_BACKSLASH:
+							return PathType.RelativeWin;
 					}
 					return PathType.Normal;
 				}
@@ -88,10 +96,15 @@ const getType = p => {
 			const c1 = p.charCodeAt(1);
 			switch (c1) {
 				case CHAR_SLASH:
-					return PathType.Relative;
+					return PathType.RelativePosix;
+				case CHAR_BACKSLASH:
+					return PathType.RelativeWin;
 				case CHAR_DOT: {
 					const c2 = p.charCodeAt(2);
-					if (c2 === CHAR_SLASH) return PathType.Relative;
+
+					if (c2 === CHAR_SLASH) return PathType.RelativePosix;
+					if (c2 === CHAR_BACKSLASH) return PathType.RelativeWin;
+
 					return PathType.Normal;
 				}
 			}
@@ -127,12 +140,16 @@ const normalize = p => {
 			return p;
 		case PathType.AbsoluteWin:
 			return winNormalize(p);
-		case PathType.Relative: {
+		case PathType.RelativePosix: {
 			const r = posixNormalize(p);
-			return getType(r) === PathType.Relative ? r : `./${r}`;
+			return getType(r) === PathType.RelativePosix ? r : `./${r}`;
+		}
+		case PathType.RelativeWin: {
+			const r = winNormalize(p);
+			return getType(r) === PathType.RelativeWin ? r : `.\\${r}`;
 		}
 	}
-	return posixNormalize(p);
+	return path.normalize(p);
 };
 exports.normalize = normalize;
 
@@ -152,21 +169,29 @@ const join = (rootPath, request) => {
 	}
 	switch (getType(rootPath)) {
 		case PathType.Normal:
-		case PathType.Relative:
+			return path.sep.charCodeAt(0) === CHAR_SLASH
+				? posixNormalize(`${rootPath}/${request}`)
+				: winNormalize(`${rootPath}\\${request}`);
+		case PathType.RelativePosix:
 		case PathType.AbsolutePosix:
 			return posixNormalize(`${rootPath}/${request}`);
+		case PathType.RelativeWin:
 		case PathType.AbsoluteWin:
 			return winNormalize(`${rootPath}\\${request}`);
 	}
 	switch (requestType) {
 		case PathType.Empty:
 			return rootPath;
-		case PathType.Relative: {
+		case PathType.RelativePosix: {
+			const r = posixNormalize(rootPath);
+			return getType(r) === PathType.RelativePosix ? r : `./${r}`;
+		}
+		case PathType.RelativeWin: {
 			const r = posixNormalize(rootPath);
-			return getType(r) === PathType.Relative ? r : `./${r}`;
+			return getType(r) === PathType.RelativeWin ? r : `.\\${r}`;
 		}
 	}
-	return posixNormalize(rootPath);
+	return path.normalize(rootPath);
 };
 exports.join = join;
 
diff --git a/test/path.test.js b/test/path.test.js
@@ -1,4 +1,10 @@
-const { checkImportsExportsFieldTarget } = require("../lib/util/path");
+const path = require("path");
+const {
+	checkImportsExportsFieldTarget,
+	PathType,
+	getType,
+	normalize
+} = require("../lib/util/path");
 
 describe("checkImportsExportsFieldTarget", () => {
 	/**
@@ -27,3 +33,77 @@ describe("checkImportsExportsFieldTarget", () => {
 		});
 	});
 });
+
+describe("getPath", () => {
+	let pathSepDefault = path.sep;
+
+	afterAll(() => {
+		path.sep = pathSepDefault;
+	});
+
+	["win32", "posix"].forEach(platform => {
+		const relativePathType =
+			platform === "win32" ? "RelativeWin" : "RelativePosix";
+		const separator = platform === "win32" ? "\\" : "/";
+
+		it(`should resolve PathType.${relativePathType} for paths if path.sep is ${platform} (${separator})`, () => {
+			path.sep = separator;
+
+			expect(getType(".")).toBe(PathType[relativePathType]);
+			expect(getType("..")).toBe(PathType[relativePathType]);
+			expect(getType(`..${path.sep}`)).toBe(PathType[relativePathType]);
+			expect(getType(`..${path.sep}test${path.sep}index.js`)).toBe(
+				PathType[relativePathType]
+			);
+		});
+	});
+});
+
+describe("normalize", () => {
+	let pathSepDefault = path.sep;
+
+	afterEach(() => {
+		path.sep = pathSepDefault;
+	});
+
+	["win32", "posix"].forEach(platform => {
+		const separator = platform === "win32" ? "\\" : "/";
+
+		it(`should correctly normalize for relative/empty paths if path.sep is ${platform} (${separator})`, () => {
+			path.sep = separator;
+
+			expect(normalize("")).toBe("");
+			expect(
+				normalize(
+					`..${path.sep}hello${path.sep}world${path.sep}..${path.sep}test.js`
+				)
+			).toBe(`..${path.sep}hello${path.sep}test.js`);
+		});
+	});
+
+	it("should correctly normalize for PathType.AbsoluteWin", () => {
+		path.sep = "\\";
+
+		expect(
+			normalize(
+				`..${path.sep}hello${path.sep}world${path.sep}..${path.sep}test.js`
+			)
+		).toBe(`..${path.sep}hello${path.sep}test.js`);
+	});
+
+	it("should correctly normalize for PathType.AbsolutePosix", () => {
+		path.sep = "/";
+
+		expect(
+			normalize(
+				`..${path.sep}hello${path.sep}world${path.sep}..${path.sep}test.js`
+			)
+		).toBe(`..${path.sep}hello${path.sep}test.js`);
+	});
+
+	it("should correctly normalize for PathType.Normal", () => {
+		expect(normalize("enhancedResolve/lib/util/../index")).toBe(
+			"enhancedResolve/lib/index"
+		);
+	});
+});
