Switch to ESM (#2138)

Author: kibertoad

.oxlintrc.json

@@ -116,7 +116,7 @@
       }
     },
     {
-      "files": ["tests/bench/**/*.mjs"],
+      "files": ["tests/bench/**/*.js"],
       "rules": {
         "no-console": "off"
       }

.swcrc

@@ -1,11 +1,8 @@
 #!/usr/bin/env node
 
-import { createRequire } from 'node:module';
+import { loadTemplates, cli } from '../lib/precompiler.js';
 import yargs from 'yargs';
 
-const require = createRequire(import.meta.url);
-const Precompiler = require('../dist/cjs/precompiler');
-
 const parser = yargs(process.argv.slice(2))
   .usage('Precompile handlebar templates.\nUsage: $0 [template|directory]...')
   .help(false)
@@ -19,23 +16,6 @@ const parser = yargs(process.argv.slice(2))
     type: 'string',
     description: 'Source Map File',
   })
-  .option('a', {
-    type: 'boolean',
-    description: 'Exports amd style (require.js)',
-    alias: 'amd',
-  })
-  .option('c', {
-    type: 'string',
-    description: 'Exports CommonJS style, path to Handlebars module',
-    alias: 'commonjs',
-    default: null,
-  })
-  .option('h', {
-    type: 'string',
-    description: 'Path to handlebar.js (only valid for amd-style)',
-    alias: 'handlebarPath',
-    default: '',
-  })
   .option('k', {
     type: 'string',
     description: 'Known helpers',
@@ -117,7 +97,7 @@ const argv = parser.parseSync();
 argv.files = argv._;
 delete argv._;
 
-Precompiler.loadTemplates(argv, function (err, opts) {
+loadTemplates(argv, function (err, opts) {
   if (err) {
     throw err;
   }
@@ -127,7 +107,7 @@ Precompiler.loadTemplates(argv, function (err, opts) {
   } else {
     // cli() is async (returns a Promise), so errors would become unhandled
     // rejections. Re-throw via nextTick to surface them as uncaught exceptions.
-    Promise.resolve(Precompiler.cli(opts)).catch((error) => {
+    Promise.resolve(cli(opts)).catch((error) => {
       process.nextTick(() => {
         throw error;
       });

bin/handlebars.mjs bin/handlebars.jsbin/handlebars.mjs renamed to bin/handlebars.js

@@ -5,14 +5,18 @@ import {
   Visitor,
 } from '@handlebars/parser';
 
-import runtime from './handlebars.runtime';
+import runtime from './handlebars.runtime.js';
 
 // Compiler imports
-import AST from './handlebars/compiler/ast';
-import { Compiler, compile, precompile } from './handlebars/compiler/compiler';
-import JavaScriptCompiler from './handlebars/compiler/javascript-compiler';
+import AST from './handlebars/compiler/ast.js';
+import {
+  Compiler,
+  compile,
+  precompile,
+} from './handlebars/compiler/compiler.js';
+import JavaScriptCompiler from './handlebars/compiler/javascript-compiler.js';
 
-import noConflict from './handlebars/no-conflict';
+import noConflict from './handlebars/no-conflict.js';
 
 let _create = runtime.create;
 function create() {

eslint.config.mjs eslint.config.jseslint.config.mjs renamed to eslint.config.js

@@ -1,13 +1,13 @@
 import { Exception } from '@handlebars/parser';
-import * as base from './handlebars/base';
+import * as base from './handlebars/base.js';
 
 // Each of these augment the Handlebars object. No need to setup here.
-// (This is done to easily share code between commonjs and browse envs)
-import SafeString from './handlebars/safe-string';
-import * as Utils from './handlebars/utils';
-import * as runtime from './handlebars/runtime';
+// (This is done to easily share code between module systems and browser envs)
+import SafeString from './handlebars/safe-string.js';
+import * as Utils from './handlebars/utils.js';
+import * as runtime from './handlebars/runtime.js';
 
-import noConflict from './handlebars/no-conflict';
+import noConflict from './handlebars/no-conflict.js';
 
 // For compatibility and usage outside of module systems, make the Handlebars object a namespace
 function create() {
@@ -37,4 +37,15 @@ noConflict(inst);
 
 inst['default'] = inst;
 
+// Named re-exports for CJS interop.
+// See the comment in lib/index.js for the full explanation. In short:
+// require('handlebars/runtime').COMPILER_REVISION must be directly accessible
+// for tools like handlebars-loader that compare compiler and runtime revisions.
+export {
+  VERSION,
+  COMPILER_REVISION,
+  LAST_COMPATIBLE_COMPILER_REVISION,
+  REVISION_CHANGES,
+} from './handlebars/base.js';
+
 export default inst;

lib/handlebars.js

@@ -1,9 +1,9 @@
 import { Exception } from '@handlebars/parser';
-import { createFrame, extend, toString } from './utils';
-import { registerDefaultHelpers } from './helpers';
-import { registerDefaultDecorators } from './decorators';
-import logger from './logger';
-import { resetLoggedProperties } from './internal/proto-access';
+import { createFrame, extend, toString } from './utils.js';
+import { registerDefaultHelpers } from './helpers.js';
+import { registerDefaultDecorators } from './decorators.js';
+import logger from './logger.js';
+import { resetLoggedProperties } from './internal/proto-access.js';
 
 export const VERSION = '4.7.7';
 export const COMPILER_REVISION = 8;

lib/handlebars.runtime.js

@@ -1,56 +1,5 @@
-/* global define */
-import { isArray } from '../utils';
-
-let SourceNode;
-
-try {
-  /* v8 ignore next */
-  if (typeof define !== 'function' || !define.amd) {
-    // We don't support this in AMD environments. For these environments, we assume that
-    // they are running on the browser and thus have no need for the source-map library.
-    // The variable indirection prevents bundlers from statically resolving and bundling
-    // source-map (which requires Node-built-ins). The stub SourceNode below handles
-    // browser/bundled usage. Bundlers may emit a "Critical dependency" warning — this
-    // is expected and harmless.
-    let mod = 'source-map';
-    let SourceMap = require(mod);
-    SourceNode = SourceMap.SourceNode;
-  }
-  // oxlint-disable-next-line no-unused-vars -- Babel 5 requires named catch param
-} catch (err) {
-  /* NOP */
-}
-
-/* v8 ignore next -- tested but not covered due to dist build */
-if (!SourceNode) {
-  SourceNode = function (line, column, srcFile, chunks) {
-    this.src = '';
-    if (chunks) {
-      this.add(chunks);
-    }
-  };
-  /* v8 ignore next */
-  SourceNode.prototype = {
-    add: function (chunks) {
-      if (isArray(chunks)) {
-        chunks = chunks.join('');
-      }
-      this.src += chunks;
-    },
-    prepend: function (chunks) {
-      if (isArray(chunks)) {
-        chunks = chunks.join('');
-      }
-      this.src = chunks + this.src;
-    },
-    toStringWithSourceMap: function () {
-      return { code: this.toString() };
-    },
-    toString: function () {
-      return this.src;
-    },
-  };
-}
+import { isArray } from '../utils.js';
+import { SourceNode } from '#source-node';
 
 function castChunk(chunk, codeGen, loc) {
   if (isArray(chunk)) {

lib/handlebars/base.js

@@ -1,6 +1,6 @@
 import { Exception } from '@handlebars/parser';
-import { isArray, indexOf, extend } from '../utils';
-import AST from './ast';
+import { isArray, indexOf, extend } from '../utils.js';
+import AST from './ast.js';
 
 const slice = [].slice;
 

lib/handlebars/compiler/code-gen.js

@@ -1,7 +1,7 @@
 import { Exception } from '@handlebars/parser';
-import { COMPILER_REVISION, REVISION_CHANGES } from '../base';
-import { isArray } from '../utils';
-import CodeGen from './code-gen';
+import { COMPILER_REVISION, REVISION_CHANGES } from '../base.js';
+import { isArray } from '../utils.js';
+import CodeGen from './code-gen.js';
 
 function Literal(value) {
   this.value = value;