feat: conventional alias from npm package module foo/dist/lib/bar (or foo/dist/_favor_/lib/bar) to foo/bar

Author: 3cp

spec/trace.spec.js

@@ -128,7 +128,7 @@ test('trace transforms json', t => {
       contents: "define('text!foo/bar.json',function(){return \"{\\\"a\\\":1}\";});\n",
       sourceMap: undefined,
       moduleId: 'foo/bar.json',
-      defined: ['text!foo/bar.json'],
+      defined: 'text!foo/bar.json',
       deps: [],
       packageName: undefined,
       shimed: undefined
@@ -150,7 +150,7 @@ test('trace transforms text file', t => {
       contents: "define('text!foo/bar.html',function(){return \"<p></p>\";});\n",
       sourceMap: undefined,
       moduleId: 'foo/bar.html',
-      defined: ['text!foo/bar.html'],
+      defined: 'text!foo/bar.html',
       deps: [],
       packageName: undefined,
       shimed: undefined
@@ -288,3 +288,49 @@ test('trace supports cache', t => {
     t.end();
   });
 });
+
+test('trace traces npm js with dist alias', t => {
+  const unit = {
+    path: 'node_modules/foo/dist/bar.js',
+    contents: "define(['a','text!./b.css'],function() {});",
+    moduleId: 'foo/dist/bar',
+    packageName: 'foo'
+  }
+
+  trace(unit).then(traced => {
+    t.deepEqual(traced, {
+      path: 'node_modules/foo/dist/bar.js',
+      contents: "define('foo/dist/bar',['a','text!./b.css'],function() {});define('foo/bar',['foo/dist/bar'],function(m){return m;});\n",
+      sourceMap: undefined,
+      moduleId: 'foo/dist/bar',
+      defined: ['foo/dist/bar', 'foo/bar'],
+      deps: ['a', 'text!foo/dist/b.css'],
+      packageName: 'foo',
+      shimed: undefined
+    })
+    t.end();
+  });
+});
+
+test('trace traces npm html with dist alias', t => {
+  const unit = {
+    path: 'node_modules/foo/dist/cjs/bar.html',
+    contents: "<p></p>",
+    moduleId: 'foo/dist/cjs/bar.html',
+    packageName: 'foo'
+  }
+
+  trace(unit).then(traced => {
+    t.deepEqual(traced, {
+      path: 'node_modules/foo/dist/cjs/bar.html',
+      contents: "define('text!foo/dist/cjs/bar.html',function(){return \"<p></p>\";});\ndefine('text!foo/bar.html',['text!foo/dist/cjs/bar.html'],function(m){return m;});\n",
+      sourceMap: undefined,
+      moduleId: 'foo/dist/cjs/bar.html',
+      defined: ['text!foo/dist/cjs/bar.html', 'text!foo/bar.html'],
+      deps: [],
+      packageName: 'foo',
+      shimed: undefined
+    })
+    t.end();
+  });
+});

spec/transformers/alias.spec.js

@@ -23,15 +23,12 @@ test('alias creates aliases for js module', t => {
 
 test('alias creates aliases for other modules', t => {
   t.deepEqual(alias('from/id.json', 'to/id.json'), {
-    defined: ['text!from/id.json', 'from/id.json', 'json!from/id.json'],
-    contents: "define('text!from/id.json',['text!to/id.json'],function(m){return m;});\n" +
-              "define('from/id.json',['to/id.json'],function(m){return m;});\n" +
-              "define('json!from/id.json',['json!to/id.json'],function(m){return m;});\n"
+    defined: 'text!from/id.json',
+    contents: "define('text!from/id.json',['text!to/id.json'],function(m){return m;});\n"
   });
   t.deepEqual(alias('from/id.css', 'to/id.css'), {
-    defined: ['text!from/id.css', 'from/id.css'],
-    contents: "define('text!from/id.css',['text!to/id.css'],function(m){return m;});\n" +
-              "define('from/id.css',['to/id.css'],function(m){return m;});\n"
+    defined: 'text!from/id.css',
+    contents: "define('text!from/id.css',['text!to/id.css'],function(m){return m;});\n"
   });
   t.end();
 });

spec/transformers/text.spec.js

@@ -6,7 +6,7 @@ test('text wraps text into amd module', t => {
   const target = "define('text!a.html',function(){return \"<p></p>\";});\n";
 
   t.deepEqual(text('a.html', source), {
-    defined: ['text!a.html'],
+    defined: 'text!a.html',
     contents: target
   });
   t.end();

src/index.js

@@ -8,24 +8,7 @@ import stubModule from './stub-module';
 import {error, warn, stripJsExtension, resolvePackagePath, contentOrFile} from './shared';
 import * as cache from './cache/default';
 import path from 'path';
-
-function mergeTransformed(unit, transformed) {
-  if (transformed.defined) {
-    let newDefined = transformed.defined
-    if (!Array.isArray(newDefined)) newDefined = [newDefined];
-
-    if (!unit.defined) {
-      unit.defined = []
-    } else if (typeof unit.defined === 'string') {
-      unit.defined = [unit.defined];
-    }
-    unit.defined.push.apply(unit.defined, newDefined);
-  }
-
-  if (transformed.contents) {
-    unit.contents += transformed.contents;
-  }
-}
+import mergeTransformed from './transformers/merge';
 
 // Bundler does
 // 1. capture: capture units (unit is a file like object plus meta data)
@@ -168,7 +151,7 @@ export default class Bundler {
           return reader.readMain()
           .then(unit => this.capture(unit))
           .then(tracedUnit => {
-            this._createAliasToNpmResourceIfNeeded(tracedUnit, pkg.name);
+            this._ensureNpmMainAlias(tracedUnit, pkg.name);
           });
         }
       });
@@ -194,7 +177,7 @@ export default class Bundler {
     })
   }
 
-  _createAliasToNpmResourceIfNeeded(tracedUnit, id) {
+  _ensureNpmMainAlias(tracedUnit, id) {
     if (this._moduleId_done.has(id)) return;
 
     const defined = tracedUnit.defined;
@@ -212,7 +195,7 @@ export default class Bundler {
 
     // only create alias when defined id is not same as package name
     if (toId !== id && toId !== tracedUnit.packageName) {
-      let aliasResult = alias(id, toId);
+      const aliasResult = alias(id, toId);
       mergeTransformed(tracedUnit, aliasResult);
       this._addToDone(aliasResult.defined);
     }
@@ -296,7 +279,9 @@ export default class Bundler {
           .then(reader => resource ? reader.readResource(resource) : reader.readMain())
           .then(unit => this.capture(unit))
           .then(tracedUnit => {
-            this._createAliasToNpmResourceIfNeeded(tracedUnit, bareId);
+            if (!resource) {
+              this._ensureNpmMainAlias(tracedUnit, bareId);
+            }
           })
           .catch(err => {
             error(err);

src/trace.js

@@ -1,10 +1,15 @@
 'use strict';
+import alias from './transformers/alias';
 import text from './transformers/text';
 import cjsEs from './transformers/cjs-es';
 import defines from './transformers/defines';
-import {ext, resolveModuleId} from 'dumber-module-loader/dist/id-utils';
+import mergeTransformed from './transformers/merge';
+import {ext, parse, resolveModuleId} from 'dumber-module-loader/dist/id-utils';
 import {generateHash} from './shared';
 
+const DIST_FOLDERS = ['dist', 'dists', 'output', 'out', 'lib', 'libs'];
+const DIST_FAVORS = ['amd', 'cjs', 'commonjs', 'es2015', 'native-modules', 'umd'];
+
 // depsFinder is optional
 export default function (unit, opts = {}) {
   const {cache, depsFinder} = opts;
@@ -70,7 +75,9 @@ export default function (unit, opts = {}) {
     contents = defResult.contents;
     defined = defResult.defined;
     shimed = defResult.shimed;
-  } else if (extname !== '.wasm') {
+  } else if (extname === '.wasm') {
+    // TODO wasm
+  } else {
     // use text! for everything else including unknown extname
     sourceMap = undefined;
     let textResult = text(moduleId, contents);
@@ -102,6 +109,27 @@ export default function (unit, opts = {}) {
       shimed: shimed
     };
 
+    // conventional alias mainly for aurelia
+    // aurelia-foo/dist/cjs/bar -> aurelia-foo/bar
+
+    // only for npm file and defined a single module
+    if (packageName && typeof defined === 'string') {
+      const {parts, cleanId} = parse(unit.moduleId);
+      let toSkip = 0;
+
+      if (DIST_FOLDERS.indexOf(parts[1].toLowerCase()) !== -1) {
+        toSkip = 1;
+        if (parts.length > 3 && DIST_FAVORS.indexOf(parts[2].toLowerCase()) !== -1) {
+          toSkip = 2;
+        }
+      }
+
+      if (toSkip) {
+        const shortId = packageName + '/' + parts.slice(toSkip + 1).join('/');
+        mergeTransformed(traced, alias(shortId, cleanId));
+      }
+    }
+
     if (cache) {
       cache.setCache(hash, traced);
     }

src/transformers/alias.js

@@ -13,17 +13,9 @@ export default function (fromId, toId) {
 
   // if got ext, then ext is not .js, we need wrapper
   if (parsedFromId.ext) {
-    let defined = ['text!' + parsedFromId.bareId, parsedFromId.bareId];
+    let defined = 'text!' + parsedFromId.bareId;
     let contents = "define('text!" + parsedFromId.bareId + "',['text!" + parsedToId.bareId +
-                     "'],function(m){return m;});\n" +
-                     "define('" + parsedFromId.bareId + "',['" + parsedToId.bareId +
-                     "'],function(m){return m;});\n"
-
-    if (parsedFromId.ext === '.json') {
-      defined.push('json!' + parsedFromId.bareId);
-      contents += "define('json!" + parsedFromId.bareId + "',['json!" + parsedToId.bareId +
-                  "'],function(m){return m;});\n";
-    }
+                     "'],function(m){return m;});\n";
 
     return {
       defined: defined,

src/transformers/merge.js

@@ -0,0 +1,17 @@
+export default function (unit, transformed) {
+  if (transformed.defined) {
+    let newDefined = transformed.defined
+    if (!Array.isArray(newDefined)) newDefined = [newDefined];
+
+    if (!unit.defined) {
+      unit.defined = []
+    } else if (typeof unit.defined === 'string') {
+      unit.defined = [unit.defined];
+    }
+    unit.defined.push.apply(unit.defined, newDefined);
+  }
+
+  if (transformed.contents) {
+    unit.contents += transformed.contents;
+  }
+}

src/transformers/text.js

@@ -1,7 +1,7 @@
 // wrap html/svg/css into amd
 export default function (moduleId, contents) {
   return {
-    defined: ['text!' + moduleId],
+    defined: 'text!' + moduleId,
     contents:`define('text!${moduleId}',function(){return ${JSON.stringify(contents)};});\n`
   };
 }