Merge pull request #276 from webpack/feature/prefer-absolute

add preferAbsolute option to prefer absolute paths over roots

Author: sokra

README.md

@@ -96,6 +96,7 @@ myResolver.resolve({}, lookupStartPath, request, resolveContext, (
 | resolver         | undefined                   | A prepared Resolver to which the plugins are attached                                                                                                     |
 | resolveToContext | false                       | Resolve to a context instead of a file                                                                                                                    |
 | preferRelative   | false                       | Prefer to resolve module requests as relative request and fallback to resolving as module                                                                 |
+| preferAbsolute   | false                       | Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots                                                          |
 | restrictions     | []                          | A list of resolve restrictions                                                                                                                            |
 | roots            | []                          | A list of root paths                                                                                                                                      |
 | symlinks         | true                        | Whether to resolve symlinks to their symlinked location                                                                                                   |

lib/ResolverFactory.js

@@ -75,6 +75,7 @@ const UseFilePlugin = require("./UseFilePlugin");
  * @property {(string|RegExp)[]=} restrictions A list of resolve restrictions
  * @property {boolean=} useSyncFileSystemCalls Use only the sync constiants of the file system calls
  * @property {boolean=} preferRelative Prefer to resolve module requests as relative requests before falling back to modules
+ * @property {boolean=} preferAbsolute Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots
  */
 
 /**
@@ -104,6 +105,7 @@ const UseFilePlugin = require("./UseFilePlugin");
  * @property {boolean} resolveToContext
  * @property {Set<string|RegExp>} restrictions
  * @property {boolean} preferRelative
+ * @property {boolean} preferAbsolute
  */
 
 /**
@@ -113,7 +115,7 @@ const UseFilePlugin = require("./UseFilePlugin");
 function processPnpApiOption(option) {
 	if (
 		option === undefined &&
-		/** @type {NodeJS.ProcessVersions & {pnp: string}} */ (versions).pnp
+		/** @type {NodeJS.ProcessVersions & {pnp: string}} */ versions.pnp
 	) {
 		// @ts-ignore
 		return require("pnpapi"); // eslint-disable-line node/no-missing-require
@@ -222,6 +224,7 @@ function createOptions(options) {
 		fullySpecified: options.fullySpecified || false,
 		resolveToContext: options.resolveToContext || false,
 		preferRelative: options.preferRelative || false,
+		preferAbsolute: options.preferAbsolute || false,
 		restrictions: new Set(options.restrictions)
 	};
 }
@@ -254,6 +257,7 @@ exports.createResolver = function (options) {
 		pnpApi,
 		resolveToContext,
 		preferRelative,
+		preferAbsolute,
 		symlinks,
 		unsafeCache,
 		resolver: customResolver,
@@ -364,10 +368,13 @@ exports.createResolver = function (options) {
 			"internal"
 		)
 	);
+	if (preferAbsolute) {
+		plugins.push(new JoinRequestPlugin("after-normal-resolve", "relative"));
+	}
 	if (roots.size > 0) {
 		plugins.push(new RootsPlugin("after-normal-resolve", roots, "relative"));
 	}
-	if (!preferRelative) {
+	if (!preferRelative && !preferAbsolute) {
 		plugins.push(new JoinRequestPlugin("after-normal-resolve", "relative"));
 	}
 

test/roots.js

@@ -16,6 +16,26 @@ describe("roots", () => {
 		fileSystem
 	});
 
+	const resolverPreferAbsolute = ResolverFactory.createResolver({
+		extensions: [".js"],
+		alias: {
+			foo: "/fixtures"
+		},
+		roots: [__dirname, fixtures],
+		fileSystem,
+		preferAbsolute: true,
+		plugins: [
+			{
+				apply(resolver) {
+					resolver.hooks.file.tap("Test", request => {
+						if (/test.fixtures.*test.fixtures/.test(request.path))
+							throw new Error("Simulate a fatal error in root path");
+					});
+				}
+			}
+		]
+	});
+
 	const contextResolver = ResolverFactory.createResolver({
 		roots: [__dirname],
 		fileSystem,
@@ -95,4 +115,19 @@ describe("roots", () => {
 			done();
 		});
 	});
+
+	it("should resolve an absolute path (prefer absolute)", done => {
+		resolverPreferAbsolute.resolve(
+			{},
+			fixtures,
+			path.join(fixtures, "b.js"),
+			{},
+			(err, result) => {
+				if (err) return done(err);
+				if (!result) throw new Error("No result");
+				result.should.equal(path.resolve(fixtures, "b.js"));
+				done();
+			}
+		);
+	});
 });

types.d.ts

@@ -204,6 +204,7 @@ declare interface ResolveOptions {
 	resolveToContext: boolean;
 	restrictions: Set<string | RegExp>;
 	preferRelative: boolean;
+	preferAbsolute: boolean;
 }
 declare abstract class Resolver {
 	fileSystem: FileSystem;
@@ -428,6 +429,11 @@ declare interface UserResolveOptions {
 	 * Prefer to resolve module requests as relative requests before falling back to modules
 	 */
 	preferRelative?: boolean;
+
+	/**
+	 * Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots
+	 */
+	preferAbsolute?: boolean;
 }
 declare function exports(
 	context?: any,