Bug: Docify Error When Following Getting Started Docs

[aidanm3341]

Bug Report

Steps to Reproduce:

1. Install Node v22.12.0
2. Follow the steps in the getting started guide https://calm.finos.org/quick-start/#-how-to-docify-your-architecture

Expected Result:

Docify creates and starts a docusaurus page

Actual Result:

Error:

> docusaurus start

[INFO] Starting the development server...
(node:61683) ExperimentalWarning: CommonJS module /private/tmp/architecture-as-code/calm/getting-started/website/docusaurus.config.js is loading ES Module /private/tmp/architecture-as-code/calm/getting-started/website/src/remark/remark-replace-links.js using require().
Support for loading ES Module in require() is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)

[ERROR] ReferenceError: module is not defined
    at file:///private/tmp/architecture-as-code/calm/getting-started/website/src/remark/remark-replace-links.js:3:1
    at ModuleJobSync.runSync (node:internal/modules/esm/module_job:395:35)
    at ModuleLoader.importSyncForRequire (node:internal/modules/esm/loader:329:47)
    at loadESMFromCJS (node:internal/modules/cjs/loader:1414:24)
    at Module._compile (node:internal/modules/cjs/loader:1547:5)
    at Object..js (node:internal/modules/cjs/loader:1708:10)
    at Module.load (node:internal/modules/cjs/loader:1318:32)
    at Function._load (node:internal/modules/cjs/loader:1128:12)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:219:24)
[INFO] Docusaurus version: 3.8.1
Node version: v22.12.0

Environment:

Node v22.12.0

[LeighFinegold]

Was able to replicate the issue on v22.12.0 but not v22.11.0 and v22.13.0

This error comes from Node.js’s shifting CommonJS ↔ ESM loader behavior

1. v22.12.0

   • Un-flagged the experimental require(esm) loader so you could synchronously require() an ES module without any flags.
   • ES-format files no longer expose a module/exports binding when loaded via require().
   • 👉 https://nodejs.org/en/blog/release/v22.12.0/#esm-loader-unflagged

2. v22.13.0

   • Rolled back the above change—you once again need --experimental-require-module (or equivalent) to require() ES modules.
   • 👉 https://nodejs.org/en/blog/release/v22.13.0/

Because plugin file (remark-replace-links.js) is authored as an ES module, Docusaurus’s require() call in v22.12 sees it as ESM without any CommonJS bindings hence the failure above.

This will break in node 23.0 so will look into a more permanent fix by just changing it to generate a .cjs file or better, rewrite the file in ESM.