requirejs-esm 4.2.0 → 4.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "requirejs-esm",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "description": "A RequireJS plugin converting JavaScript modules from ESM to AMD.",
   "author": "Ferdinand Prantl <prantlf@gmail.com>",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "demo:local": "npm run optimize:local && npm run minify:local",
     "optimize:local": "r.js -o demo-local/build.config.js",
     "minify:local": "terser -cm --ecma 2018 --comments false --source-map content=demo-local/main-built.js.map --source-map includeSources --source-map url=main-built.min.js.map -o demo-local/main-built.min.js demo-local/main-built.js",
-    "lint": "eslint src bin perf/*.js bin test/*.js",
+    "lint": "biome lint src bin perf/*.js bin test/*.js",
     "fix": "npm run lint -- --fix",
     "check": "tehanu test/*.js",
     "cover": "c8 node test && c8 --no-clean ./bin/esm2requirejs.js && c8 --no-clean ./bin/esm2requirejs.js test/input/esm-import-all.js && c8 --no-clean ./bin/esm2requirejs.js dummy || c8 report -r text -r lcov | grep -Ev '(\\.\\.\\.)|(index.mjs)|(source-map.js)|(base64-vlq.js)|(base64.js)|(binary-search.js)|(mapping-list.js)|(read-wasm-browser.js)|(url-browser.js)|(wasm.js)|(regexes.js)|(public-api.js)|(All files)' && c8 check-coverage",
@@ -71,27 +71,25 @@
     "@prantlf/convert-source-map": "^3.0.2",
     "astring": "^1.9.0",
     "charcodes": "^0.2.1",
-    "commander": "^14.0.2",
-    "meriyah": "^7.0.0",
+    "commander": "^14.0.3",
+    "meriyah": "^7.1.0",
     "punycode": "^2.3.1",
     "source-map": "^0.8.0-beta.0",
     "tiny-glob": "^0.2.9"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.1",
-    "@prantlf/requirejs": "^3.3.1",
-    "@rollup/plugin-commonjs": "^29.0.0",
+    "@biomejs/biome": "^2.4.16",
+    "@prantlf/requirejs": "^3.4.0",
+    "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "c8": "^10.1.3",
-    "eslint": "^9.39.1",
-    "globals": "^16.5.0",
+    "c8": "^11.0.0",
     "lit-html": "^1",
-    "rollup": "^4.53.3",
+    "rollup": "^4.61.1",
     "tehanu": "^1.0.1",
     "tehanu-repo-coco": "^1.0.1",
     "tehanu-teru": "^1.0.1",
-    "terser": "^5.44.1"
+    "terser": "^5.48.0"
   },
   "keywords": [
     "requirejs-plugin",

package/src/api.d.ts

@@ -26,7 +26,10 @@ type OnAfterUpdate = (options: AmdOptions) => boolean
 interface TransformAstOptions {
   pluginName?: string /*= 'esm'' */
   resolvePath?: ResolvePath
+  skipIfNoImportExport?: boolean /*= false */
   useStrict?: boolean /*= true */
+  splitDefaultNamedDeclarations?: boolean /*= false */
+  sourceMap?: boolean /*= false */
   onBeforeTransform?: OnBeforeTransform
   onAfterTransform?: OnAfterTransform
   onBeforeUpdate?: OnBeforeUpdate

package/src/api.js

@@ -1,3 +1,8 @@
 export { resolvePath } from './resolve-path'
 export { default as transform } from './transform'
-export { transformAst, detectDefinesOrRequires, detectImportsAndExports } from './transformer'
+export {
+  transformAst,
+  detectDefinesOrRequires,
+  detectImportsAndExports,
+  processOrSkipByComment
+} from './transformer'

package/src/fetch-text.js

@@ -21,7 +21,7 @@ if (typeof window !== 'undefined' && window.navigator && window.document) {
     xhr.send(null)
   }
 } else {
-  const { readFileSync } = require.nodeRequire ? require.nodeRequire('fs') : require('fs')
+  const { readFileSync } = require.nodeRequire ? require.nodeRequire('fs') : require('node:fs')
   fetchText = (path, callback) => {
     // Asynchronous reading is not possible during the build in the optimizer.
     try {

package/src/plugin.js

@@ -16,6 +16,8 @@ const {
   onlyAmd,
   // List of module names not to check and transform.
   skipModules = [],
+  // Assume AMD/UMD if there're no import or export statements.
+  skipIfNoImportExport,
   // Method to update paths of module dependencies, to prefix JavaScript module
   // name with `esm!`, above all.
   resolvePath,
@@ -23,6 +25,9 @@ const {
   // Do not insert `"use strict"` expression to the AMD modules. You'd set it
   // to `false` if your bundler inserts `"use strict"` to the outer scope.
   useStrict,
+  // Split `export default class A {}` to `class A {}; export default A`
+  // to trade easier AST manipulation for 100% code compatibility.
+  splitDefaultNamedDeclarations,
   // Boolean or object with booleans { inline, content }.
   sourceMap,
   // Enable console logging.
@@ -112,6 +117,8 @@ export default {
           resolvePath,
           /*ecmaVersion,*/
           useStrict,
+          skipIfNoImportExport,
+          splitDefaultNamedDeclarations,
           // Always produce the source maps when transpiling in the browser, otherwise
           // the debugging would me impossible. When building and bundling, check if
           // the source maps were enabled for the output.
@@ -156,7 +163,7 @@ export default {
       // compiled with esm refer it with that name and this stub will simplify
       // the module loading by skipping the plugin evaluation.
       write.asModule(`${pluginName}!${moduleName}`,
-        '\ndefine([\'' + moduleName + '\'], res => res);\n')
+        `\ndefine(['${moduleName}'], res => res);\n`)
     }
 //>>excludeEnd('excludeEsm')
   }

package/src/resolve-path.js

@@ -71,7 +71,7 @@ export function resolvePath (sourcePath, currentFile, { pluginName, needsResolve
   // mapped there using the `paths` of `map` configuration properties.
   if ((sourcePath.charAt(0) === '.' && (sourcePath.charAt(1) === '/' ||
        sourcePath.charAt(1) === '.' && sourcePath.charAt(2) === '/')) &&
-      !(needsResolve && needsResolve(sourcePath, currentFile))) {
+      !(needsResolve?.(sourcePath, currentFile))) {
     sourcePath = joinPath(parentDir(currentFile), sourcePath)
     if (sourcePath.endsWith('.js')) sourcePath = sourcePath.substring(0, sourcePath.length - 3)
   }

package/src/transform.js

@@ -4,7 +4,7 @@ import { parseModule } from 'meriyah'
 import { generate } from 'astring'
 import { SourceMapGenerator } from 'source-map'
 import convert from '@prantlf/convert-source-map'
-import { transformAst } from './transformer'
+import { transformAst, processOrSkipByComment } from './transformer'
 
 export default function transform(text, file, {
   // Allow using a different plugin alias than `esm` in the source code.
@@ -12,10 +12,15 @@ export default function transform(text, file, {
   // Method to update paths of module dependencies, to prefix JavaScript module
   // name with `esm!`, above all.
   resolvePath = originalResolvePath,
+  // Assume AMD/UMD if there're no import or export statements.
+  skipIfNoImportExport,
   // ecmaVersion = 2020,
   // Do not insert `"use strict"` expression to the AMD modules. You'd set it
   // to `false` if your bundler inserts `"use strict"` to the outer scope.
   useStrict,
+  // Split `export default class A {}` to `class A {}; export default A`
+  // to trade easier AST manipulation for 100% code compatibility.
+  splitDefaultNamedDeclarations,
   // 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,
@@ -26,8 +31,15 @@ export default function transform(text, file, {
   onBeforeUpdate,
   onAfterUpdate
 } = {}) {
+  const processOrSkip = processOrSkipByComment(text)
+  if (processOrSkip === false) {
+    return { code: text, map: null, updated: false }
+  } else if (processOrSkip === true) {
+    skipIfNoImportExport = undefined;
+  }
+
   // const ast = parse(text, { ecmaVersion, sourceType: 'module', locations: true })
-  let ast = parseModule(text, { next: true, loc: true })
+  const ast = parseModule(text, { next: true, loc: true })
 
   const options = {
     sourceFileName: file,
@@ -35,6 +47,8 @@ export default function transform(text, file, {
     resolvePath,
     originalResolvePath,
     useStrict,
+    skipIfNoImportExport,
+    splitDefaultNamedDeclarations,
     onBeforeTransform,
     onAfterTransform,
     onBeforeUpdate,

package/src/transformer/comments.js

@@ -0,0 +1,16 @@
+// Check if one of the first 10 lines shorter than 100 characters contains
+// "// requirejs-esm-skip-file" or // requirejs-esm-process-file".
+export function processOrSkipByComment(text) {
+  for (let start = 0, i = 0; i < 10; ++i) {
+    const endLine = text.indexOf('\n', start)
+    if (endLine < 0 || endLine > 100) break
+    const line = text.substring(start, endLine)
+    const comment = /^\s*\/\//.test(line)
+    if (!comment) break
+    const directive = /^\s*\/\/\s*requirejs-esm-(skip|process)-file\s*$/.exec(line)
+    if (directive) {
+      return directive[1] === 'process'
+    }
+    start = endLine + 1
+  }
+}

package/src/transformer/converters.js

@@ -5,7 +5,7 @@ import { isValidIdentifier } from './validators'
 import { isIdentifierChar } from './identifier'
 
 export function toIdentifier(input) {
-  input = input + ''
+  input = `${input}`
 
   let name = ''
   for (const c of input) {
@@ -14,9 +14,7 @@ export function toIdentifier(input) {
 
   name = name.replace(/^[-0-9]+/, '')
 
-  name = name.replace(/[-\s]+(.)?/g, function (match, c) {
-    return c ? c.toUpperCase() : ''
-  })
+  name = name.replace(/[-\s]+(.)?/g, (_match, c) => c ? c.toUpperCase() : '')
 
   if (!isValidIdentifier(name)) {
     name = `_${name}`

package/src/transformer/esm.js

@@ -87,6 +87,7 @@ export function transformEsmToAmd(program, options) {
     program
   })
 
+  const { splitDefaultNamedDeclarations } = options
   const { body } = program
   let { length } = body
 
@@ -148,47 +149,52 @@ export function transformEsmToAmd(program, options) {
 
       // expression after keyword default
       const { declaration } = statement
+      // export default X
       let exportValue = declaration
-      let needExportExpression = true
-
-      if (declaration.type === 'FunctionDeclaration') {
-        exportValue = toExpression(exportValue)
-      }
-      if (declaration.type === 'ClassDeclaration') {
-        exportValue = toExpression(exportValue)
-        // const classNode = exportValue
-
-        // if (classNode.id) {
-        //   body[i] = classNode
-
-        //   const className = identifier(classNode.id.name)
-        //   let exportStat
-        //   if (i + 1 === length && isOnlyDefaultExport) {
-        //     exportStat = returnStatement(identifier(className))
-        //     needReturnExport = false
-        //   } else {
-        //     exportStat = exportStatement(exportsVar, 'default', className)
-        //   }
-
-        //   program.pushContainer('body', [exportStat])
-        //   needExportExpression = false
-        // } else {
-        //   exportValue = toExpression(classNode)
-        // }
+      let keepDeclaration
+
+      if (declaration.type === 'FunctionDeclaration' ||
+          declaration.type === 'ClassDeclaration') {
+        const { id } = declaration
+        if (id && splitDefaultNamedDeclarations) {
+          // export default function X() {}
+          // export default class X {}
+          exportValue = identifier(declaration.id.name)
+          keepDeclaration = true
+        } else {
+          // export default function () {}
+          // export default class {}
+          exportValue = toExpression(declaration)
+        }
       }
 
-      if (needExportExpression) {
-        let exportStat
+      let exportStat
 
-        if (i + 1 === length && isOnlyDefaultExport) {
-          exportStat = returnStatement(exportValue)
-          needReturnExport = false
-        } else {
-          exportStat = exportStatement(exportsVar, 'default', exportValue)
-        }
+      if (i + 1 === length && isOnlyDefaultExport) {
+        exportStat = returnStatement(exportValue)
+        needReturnExport = false
+      } else {
+        exportStat = exportStatement(exportsVar, 'default', exportValue)
+      }
 
-        body[i] = exportStat
+      // This changes the original code by putting the name of the exported
+      // function or class to the module scope. Being able to access the class
+      // by name simplifies other AST manipulations, which would have to be more
+      // complicated. Or the developer would have to help the manipulator
+      // by separating the export expression to a declaration and an export
+      // of an identifier. Use it if it doesn't break your code.
+      //
+      // // original, the name X is not in the module scope
+      // export default class X {}
+      //
+      // // converted, the name X is in the module scope
+      // class X {}
+      // export default X
+      if (keepDeclaration) {
+        body.splice(i++, 0, declaration)
+        ++length
       }
+      body[i] = exportStat
     }
 
     // export {x as y}
@@ -244,7 +250,7 @@ export function transformEsmToAmd(program, options) {
           const importVar = generateUidIdentifier(exportSource.value, program)
           importVars.push(importVar)
 
-          for (let specifier of specifiers) {
+          for (const specifier of specifiers) {
             const { exported, local } = specifier
             const { name } = local
             let localName
@@ -318,6 +324,17 @@ export function transformEsmToAmd(program, options) {
     }
   }
 
+  // no imports and exports, do not wrap to AMD module, if AMD/UMD should be assumed
+  if (options.skipIfNoImportExport && !(importPaths.length || hasExport)) {
+    options.onAfterTransform?.({
+      ...options,
+      updated: false,
+      program,
+      callbackBody: body
+    })
+    return false
+  }
+
   // adding define wrapper
   if (hasExport && needReturnExport) {
     let returnStat
@@ -350,10 +367,13 @@ export function transformEsmToAmd(program, options) {
 
   options.onAfterTransform?.({
     ...options,
+    updated: true,
     program,
     callbackBody: body
   })
 
+  return true
+
   function addExportStatement({ exported, local }) {
     const asName = exported.name
     if (asName !== 'default') {

package/src/transformer/index.js

@@ -1,5 +1,6 @@
 import { detectDefinesOrRequires, updateAmdDeps, callAmdUpdateHooks } from './amd'
 import { detectImportsAndExports, transformEsmToAmd } from './esm'
+import { processOrSkipByComment } from './comments'
 
 export function transformAst(program, options = {}) {
   const amds = detectDefinesOrRequires(program)
@@ -14,10 +15,9 @@ export function transformAst(program, options = {}) {
       result.updated ||= updated
     }
   } else {
-    transformEsmToAmd(program, options)
-    result.updated = true
+    result.updated = transformEsmToAmd(program, options)
   }
   return result
 }
 
-export { detectDefinesOrRequires, detectImportsAndExports }
+export { detectDefinesOrRequires, detectImportsAndExports, processOrSkipByComment }

package/src/write-text.js

@@ -5,8 +5,8 @@ let writeText
 // Initialise the writeText variable with a function to write to a file.
 /* istanbul ignore if */
 if (!(typeof window !== 'undefined' && window.navigator && window.document)) {
-  const { writeFileSync, mkdirSync } = require.nodeRequire ? require.nodeRequire('fs') : require('fs')
-  const { dirname } = require.nodeRequire ? require.nodeRequire('path') : require('path')
+  const { writeFileSync, mkdirSync } = require.nodeRequire ? require.nodeRequire('fs') : require('node:fs')
+  const { dirname } = require.nodeRequire ? require.nodeRequire('path') : require('node:path')
   writeText = (path, content) => {
     mkdirSync(dirname(path), { recursive: true })
     writeFileSync(path, content)