wip: working build

Author: tegefaulkes

jest.config.js jest.config.mjsjest.config.js renamed to jest.config.mjs

@@ -1,5 +1,7 @@
 import path from 'node:path';
 import url from 'node:url';
+import os from 'node:os';
+import process from 'node:process';
 import tsconfigJSON from './tsconfig.json' assert { type: "json" };
 
 const projectPath = path.dirname(url.fileURLToPath(import.meta.url));

npmDepsHash

@@ -1 +1 @@
-sha256-YnXZgZFFew+nEbpxAnslWboXViBWXyRmtJ6xwLDEosg=
+sha256-gyMIa7XqMhUXivusY7zsZixlx/187Jr5gWDW9AizDjs=

package-lock.json

@@ -72,7 +72,7 @@
     "./*": "./dist/*"
   },
   "imports": {
-    "#*": "./dist/*"
+    "#*": "./build/*"
   },
   "bin": {
     "polykey": "dist/polykey.js",
@@ -133,8 +133,7 @@
     "@matrixai/exec-darwin-universal": "*",
     "@matrixai/exec-linux-x64": "*",
     "fd-lock": "*",
-    "sodium-native": "*",
-    "threads": "*"
+    "sodium-native": "*"
   },
   "devDependencies": {
     "@matrixai/errors": "^2.1.3",

package.json

@@ -82,8 +82,11 @@ async function main(argv = process.argv) {
     // External source map for debugging
     sourcemap: true,
     // Minify and keep the original names
-    minify: true,
+    minify: false,
     keepNames: true,
+    // Supporting ESM
+    format: 'esm',
+    inject: [path.join(projectPath, './shims/require-shim.mjs')],
   };
   console.error('Running esbuild:');
   console.error(esbuildOptions);

scripts/build.mjs

@@ -0,0 +1,8 @@
+/**
+ * This shim replaces the `require` in the global scope.
+ * ESM does not provide a global `require` that is synchronous and can be used dynamically.
+ * Some libraries that support ESM still use `require` which is causing problems in esbuild.
+ */
+import { createRequire } from 'node:module';
+// eslint-disable-next-line no-global-assign
+require = createRequire(import.meta.url);

shims/require-shim.mjs

@@ -1,5 +1,6 @@
 import type { FileSystem } from 'polykey/types.js';
-import commander from 'commander';
+import type { OptionValues } from 'commander';
+import { Command } from 'commander';
 import Logger, {
   StreamHandler,
   formatting,
@@ -18,7 +19,7 @@ const logger = new Logger('polykey', undefined, [new StreamHandler()]);
 /**
  * Base class for all commands
  */
-class CommandPolykey extends commander.Command {
+class CommandPolykey extends Command {
   protected logger: Logger = logger;
   protected fs: FileSystem;
   protected exitHandlers: binUtils.ExitHandlers;
@@ -51,7 +52,7 @@ class CommandPolykey extends commander.Command {
   /**
    * Overrides opts to return all options set in the command hierarchy
    */
-  public opts<T extends commander.OptionValues>(): T {
+  public opts<T extends OptionValues>(): T {
     const opts = super.opts<T>();
     if (this.parent != null) {
       // Override the current options with parent options

src/CommandPolykey.ts

@@ -7,6 +7,7 @@ import type {
 import type { PolykeyAgent } from 'polykey';
 import fs from 'fs';
 import process from 'process';
+import { fileURLToPath } from 'node:url';
 /**
  * Hack for wiping out the threads signal handlers
  * See: https://github.com/andywer/threads.js/issues/388
@@ -15,7 +16,6 @@ import process from 'process';
  * in the entire codebase for this hack to work
  * If the worker manager is used, it must be stopped gracefully with the PolykeyAgent
  */
-import 'threads';
 import url from 'node:url';
 process.removeAllListeners('SIGINT');
 process.removeAllListeners('SIGTERM');
@@ -25,7 +25,8 @@ process.removeAllListeners('SIGTERM');
  * This can be referred to globally.
  * For ESM, change to using `import.meta.url`.
  */
-globalThis.PK_MAIN_EXECUTABLE = __filename;
+const filename = fileURLToPath(import.meta.url);
+globalThis.PK_MAIN_EXECUTABLE = filename;
 
 async function polykeyAgentMain(): Promise<number> {
   const {
@@ -146,7 +147,7 @@ async function polykeyAgentMain(): Promise<number> {
 }
 
 async function polykeyMain(argv: Array<string>): Promise<number> {
-  const { default: commander } = await import('commander');
+  const { CommanderError } = await import('commander');
   const { default: ErrorPolykey } = await import('polykey/ErrorPolykey.js');
   const { default: CommandBootstrap } = await import('./bootstrap/index.js');
   const { default: CommandAgent } = await import('./agent/index.js');
@@ -194,7 +195,7 @@ async function polykeyMain(argv: Array<string>): Promise<number> {
     process.exitCode = 0;
   } catch (e) {
     const errFormat = rootCommand.opts().format === 'json' ? 'json' : 'error';
-    if (e instanceof commander.CommanderError) {
+    if (e instanceof CommanderError) {
       // Commander writes help and error messages on stderr automatically
       if (
         e.code === 'commander.help' ||

src/polykey.ts

@@ -2,7 +2,7 @@ import type PolykeyClient from 'polykey/PolykeyClient.js';
 import type { ParsedSecretPathValue } from '../types.js';
 import path from 'path';
 import os from 'os';
-import commander from 'commander';
+import { InvalidArgumentError } from 'commander';
 import * as utils from 'polykey/utils/index.js';
 import CommandPolykey from '../CommandPolykey.js';
 import * as binProcessors from '../utils/processors.js';
@@ -86,7 +86,7 @@ class CommandEnv extends CommandPolykey {
       if (envVariables.length === 0) {
         this.addHelpText('before', 'You must provide at least 1 secret path');
         this.outputHelp();
-        throw new commander.InvalidArgumentError(
+        throw new InvalidArgumentError(
           'You must provide at least 1 secret path',
         );
       }