Merge pull request #277 from webpack/feature/prefer-absolute-4

add preferAbsolute option to prefer absolute paths over roots

Author: sokra

README.md

@@ -61,6 +61,7 @@ For more examples creating different types resolvers (sync/async, context, etc)
 | modules | ["node_modules"] | A list of directories to resolve modules from, can be absolute path or folder name |
 | roots | [] | A list of directories to resolve request starting with `/` from |
 | ignoreRootsErrors | false | Ignore fatal errors happening during handling of `roots` (allows to add `roots` without a breaking change) |
+| preferAbsolute | false | Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots |
 | unsafeCache | false | Use this cache object to unsafely cache the successful requests |
 | plugins | [] | A list of additional resolve plugins which should be applied |
 | symlinks | true | Whether to resolve symlinks to their symlinked location |

lib/ResolverFactory.js

@@ -85,6 +85,9 @@ exports.createResolver = function(options) {
 // Ignore errors happening when resolving roots
 const ignoreRootsErrors = options.ignoreRootsErrors || false;
 
+// Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots
+const preferAbsolute = options.preferAbsolute || false;
+
 const restrictions = options.restrictions || [];
 
 // Use this cache object to unsafely cache the successful requests
@@ -224,6 +227,9 @@ exports.createResolver = function(options) {
 plugins.push(new AliasFieldPlugin("described-resolve", item, "resolve"));
 });
 plugins.push(new ModuleKindPlugin("after-described-resolve", "raw-module"));
+if (preferAbsolute) {
+plugins.push(new JoinRequestPlugin("after-described-resolve", "relative"));
+}
 roots.forEach(root => {
 plugins.push(
 new RootPlugin(
@@ -234,7 +240,9 @@ exports.createResolver = function(options) {
 )
 );
 });
-plugins.push(new JoinRequestPlugin("after-described-resolve", "relative"));
+if (!preferAbsolute) {
+plugins.push(new JoinRequestPlugin("after-described-resolve", "relative"));
+}
 
 // raw-module
 moduleExtensions.forEach(item => {

test/roots.js

@@ -27,6 +27,26 @@ describe("roots", () => {
 ]
 });
 
+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,
@@ -107,7 +127,7 @@ describe("roots", () => {
 });
 });
 
-it("should resolve an absolute path", done => {
+it("should resolve an absolute path (ignore roots errors)", done => {
 resolver.resolve(
 {},
 fixtures,
@@ -121,4 +141,19 @@ describe("roots", () => {
 }
 );
 });
+
+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();
+}
+);
+});
 });