Merge pull request #39 from twlite/require-fix

Author: notunderctrl

apps/docs/pages/docs/commandkit.config.js-options.mdx

@@ -67,3 +67,7 @@ Whether or not to include sourcemaps in the production build. This is an optiona
 ### `antiCrash`: boolean
 
 Whether or not to inject anti-crash script in the production build. This is an optional option. The default value is `true`.
+
+### `requirePolyfill`: boolean
+
+Whether or not to polyfill `require` function. This is an optional option. The default value is `true`.

packages/commandkit/bin/build.mjs

@@ -1,6 +1,6 @@
 // @ts-check
 
-import { appendFile } from 'node:fs/promises';
+import { readFile, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { build } from 'tsup';
 import { Colors, erase, findCommandKitConfig, panic, write } from './common.mjs';
@@ -14,6 +14,7 @@ export async function bootstrapProductionBuild(config) {
         antiCrash = true,
         src,
         main,
+        requirePolyfill: polyfillRequire,
     } = await findCommandKitConfig(config);
 
     const status = ora('Creating optimized production build...\n').start();
@@ -39,7 +40,7 @@ export async function bootstrapProductionBuild(config) {
             entry: [src, '!dist', '!.commandkit', `!${outDir}`],
         });
 
-        await injectShims(outDir, main, antiCrash);
+        await injectShims(outDir, main, antiCrash, polyfillRequire);
 
         status.succeed(
             Colors.green(`Build completed in ${(performance.now() - start).toFixed(2)}ms!`),
@@ -55,14 +56,33 @@ export async function bootstrapProductionBuild(config) {
     }
 }
 
-async function injectShims(outDir, main, antiCrash) {
+export async function injectShims(outDir, main, antiCrash, polyfillRequire) {
     const path = join(process.cwd(), outDir, main);
 
+    const head = ['\n\n;await (async()=>{', "  'use strict';"].join('\n');
+    const tail = '\n})();';
+    const requireScript = polyfillRequire
+        ? [
+              '// --- CommandKit require() polyfill ---',
+              '  if (typeof require === "undefined") {',
+              '    const { createRequire } = await import("node:module");',
+              '    const __require = createRequire(import.meta.url);',
+              '    Object.defineProperty(globalThis, "require", {',
+              '      value: (id) => {',
+              '        return __require(id);',
+              '      },',
+              '      configurable: true,',
+              '      enumerable: false,',
+              '      writable: true,',
+              '    });',
+              '  }',
+              '// --- CommandKit require() polyfill ---',
+          ].join('\n')
+        : '';
+
     const antiCrashScript = antiCrash
         ? [
-              '\n\n// --- CommandKit Anti-Crash Monitor ---',
-              ';(()=>{',
-              "  'use strict';",
+              '// --- CommandKit Anti-Crash Monitor ---',
               "  // 'uncaughtException' event is supposed to be used to perform synchronous cleanup before shutting down the process",
               '  // instead of using it as a means to resume operation.',
               '  // But it exists here due to compatibility reasons with discord bot ecosystem.',
@@ -75,12 +95,12 @@ async function injectShims(outDir, main, antiCrash) {
               '    process.on(e2, (r) => {',
               '      l(p(`${b} Unhandled promise rejection`)); l(p(`${b} ${r.stack || r}`));',
               '    });',
-              '})();',
-              '// --- CommandKit Anti-Crash Monitor ---\n',
+              '// --- CommandKit Anti-Crash Monitor ---',
           ].join('\n')
         : '';
 
-    const finalScript = [antiCrashScript].join('\n');
+    const contents = await readFile(path, 'utf-8');
+    const finalScript = [head, requireScript, antiCrashScript, tail, '\n\n', contents].join('\n');
 
-    return appendFile(path, finalScript);
+    return writeFile(path, finalScript);
 }

packages/commandkit/bin/development.mjs

@@ -6,6 +6,7 @@ import { Colors, erase, findCommandKitConfig, panic, write } from './common.mjs'
 import { parseEnv } from './parse-env.mjs';
 import child_process from 'node:child_process';
 import ora from 'ora';
+import { injectShims } from './build.mjs';
 
 const RESTARTING_MSG_PATTERN = /^Restarting '|".+'|"\n?$/;
 const FAILED_RUNNING_PATTERN = /^Failed running '.+'|"\n?$/;
@@ -19,6 +20,7 @@ export async function bootstrapDevelopmentServer(opts) {
         envExtra = true,
         clearRestartLogs = true,
         outDir,
+        requirePolyfill,
     } = await findCommandKitConfig(opts.config);
 
     if (!src) {
@@ -61,6 +63,8 @@ export async function bootstrapDevelopmentServer(opts) {
             watch: watchMode,
         });
 
+        await injectShims('.commandkit', main, false, requirePolyfill);
+
         status.succeed(
             Colors.green(`Dev server started in ${(performance.now() - start).toFixed(2)}ms!\n`),
         );

packages/commandkit/src/config.ts

@@ -39,6 +39,10 @@ export interface CommandKitConfig {
      * Whether or not to include anti-crash handler in production. Defaults to `true`.
      */
     antiCrash: boolean;
+    /**
+     * Whether or not to polyfill `require` function. Defaults to `true`.
+     */
+    requirePolyfill: boolean;
 }
 
 let globalConfig: Partial<CommandKitConfig> = {
@@ -50,6 +54,7 @@ let globalConfig: Partial<CommandKitConfig> = {
     sourcemap: false,
     nodeOptions: [],
     antiCrash: true,
+    requirePolyfill: true,
 };
 
 export function getConfig(): CommandKitConfig {

packages/commandkit/tests/src/index.ts

@@ -1,6 +1,7 @@
 import { CommandKit } from '../../src/index';
 import { Client } from 'discord.js';
-import 'dotenv/config';
+
+require('dotenv/config');
 
 const client = new Client({
     intents: ['Guilds', 'GuildMembers', 'GuildMessages', 'MessageContent'],