Fix ES modules importing (#70)

* Fix ES modules importing (backport of #68) * Add trunk branches to GH Workflow (backport of #71)
ogonkov · Jun 28, 2020 · bf6e92a · bf6e92a
1 parent aa48536
commit bf6e92a
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 43 deletions.
diff --git a/.github/workflows/nodejs.yml → .github/workflows/tests.yml b/.github/workflows/nodejs.yml → .github/workflows/tests.yml
@@ -1,13 +1,17 @@
 # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: Node.js CI
+name: Tests
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
+      - trunk-v*
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+      - trunk-v*
 
 jobs:
   tests:

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![npm package][npm-image]][npm-url] 
 [![Coverage Status][coverage-image]][coverage-url] 
 [![node][node]][node-url] 
-![Build Status][build-image] 
+[![Build Status][build-image]][build-url] 
 [![Dependencies Status][david-image]][david-url]
 
 # Nunjucks templates loader for Webpack
@@ -341,9 +341,9 @@ module.exports = {
 
 **app/global-env.js**
 ```js
-module.exports = function(foo, bar) {
+export default function globalFn(foo, bar) {
     return `Do anything with ${foo} and ${bar}`;
-};
+}
 ```
 
 ### extensions
@@ -376,13 +376,13 @@ module.exports = {
 **lib/extensions/custom-extension.js**
 ```js
 // You should use slim bundle to make it work in browser
-const nunjucks = require('nunjucks/browser/nunjucks-slim');
+import nunjucks from 'nunjucks/browser/nunjucks-slim';
 
 // See example in docs
 // https://mozilla.github.io/nunjucks/api.html#custom-tags
 class CustomExtension {}
 
-module.exports = new CustomExtension();
+export default new CustomExtension();
 ```
 
 Loader trying to guess which extensions are really used, and keep only required
@@ -419,9 +419,9 @@ module.exports = {
 **foo.js**
 
 ```js
-module.exports = function(val, param) {
+export default function filter(val, param) {
     return `${val + param}`;
-};
+}
 ```
 
 **template.njk**
@@ -435,13 +435,13 @@ To mark filter as async, filter module should export `async` flag:
 **async-filter.js**
 
 ```js
-module.exports = function(val, param, callback) {
+export default function asyncFilter(val, param, callback) {
     setTimeout(function() {
         callback(null, val + param);
     }, 1000);
-};
+}
 
-module.exports.async = true;
+asyncFilter.async = true;
 ```
 
 [nunjucks-github]:https://github.com/mozilla/nunjucks
@@ -457,10 +457,11 @@ module.exports.async = true;
 
 [npm-image]:https://img.shields.io/npm/v/simple-nunjucks-loader.svg
 [npm-url]:http://npmjs.org/package/simple-nunjucks-loader
-[coverage-image]:https://coveralls.io/repos/github/ogonkov/nunjucks-loader/badge.svg?branch=master
-[coverage-url]:https://coveralls.io/github/ogonkov/nunjucks-loader?branch=master
+[coverage-image]:https://coveralls.io/repos/github/ogonkov/nunjucks-loader/badge.svg?branch=trunk-v1
+[coverage-url]:https://coveralls.io/github/ogonkov/nunjucks-loader?branch=trunk-v1
 [node]: https://img.shields.io/node/v/simple-nunjucks-loader.svg
 [node-url]: https://nodejs.org
-[build-image]:https://github.com/ogonkov/nunjucks-loader/workflows/Node.js%20CI/badge.svg
+[build-image]:https://github.com/ogonkov/nunjucks-loader/workflows/Tests/badge.svg?branch=trunk-v1
+[build-url]:https://github.com/ogonkov/nunjucks-loader/actions?query=branch%3Atrunk-v1+workflow%3ATests
 [david-image]:https://david-dm.org/ogonkov/nunjucks-loader/status.svg
 [david-url]:https://david-dm.org/ogonkov/nunjucks-loader
diff --git a/src/output/get-extensions.js b/src/output/get-extensions.js
@@ -1,18 +1,20 @@
 import {stringifyRequest} from 'loader-utils';
+import {getModuleOutput} from './get-module-output';
 
 export function getExtensions(extensions) {
     function imports(loaderContext) {
-        return extensions.map(([name, importPath]) => (
-            `
-                var _extension_${name} = require(${stringifyRequest(
-                    loaderContext,
-                    importPath
-                )});
-                __nunjucks_module_dependencies__.extensions['${name}'] = {
-                    module: _extension_${name}
-                };
-            `
-        )).join('');
+        return extensions.map(([name, importPath]) => {
+            const importVar = `_extension_${name}`;
+
+            return `
+            var ${importVar} = require(${stringifyRequest(
+                loaderContext,
+                importPath
+            )});
+            __nunjucks_module_dependencies__.extensions['${name}'] = {
+                module: ${getModuleOutput(importVar)}
+            };`;
+        }).join('');
     }
 
     return {

diff --git a/src/output/get-filters.js b/src/output/get-filters.js
@@ -1,17 +1,21 @@
 import {stringifyRequest} from 'loader-utils';
+import {getModuleOutput} from './get-module-output';
 
 export function getFilters(filters) {
     function imports(loaderContext) {
-        return filters.map(([filterName, importPath, filterInstance]) => (`
-            var _filter_${filterName} = require(${stringifyRequest(
+        return filters.map(([filterName, importPath, filterInstance]) => {
+            const importVar = `_filter_${filterName}`;
+
+            return `
+            var ${importVar} = require(${stringifyRequest(
                 loaderContext,
                 importPath
             )});
             __nunjucks_module_dependencies__.filters['${filterName}'] = {
-                module: _filter_${filterName},
+                module: ${getModuleOutput(importVar)},
                 async: ${JSON.stringify(filterInstance.async === true)}
-            };
-        `)).join('');
+            };`;
+        }).join('');
     }
 
     return {

diff --git a/src/output/get-globals.js b/src/output/get-globals.js
@@ -1,18 +1,20 @@
 import {toVar} from '../utils/to-var';
 import {stringifyRequest} from 'loader-utils';
+import {getModuleOutput} from './get-module-output';
 
 export function getGlobals(globals) {
     function imports(loaderContext) {
-        return globals.map(([globalImport, globalPath]) => (
-            `
-                var _global_${toVar(globalImport)} = require(${
-                    stringifyRequest(loaderContext,globalPath)
-                });
-                __nunjucks_module_dependencies__.globals['${globalImport}'] = {
-                    module: _global_${toVar(globalImport)}
-                };
-            `
-        )).join('')
+        return globals.map(([globalImport, globalPath]) => {
+            const importVar = `_global_${toVar(globalImport)}`;
+
+            return `
+            var ${importVar} = require(${
+                stringifyRequest(loaderContext, globalPath)
+            });
+            __nunjucks_module_dependencies__.globals['${globalImport}'] = {
+                module: ${getModuleOutput(importVar)}
+            };`;
+        }).join('')
     }
 
     return {

diff --git a/src/output/get-module-output.js b/src/output/get-module-output.js
@@ -0,0 +1,3 @@
+export function getModuleOutput(importedSymbol) {
+    return `${importedSymbol} && ${importedSymbol}.default || ${importedSymbol}`;
+}
diff --git a/src/precompile/get-addons-meta.js b/src/precompile/get-addons-meta.js
@@ -1,10 +1,12 @@
+import {getModule} from '../utils/get-module';
+
 /**
  * @param {[string, string]} addonEntry
  * @return {Promise<[string, string, function]>}
  */
 function loadAddon([name, importPath]) {
     return import(importPath).then(function(instance) {
-        return [name, importPath, instance];
+        return [name, importPath, getModule(instance)];
     });
 }