Merge pull request #731 from marp-team/node-sea

Adopt Node SEA for building the standalone binary

Author: yhatt

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+### Change
+
+- Adopt [Node.js SEA](https://nodejs.org/api/single-executable-applications.html) for building the standalone binary ([#568](https://github.com/marp-team/marp-cli/issues/568), [#731](https://github.com/marp-team/marp-cli/pull/731))
+  - Now the standalone binary allows using ES Modules and `import()` in the engine and configuration file
+
 ## v4.4.1 - 2026-07-04
 
 ### Changed

README.md

@@ -518,7 +518,7 @@ The functional engine should export a function as the default export, which shou
 The function must return a class that inherits from Marpit, or an instance of a Marpit-based engine created with the constructor options passed as an argument.
 
 ```javascript
-// engine.mjs (ES modules)
+// engine.mjs
 import { MarpitBasedEngine } from 'marpit-based-engine'
 
 export default () => MarpitBasedEngine // Return a class inherited from Marpit
@@ -554,10 +554,6 @@ export default async (constructorOptions) => {
 }
 ```
 
-> [!WARNING]
->
-> Currently ES Modules can resolve only when using Marp CLI via Node.js. [The standalone binary](#standalone-binary) cannot resolve ESM. ([vercel/pkg#1291](https://github.com/vercel/pkg/issues/1291))
-
 #### `marp` getter property
 
 Marp CLI also exposes `marp` getter property to the parameter. It returns a prepared instance of the built-in Marp Core engine, so you can apply several customizations to Marp engine with simple declarations.
@@ -651,10 +647,6 @@ By default we use configuration file that is placed on current directory, but yo
 
 If you want to prevent looking up a configuration file, you can pass `--no-config-file` (`--no-config`) option.
 
-> [!WARNING]
->
-> Currently ES Modules can resolve only when using Marp CLI via Node.js. [The standalone binary](#standalone-binary) cannot resolve ESM. ([vercel/pkg#1291](https://github.com/vercel/pkg/issues/1291))
-
 ### Options
 
 | Key               |            Type             |        CLI option         | Description                                                                                                 |

jest.config.js

@@ -1,5 +1,4 @@
 const esModules = [
-  '@formatjs/intl-segmenter',
   '@sindresorhus/merge-streams',
   'ansi-regex',
   'array-union',

package-lock.json

@@ -59,7 +59,7 @@
     "prepack": "npm-run-all --parallel check:* lint:* test:coverage --parallel build types",
     "prepare": "npx --no patch-package || exit 0",
     "preversion": "run-p check:* lint:* test:coverage",
-    "standalone": "node -e \"fs.rmSync('bin',{recursive:true,force:true})\" && pkg -C gzip --out-path ./bin .",
+    "standalone": "node -e \"fs.rmSync('bin',{recursive:true,force:true})\" && pkg --sea -C Zstd --out-path ./bin .",
     "standalone:pack": "node ./scripts/pack.mjs",
     "test": "jest",
     "test:coverage": "jest --coverage",
@@ -72,7 +72,6 @@
     "@babel/preset-env": "^7.29.7",
     "@babel/preset-react": "^7.29.7",
     "@babel/preset-typescript": "^7.29.7",
-    "@formatjs/intl-segmenter": "^12.2.10",
     "@rollup/plugin-alias": "^6.0.0",
     "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-json": "^6.1.0",
@@ -114,7 +113,6 @@
     "fast-plist": "^0.1.3",
     "globals": "^17.7.0",
     "image-size": "^2.0.2",
-    "import-from": "^4.0.0",
     "import-meta-resolve": "^4.2.0",
     "is-inside-container": "^1.0.0",
     "is-wsl": "^3.1.1",

package.json

@@ -111,12 +111,6 @@ export default [
       'src/patch.ts', // CLI patch
       'src/prepare.ts', // CLI preparation
     ],
-    output: {
-      compact,
-      dir: 'lib',
-      exports: 'named',
-      format: 'cjs',
-      dynamicImportInCjs: false, // Required to avoid using `import()` that is incompatible with standalone binary
-    },
+    output: { compact, dir: 'lib', exports: 'named', format: 'cjs' },
   },
 ]

rollup.config.mjs

@@ -24,7 +24,9 @@ const packToTarGz = (binary) => {
   pack.entry({ name: binaryName, mode: 0o755 }, binary)
   pack.finalize()
 
-  return pack.pipe(zlib.createGzip())
+  return pack.pipe(
+    zlib.createGzip({ level: zlib.constants.Z_BEST_COMPRESSION })
+  )
 }
 
 // Clean up dist directory
@@ -69,7 +71,9 @@ if (os.includes('windows')) {
   fs.readFile(path.resolve(bin, 'marp-cli-win.exe'), (err, buffer) => {
     if (err) throw err
 
-    const pack = new ZipStream()
+    const pack = new ZipStream({
+      zlib: { level: zlib.constants.Z_BEST_COMPRESSION },
+    })
 
     pack.entry(buffer, { name: `${binaryName}.exe` })
     pack.finalize()

scripts/pack.mjs

@@ -1,19 +1,18 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import chalk from 'chalk'
-import { cosmiconfig, cosmiconfigSync } from 'cosmiconfig'
+import { cosmiconfig } from 'cosmiconfig'
 import { osLocale } from 'os-locale'
 import { availableFinders } from './browser/finder'
 import type { FinderName } from './browser/finder'
 import type { BrowserManagerConfig } from './browser/manager'
-import { info, warn, error as cliError } from './cli'
+import { info, warn } from './cli'
 import { ConvertType, type ConverterOption } from './converter'
 import { ResolvableEngine, ResolvedEngine } from './engine'
 import { keywordsAsArray } from './engine/meta-plugin'
 import { error, isError } from './error'
 import { TemplateOption } from './templates'
 import { Theme, ThemeSet } from './theme'
-import { isStandaloneBinary } from './utils/binary'
 import { isOfficialContainerImage } from './utils/container'
 import { debugConfig } from './utils/debug'
 
@@ -126,10 +125,6 @@ export class MarpCLIConfig {
     return conf
   }
 
-  static isESMAvailable() {
-    return ResolvedEngine.isESMAvailable()
-  }
-
   private constructor() {} // eslint-disable-line @typescript-eslint/no-empty-function
 
   browserManagerOption() {
@@ -435,9 +430,7 @@ export class MarpCLIConfig {
   }
 
   private async loadConf(confPath?: string) {
-    const explorer = MarpCLIConfig.isESMAvailable()
-      ? cosmiconfig(MarpCLIConfig.moduleName)
-      : cosmiconfigSync(MarpCLIConfig.moduleName)
+    const explorer = cosmiconfig(MarpCLIConfig.moduleName)
 
     try {
       const ret = await (async () => {
@@ -473,15 +466,6 @@ export class MarpCLIConfig {
 
       const isErr = isError(e)
 
-      if (isErr && e.code === 'ERR_REQUIRE_ESM') {
-        // Show reason why `require()` failed in the current context
-        if (isStandaloneBinary()) {
-          cliError(
-            'A standalone binary version of Marp CLI is currently not supported resolving ESM. Please consider using CommonJS, or trying to use Marp CLI via Node.js.'
-          )
-        }
-      }
-
       error(
         [
           'Could not find or parse configuration file.',

src/config.ts

@@ -3,11 +3,9 @@ import path from 'node:path'
 import url from 'node:url'
 import type { Marp } from '@marp-team/marp-core'
 import { Marpit } from '@marp-team/marpit'
-import importFrom from 'import-from'
 import { resolve as importMetaResolve } from 'import-meta-resolve'
 import { packageUp } from 'package-up'
-import { error, isError } from './error'
-import { isStandaloneBinary } from './utils/binary'
+import { error } from './error'
 import { debugEngine } from './utils/debug'
 
 type FunctionalEngine<T extends typeof Marpit = typeof Marpit> = (
@@ -47,8 +45,7 @@ export class ResolvedEngine<T extends Engine = Engine> {
 
         // Bundled Marp Core
         Object.assign(
-          // eslint-disable-next-line @typescript-eslint/no-require-imports -- import statement brings TypeError in the standalone binary
-          () => Promise.resolve(require('@marp-team/marp-core').Marp),
+          () => import('@marp-team/marp-core').then(({ Marp }) => Marp),
           { [preResolveAsyncSymbol]: true }
         ),
       ])
@@ -74,11 +71,11 @@ export class ResolvedEngine<T extends Engine = Engine> {
       if (typeof eng === 'string') {
         resolved =
           (from &&
-            (await this._silentImportOrRequire(
+            (await this._silentImport(
               eng,
               path.dirname(path.resolve(from))
             ))) ||
-          (await this._silentImportOrRequire(eng))
+          (await this._silentImport(eng))
       } else if (typeof eng === 'function' && eng[preResolveAsyncSymbol]) {
         resolved = await (eng as any)()
       } else {
@@ -121,21 +118,6 @@ export class ResolvedEngine<T extends Engine = Engine> {
     return require(pkgPath) as Record<string, any>
   }
 
-  static isESMAvailable() {
-    // Standalone binary that is built by pkg cannot import ESM module.
-    // https://github.com/vercel/pkg/issues/1291
-    return !isStandaloneBinary()
-  }
-
-  private static async _silentImportOrRequire<T = any>(
-    moduleId: string,
-    from?: string
-  ): Promise<T | null> {
-    if (this.isESMAvailable()) return this._silentImport(moduleId, from)
-
-    return this._silentRequire(moduleId, from)
-  }
-
   private static async _silentImport<T = any>(
     moduleId: string,
     from?: string
@@ -188,38 +170,6 @@ export class ResolvedEngine<T extends Engine = Engine> {
     }
   }
 
-  private static async _silentRequire<T = any>(
-    moduleId: string,
-    from?: string
-  ): Promise<T | null> {
-    try {
-      const resolvedFrom = from
-        ? path.dirname(path.resolve(from))
-        : process.cwd()
-
-      return importFrom(resolvedFrom, moduleId) as T | null
-
-      /* c8 ignore start */
-    } catch (e) {
-      debugEngine(
-        'Failed to require %s.',
-        moduleId + (from ? ` from ${from}` : '')
-      )
-      debugEngine('%O', e)
-
-      if (isError(e) && e.code === 'ERR_REQUIRE_ESM') {
-        // Show reason why `require()` failed in the current context
-        if (isStandaloneBinary()) {
-          error(
-            'A standalone binary version of Marp CLI is currently not supported resolving ESM. Please consider using CommonJS, or trying to use Marp CLI via Node.js.'
-          )
-        }
-      }
-      return null // Jest allows importing ESM via `require()` so this line cannot measure coverage.
-    }
-    /* c8 ignore stop */
-  }
-
   // NOTE: It cannot test because of overriding `require` in Jest context.
   /* c8 ignore start */
   private findClassPath(klass) {

src/engine.ts

@@ -1,10 +1,7 @@
 import module from 'node:module'
-import { isStandaloneBinary } from './utils/binary'
-import { debug } from './utils/debug'
 
 export const patcher = {
   patch: () => {
-    patcher.patchSegmenter()
     patcher.enableCompileCache()
   },
   enableCompileCache: () => {
@@ -15,14 +12,6 @@ export const patcher = {
       // no ops
     }
   },
-  patchSegmenter: () => {
-    // Avoid SEGFAULT in the standalone binary. pkg is using a Node.js build with small ICU.
-    // https://github.com/nodejs/node/issues/51752
-    if (isStandaloneBinary() && process.config.variables['icu_small']) {
-      debug('Using a polyfilled implementation for Intl.Segmenter.')
-      require('@formatjs/intl-segmenter/polyfill-force.js') // eslint-disable-line @typescript-eslint/no-require-imports
-    }
-  },
 }
 
 export const patch = () => patcher.patch()