oops commonjs

More fixes

Author: timfish

package.json

@@ -16,6 +16,7 @@
     "sentry"
   ],
   "scripts": {
+    "install": "node -p \"'@sentry/node-native-stacktrace@' + require('./package.json').version\"",
     "lint": "yarn lint:eslint && yarn lint:clang",
     "lint:eslint": "eslint . --format stylish",
     "lint:clang": "node scripts/clang-format.mjs",
@@ -24,15 +25,16 @@
     "fix:clang": "node scripts/clang-format.mjs --fix",
     "build": "yarn clean && yarn build:lib && yarn build:bindings:configure && yarn build:bindings",
     "build:lib": "tsc",
-    "build:copy-binary": "node -e \"import { copyBinary } from './lib/index.js'; copyBinary();\"",
+    "build:copy-binary": "node -e \"const { copyBinary } = require('./lib/copy-binary.js'); copyBinary();\"",
     "build:bindings:configure": "node-gyp configure",
     "build:bindings:configure:arm64": "node-gyp configure --arch=arm64 --target_arch=arm64",
-    "build:bindings": "node-gyp build && yarn build:copy-binary",
-    "build:bindings:arm64": "node-gyp build --arch=arm64 && yarn build:copy-binary",
+    "build:bindings": "yarn build:lib && node-gyp build && yarn build:copy-binary",
+    "build:bindings:arm64": "yarn build:lib && node-gyp build --arch=arm64 && yarn build:copy-binary",
     "build:tarball": "npm pack",
     "clean": "node-gyp clean && rm -rf lib && rm -rf build && rm -f *.tgz",
     "test": "node ./test/prepare.mjs && vitest run --poolOptions.forks.singleFork --silent=false --disable-console-intercept"
   },
+  "gypfile": false,
   "engines": {
     "node": ">=18"
   },

src/constants.ts

@@ -0,0 +1,11 @@
+
+import * as os from 'node:os';
+import { versions } from 'node:process';
+import * as libc from 'detect-libc';
+import { getAbi } from 'node-abi';
+
+export const stdlib = libc.familySync();
+export const platform = process.env['BUILD_PLATFORM'] || os.platform();
+export const arch = process.env['BUILD_ARCH'] || os.arch();
+export const abi = getAbi(versions.node, 'node');
+export const identifier = [platform, arch, stdlib, abi].filter(c => c !== undefined && c !== null).join('-');

src/copy-binary.ts

@@ -0,0 +1,31 @@
+/* eslint-disable no-console */
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { identifier } from './constants';
+
+const source = path.join(__dirname, '..', 'build', 'Release', 'stack-trace.node');
+const target = path.join(__dirname, '..', 'lib', `stack-trace-${identifier}.node`);
+
+/**
+ * Copies the compiled binary from the build directory to the lib directory with the correct name based on the current platform and Node version.
+ *
+ * @hidden We only use this for copying the binary after building, it is not intended to be used by end users.
+ */
+export function copyBinary(): void {
+  const build = path.resolve(__dirname, '..', 'lib');
+  if (!fs.existsSync(build)) {
+    fs.mkdirSync(build, { recursive: true });
+  }
+
+  if (!fs.existsSync(source)) {
+    console.log('Source file does not exist:', source);
+    process.exit(1);
+  } else {
+    if (fs.existsSync(target)) {
+      console.log('Target file already exists, overwriting it');
+      fs.unlinkSync(target);
+    }
+    console.log('Copying', source, 'to', target);
+    fs.copyFileSync(source, target);
+  }
+}

src/index.ts

@@ -1,19 +1,11 @@
 /* eslint-disable no-console */
 import type { AsyncLocalStorage } from 'node:async_hooks';
 import { spawnSync } from 'node:child_process';
-import * as fs from 'node:fs';
-import * as os from 'node:os';
 import * as path from 'node:path';
-import { env, versions } from 'node:process';
+import { env } from 'node:process';
 import { threadId } from 'node:worker_threads';
-import * as libc from 'detect-libc';
-import { getAbi } from 'node-abi';
-
-const stdlib = libc.familySync();
-const platform = process.env['BUILD_PLATFORM'] || os.platform();
-const arch = process.env['BUILD_ARCH'] || os.arch();
-const abi = getAbi(versions.node, 'node');
-const identifier = [platform, arch, stdlib, abi].filter(c => c !== undefined && c !== null).join('-');
+import { abi, arch, identifier, platform, stdlib } from './constants';
+import { copyBinary } from './copy-binary';
 
 type AsyncStorageArgs = {
   /** The AsyncLocalStorage instance used to fetch the store */
@@ -56,33 +48,6 @@ interface Native {
   getThreadsLastSeen(): Record<string, number>;
 }
 
-/**
- * Copies the compiled binary from the build directory to the lib directory with the correct name based on the current platform and Node version.
- *
- * @hidden We only use this for copying the binary after building, it is not intended to be used by end users.
- */
-export function copyBinary(): void {
-  const build = path.resolve(__dirname, '..', 'lib');
-  if (!fs.existsSync(build)) {
-    fs.mkdirSync(build, { recursive: true });
-  }
-
-  if (!fs.existsSync(source)) {
-    console.log('Source file does not exist:', source);
-    process.exit(1);
-  } else {
-    if (fs.existsSync(target)) {
-      console.log('Target file already exists, overwriting it');
-      fs.unlinkSync(target);
-    }
-    console.log('Copying', source, 'to', target);
-    fs.copyFileSync(source, target);
-  }
-}
-
-const source = path.join(__dirname, '..', 'build', 'Release', 'stack-trace.node');
-const target = path.join(__dirname, '..', 'lib', `stack-trace-${identifier}.node`);
-
 function clean(err: Buffer): string {
   return err.toString().trim();
 }
@@ -308,7 +273,26 @@ function getNativeModule(): Native {
 
 const native = getNativeModule();
 
+/**
+ * Registers the current thread with the native module.
+ *
+ * This should be called on every thread that you want to capture stack traces from.
+ *
+ * @param threadName The name of the thread
+ *
+ * threadName defaults to the `threadId` if not provided.
+ */
 export function registerThread(threadName?: string): void;
+/**
+ * Registers the current thread with the native module.
+ *
+ * This should be called on every thread that you want to capture stack traces from.
+ *
+ * @param storageOrThread Either the name of the thread, or an object containing an AsyncLocalStorage instance and optional storage key.
+ * @param threadName The name of the thread, if the first argument is an object.
+ *
+ * threadName defaults to the `threadId` if not provided.
+ */
 export function registerThread(storageOrThread: AsyncStorageArgs | string, threadName?: string): void;
 /**
  * Registers the current thread with the native module.

tsconfig.json

@@ -1,13 +1,13 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "module": "node16",
+    "module": "commonjs",
     "declaration": true,
     "outDir": "lib",
     "strict": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
-    "moduleResolution": "node16",
+    "moduleResolution": "node",
     "noEmit": false,
     "sourceMap": true,
     "declarationMap": true,