requirejs-esm 0.0.1 → 1.0.0

package/README.md

@@ -4,7 +4,7 @@
  ![Dependency status](https://img.shields.io/librariesio/release/npm/requirejs-esm)
 ](https://www.npmjs.com/package/requirejs-esm)
 
-A [RequireJS] plugin converting JavaScript modules from ESM to AMD. It takes care only of the module format; it does not transpile the language and that is why it is a lot faster than plugins using [Babel]. If you need to transpile the code to an earlier ECMAScript version, have a look at [requirejs-babel7].
+A [RequireJS] plugin converting JavaScript modules from ESM to AMD. It takes care only of the module format; it does not transpile the language and that is why it is [a lot faster] than plugins using [Babel]. If you need to transpile the code to an earlier ECMAScript version, have a look at [requirejs-babel7].
 
 The official [RequireJS optimizer] (`r.js`) does not wire up source maps from the original (not transpiled) sources to the source map of the output bundle. It makes this or similar plugins unfeasible for serious work. If you want the proper support for source maps, replace the official optimizer package ([`requirejs`]) with the forked [`@prantlf/requirejs`], which is fixed.
 
@@ -111,11 +111,54 @@ The `esm` plugin supports configuration with the following defaults:
     // Enforce transpiling even if a optimized module has been loaded.
     mixedAmdAndEsm: false,
     // Suppress transpiling even if an optimized module has not been loaded yet.
-    onlyAmd: false
+    onlyAmd: false,
+    // Enable source maps, can be an object with booleans { inline, content }.
+    // If set to true, the object will be set to { inline: true, content: true }.
+    sourceMap: false,
+    // Enable console logging.
+    verbose: false,
+    // Save a copy of the transformed modules to a directory for debugging purposes.
+    debugDir: ''
   }
 }
 ```
 
+## API
+
+The transformation applied by the plugin can be performed programmatically too.
+
+```js
+const { transform } = require('requirejs-esm/dist/api')
+const { code }  = transform('import a from "a"', 'test', { sourceMap: true })
+```
+
+The `transform` method supports a subset of plugin options:
+
+```js
+{
+  // Update paths of module dependencies.
+  resolvePath: func,
+  // Allow using a different plugin alias than `esm` in the source code.
+  pluginName: 'esm',
+  // Enable source maps, can be an object with booleans { inline, content }.
+  // If set to true, the object will be set to { inline: true, content: true }.
+  sourceMap: false
+}
+```
+
+The returned object:
+
+```js
+{
+  // The transpiled module code.
+  code: '...',
+  // The source map if sourceMap.inline from the options above is false.
+  map: undefined | { ... },
+  // If the transpilation modified the original source text.
+  updated: false | true
+}
+```
+
 ## Contributing
 
 In lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code.
@@ -137,5 +180,6 @@ Licensed under the MIT license.
 [PNPM]: https://pnpm.io/
 [Yarn]: https://yarnpkg.com/
 [demo]: https://github.com/prantlf/requirejs-esm/tree/master/demo
-[default module name resolution]: https://github.com/prantlf/requirejs-esm/blob/master/esm.js#L38
+[default module name resolution]: https://github.com/prantlf/requirejs-esm/blob/master/src/resolve-path.js#L48
 [resolvePath]: https://github.com/tleunen/babel-plugin-module-resolver/blob/master/DOCS.md#resolvepath
+[a lot faster]: ./perf/README.md#readme

package/bin/esm2requirejs.js

@@ -14,9 +14,8 @@ commander.description('Transforms an ESM module to AMD or adapts an AMD module f
   .option('-p, --plugin <name>', 'change the plugin name from "esm" to other name')
   .option('-o, --output <file>', 'write the adapted module source to a file')
   .option('-r, --rewrite', 'rewrite the input files with the adapted output')
-  // .option('-m, --minify', 'minify the generated output')
   .option('-s, --source-map', 'write inline source maps to the adapted output')
-  .option('-v, --verbose', 'print call stack in case of error')
+  .option('-v, --verbose', 'print progress and call stack in case of error')
   .on('--help', function () {
     console.log()
     console.log('You can use one or more file names or one or more glob patterns to specify one')
@@ -31,9 +30,14 @@ commander.description('Transforms an ESM module to AMD or adapts an AMD module f
   .parse(process.argv)
 
 const {
-  /*ecma: ecmaVersion,*/ plugin: pluginName, /*minify,*/ sourceMap, output: outputFile, rewrite, verbose
+  /*ecma: ecmaVersion,*/
+  plugin: pluginName,
+  sourceMap,
+  output: outputFile,
+  rewrite,
+  verbose
 } = commander.opts()
-const { args } = commander;
+const { args } = commander
 if (!args.length) {
   commander.help()
 }
@@ -47,7 +51,12 @@ if (!args.length) {
     }
     for (const file of files) {
       const text = await readFile(file, 'utf8')
-      const code = transform(text, file, { /*ecmaVersion,*/ pluginName, /*minify,*/ sourceMap })
+      const code = transform(text, file, {
+        /*ecmaVersion,*/
+        pluginName,
+        sourceMap,
+        verbose
+      })
       if (outputFile) {
         await writeFile(outputFile, code)
       } else if (rewrite) {
@@ -60,4 +69,4 @@ if (!args.length) {
     console.error((!verbose && error.message) || error)
     process.exitCode = 1
   }
-}());
+}())

package/dist/api.js

@@ -85190,17 +85190,18 @@
     const { elements } = deps;
     if (!elements.length) return
 
+    let updated;
     for (const element of elements) {
       if (element.type === 'Literal') {
         const moduleName = element.value;
         const newModuleName = resolvePath(moduleName, parentName, options);
         if (newModuleName && newModuleName !== moduleName) {
           replaceLiteral(element, newModuleName);
+          updated = true;
         }
       }
     }
-
-    return true
+    return updated
   }
 
   function _generateUid(name, i) {
@@ -85609,7 +85610,6 @@
     // name with `esm!`, above all.
     resolvePath: resolvePath$1 = resolvePath,
     // ecmaVersion = 2020,
-    // minify,
     sourceMap
   } = {}) {
     // const ast = parse(text, { ecmaVersion, sourceType: 'module', locations: true })
@@ -85618,48 +85618,29 @@
     const options = { sourceFileName: file, pluginName, resolvePath: resolvePath$1, originalResolvePath: resolvePath };
     transformModules(ast, options);
 
-    let code;
-    if (options.updated) {
-      // if (minify) {
-      //   const optimized = optimize(ast)
-      //   ast = mangle(optimized)
-      // }
-      // if (minify) {
-      //   ({ code, map: sourceMap } = generateMinified(ast, {
-      //     format: FORMAT_MINIFY,
-      //     sourceMap: sourceMap ? file : undefined,
-      //     sourceMapWithCode: true,
-      //     sourceContent: text,
-      //     file
-      //   }))
-      //   if (sourceMap) {
-      //     code += convert.fromJSON(sourceMap).toComment()
-      //   }
-      // }
-      // if (minify) {
-      //   ({ code } = await generateMinified(ast, {
-      //     // ecma: ecmaVersion,
-      //     module: true,
-      //     parse: { spidermonkey: true },
-      //     format: { ecma: 2015 },
-      //     sourceMap: sourceMap ? {
-      //       filename: file,
-      //       url: 'inline'
-      //       // content: map
-      //     } : undefined
-      //   }))
-      // } else {
-      sourceMap = sourceMap && new SourceMapGenerator({ file });
-      code = generate(ast, { sourceMap });
+    const { updated } = options;
+    let code, map;
+    if (updated) {
+      if (sourceMap === true) {
+        sourceMap = { inline: true, content: true };
+      }
+      const mapGenerator = sourceMap ? new SourceMapGenerator({ file }) : undefined;
+      code = generate(ast, { sourceMap: mapGenerator });
       if (sourceMap) {
-        code += convertSourceMap.fromJSON(sourceMap).toComment();
+        if (sourceMap.content) {
+          mapGenerator.setSourceContent(file, text);
+        }
+        if (sourceMap.inline) {
+          code += convertSourceMap.fromObject(mapGenerator.toJSON()).toComment();
+        } else {
+          map = mapGenerator.toJSON();
+        }
       }
-      // }
     } else {
       code = text;
     }
 
-    return code
+    return { code, map, updated }
   }
 
   exports.resolvePath = resolvePath;