fix(cli-bundler): correctly handle browser "." mapping

aurelia · Sep 16, 2020 · f2fc025 · f2fc025
1 parent 16a5a2a
commit f2fc025
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 0 deletions.
diff --git a/lib/build/dependency-description.js b/lib/build/dependency-description.js
@@ -51,6 +51,8 @@ exports.DependencyDescription = class {
 
     for (let i = 0, keys = Object.keys(browser); i < keys.length; i++) {
       let key = keys[i];
+      // leave {".": "dist/index.js"} for main replacement
+      if (key === '.') continue;
       let target = browser[key];
 
       let sourceModule = filePathToModuleId(key);

diff --git a/lib/build/utils.js b/lib/build/utils.js
@@ -191,6 +191,9 @@ function nodejsLoadAsDirectory(resourcePath) {
     if (typeof metadata.browser === 'string')  {
       // use package.json browser field if possible.
       metaMain = metadata.browser;
+    } else if (typeof metadata.browser === 'object' && typeof metadata.browser['.'] === 'string') {
+      // use package.json browser mapping {".": "dist/index.js"} if possible.
+      metaMain = metadata.browser['.'];
     } else if (typeof metadata.module === 'string' &&
       !(metadata.name && metadata.name.startsWith('aurelia-'))) {
       // prefer es module format over cjs, just like webpack.

diff --git a/spec/lib/build/dependency-description.spec.js b/spec/lib/build/dependency-description.spec.js
@@ -38,4 +38,16 @@ describe('The DependencyDescription', () => {
       './server/only': './shims/server-only'
     });
   });
+
+  it('gets browser replacement but leave . for main replacement', () => {
+    sut.metadata = {
+      browser: {
+        "readable-stream": "./lib/readable-stream-browser.js",
+        ".": "dist/jszip.min.js"
+      }
+    };
+    expect(sut.browserReplacement()).toEqual({
+      "readable-stream": "./lib/readable-stream-browser"
+    });
+  });
 });
diff --git a/spec/lib/build/util.spec.js → spec/lib/build/utils.spec.js b/spec/lib/build/util.spec.js → spec/lib/build/utils.spec.js
@@ -152,6 +152,30 @@ describe('the Utils.nodejsLoad function', () => {
     expect(Utils.nodejsLoad(path.resolve('foo', 'bar'))).toBe(path.resolve('foo', 'bar', 'lo.js'));
   });
 
+  it('load directory with package.json browser field', () => {
+    const fsConfig = {};
+    fsConfig[path.join('foo', 'bar', 'package.json')] = '{"main": "lo2.js", "browser": "lo.js"}';
+    fsConfig[path.join('foo', 'bar', 'lo.js')] = 'bar/lo.js';
+    mockfs(fsConfig);
+    expect(Utils.nodejsLoad(path.resolve('foo', 'bar'))).toBe(path.resolve('foo', 'bar', 'lo.js'));
+  });
+
+  it('load directory with package.json browser "." mapping', () => {
+    const fsConfig = {};
+    fsConfig[path.join('foo', 'bar', 'package.json')] = '{"main": "lo2.js", "browser": {".": "lo.js"}}';
+    fsConfig[path.join('foo', 'bar', 'lo.js')] = 'bar/lo.js';
+    mockfs(fsConfig);
+    expect(Utils.nodejsLoad(path.resolve('foo', 'bar'))).toBe(path.resolve('foo', 'bar', 'lo.js'));
+  });
+
+  it('load directory with package.json browser field', () => {
+    const fsConfig = {};
+    fsConfig[path.join('foo', 'bar', 'package.json')] = '{"main": "lo2.js", "module": "lo.js"}';
+    fsConfig[path.join('foo', 'bar', 'lo.js')] = 'bar/lo.js';
+    mockfs(fsConfig);
+    expect(Utils.nodejsLoad(path.resolve('foo', 'bar'))).toBe(path.resolve('foo', 'bar', 'lo.js'));
+  });
+
   it('load directory with package.json, case2', () => {
     const fsConfig = {};
     fsConfig[path.join('foo', 'bar', 'package.json')] = '{"main": "lo.js"}';