requirejs-esm 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ferdinand Prantl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,141 @@
+# ESM to AMD Plugin for RequireJS
+
+[![Latest version](https://img.shields.io/npm/v/requirejs-esm)
+ ![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].
+
+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.
+
+## Installation
+
+This module can be installed in your project using [NPM], [PNPM] or [Yarn]. Make sure, that you use [Node.js] version 6 or newer.
+
+```sh
+npm i -D requirejs-esm
+pnpm i -D requirejs-esm
+yarn add requirejs-esm
+```
+
+## Usage
+
+Add the following paths to the RequireJS configuration:
+
+```javascript
+paths: {
+  esm: 'node_modules/requirejs-esm/dist/plugin'
+}
+```
+
+Reference ESM source files files via the `esm!` plugin prefix:
+
+```javascript
+define(['esm!your-esm-module'], function (module) {
+  // ...
+});
+```
+
+You can use the ESM module format in modules loaded by the `esm!` plugin including the keyword `import` for loading nested dependencies. The plugin `esm!` has to be used only in the topmost `require` or `define` statement.
+
+This plugin transpiles only ESM source files. If it detects a statement calling functions `define`, `require` or `require.config` on the root level of the source file, it will return the text of the source file as-is. Source files, which are already AMD modules, are assumed to contain ES5 only.
+
+If you use the RequireJS optimizer `r.js`, you have to bundle the `esm` plugin without the compiling functionality by adding the following to the RequireJS build configuration:
+
+```js
+pragmasOnSave: {
+  excludeEsm: true // removes the transpiling code from esm.js
+}
+```
+
+See also a [demo] project:
+
+```sh
+npm start
+open http://localhost:8967/demo/normal.html
+```
+
+## Advanced
+
+You can customize the [default module name resolution] with the `resolvePath` key (see [resolvePath] for more information) to transpile only modules with a special file extension:
+
+```js
+// import * from 'es5module.js'  -> define(['es5module])
+// import * from 'es6module.mjs' -> define(['esm!es6module])
+fileExtension: '.mjs',
+resolvePath: function (sourcePath, currentFile, options, originalResolvePath) {
+  // Ignore paths with other plugins applied and the three built-in
+  // pseudo-modules of RequireJS.
+  if (sourcePath.includes('!') || sourcePath === 'require' ||
+      sourcePath === 'module' || sourcePath === 'exports') return
+
+  let lengthWithoutExtension = sourcePath.length - 3
+  if (sourcePath.lastIndexOf('.js') === lengthWithoutExtension) {
+    return sourcePath.substr(0, lengthWithoutExtension)
+  }
+  --lengthWithoutExtension
+  if (sourcePath.lastIndexOf('.mjs') === lengthWithoutExtension) {
+    return 'esm!' + sourcePath.substr(0, lengthWithoutExtension)
+  }
+}
+```
+
+The default implementation of `resolvePath` ensures that every JavaScript dependency will be converted:
+
+```js
+function (sourcePath) {
+  if (sourcePath.includes('!') || sourcePath === 'require' ||
+      sourcePath === 'module' || sourcePath === 'exports') return
+
+  return 'esm!' + sourcePath
+}
+```
+
+## Options
+
+The `esm` plugin supports configuration with the following defaults:
+
+```js
+{
+  esm: {
+    // Update paths of module dependencies.
+    resolvePath: func, // see above
+    // Allow using a different plugin alias than `esm` in the source code.
+    pluginName: 'esm',
+    // The file extension of source files to be transformed.
+    fileExtension: '.js',
+    // Skip modules already in the AMD format without trying to parse them.
+    // Module prefixes like "lib/vendor/" are accepted too. Skipped modules
+    // must have all their deep dependencies already transformed.
+    skipModules: [],
+    // 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
+  }
+}
+```
+
+## Contributing
+
+In lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code.
+
+## License
+
+Copyright (c) 2022 Ferdinand Prantl
+
+Licensed under the MIT license.
+
+[Babel]: https://babeljs.io/
+[RequireJS]: http://requirejs.org
+[RequireJS optimizer]: https://requirejs.org/docs/optimization.html
+[requirejs-babel7]: https://www.npmjs.com/package/requirejs-babel7
+[`requirejs`]: https://www.npmjs.com/package/requirejs
+[`@prantlf/requirejs`]: https://www.npmjs.com/package/@prantlf/requirejs
+[Node.js]: http://nodejs.org/
+[NPM]: https://www.npmjs.com/
+[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
+[resolvePath]: https://github.com/tleunen/babel-plugin-module-resolver/blob/master/DOCS.md#resolvepath

package/bin/esm2requirejs.js

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+
+// Require module dependencies.
+const commander = require('commander')
+const glob = require('tiny-glob')
+const { readFile, writeFile } = require('fs/promises')
+const { transform } = require('../dist/api')
+
+// Define the command-line interface.
+commander.description('Transforms an ESM module to AMD or adapts an AMD module for requirejs-esm.')
+  .name('esm2requirejs')
+  .usage('[options] <files>')
+  // .option('-e, --ecma <version>', 'change the ECMAScript version from 2020 to other one')
+  .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')
+  .on('--help', function () {
+    console.log()
+    console.log('You can use one or more file names or one or more glob patterns to specify one')
+    console.log('or more files. If you set the plugin name to an empty string, modules already')
+    console.log('in the AMD format will be left intact.')
+    console.log()
+    console.log('Examples:')
+    console.log()
+    console.log('  $ esm2requirejs -s -o out/main.js src/main.js')
+    console.log('  $ esm2requirejs -p \'\' -r \'src/**/*.js\'')
+  })
+  .parse(process.argv)
+
+const {
+  /*ecma: ecmaVersion,*/ plugin: pluginName, /*minify,*/ sourceMap, output: outputFile, rewrite, verbose
+} = commander.opts()
+const { args } = commander;
+if (!args.length) {
+  commander.help()
+}
+
+// Main entry point.
+(async function () {
+  try {
+    const files = (await Promise.all(args.map(arg => glob(arg)))).flat()
+    if (!files.length) {
+      throw new Error('no files found')
+    }
+    for (const file of files) {
+      const text = await readFile(file, 'utf8')
+      const code = transform(text, file, { /*ecmaVersion,*/ pluginName, /*minify,*/ sourceMap })
+      if (outputFile) {
+        await writeFile(outputFile, code)
+      } else if (rewrite) {
+        await writeFile(file, code)
+      } else {
+        console.log(`// ${file}\n\n${code}`)
+      }
+    }
+  } catch (error) {
+    console.error((!verbose && error.message) || error)
+    process.exitCode = 1
+  }
+}());