test(linter/plugins): debug build for tests (#15921)

Generate a debug build, in addition to the normal release build.

In the debug build, `DEBUG` global is defined as `true` and `assertIsNonNull` does a runtime assertion. In release build, `DEBUG === false` and minifier removes debug-only code.

Run the tests in debug mode.

Debug build is generated in a separate directory from `dist`, so is *not* included in NPM package.

Author: overlookmotel

apps/oxlint/.gitignore

@@ -1,3 +1,4 @@
 /node_modules/
 /dist/
+/debug/
 *.node

apps/oxlint/package.json

@@ -47,6 +47,6 @@
     ]
   },
   "imports": {
-    "#oxlint": "./dist/index.js"
+    "#oxlint": "./debug/index.js"
   }
 }

apps/oxlint/scripts/build.ts

@@ -3,7 +3,8 @@ import { copyFileSync, readdirSync, readFileSync, writeFileSync } from 'node:fs'
 import { join } from 'node:path';
 
 const oxlintDirPath = join(import.meta.dirname, '..'),
-  distDirPath = join(oxlintDirPath, 'dist');
+  distDirPath = join(oxlintDirPath, 'dist'),
+  debugDirPath = join(oxlintDirPath, 'debug');
 
 // Modify `bindings.js` to use correct package names
 console.log('Modifying bindings.js...');
@@ -26,6 +27,7 @@ const srcDirPath = join(oxlintDirPath, 'src-js');
 for (const filename of readdirSync(srcDirPath)) {
   if (!filename.endsWith('.node')) continue;
   copyFileSync(join(srcDirPath, filename), join(distDirPath, filename));
+  copyFileSync(join(srcDirPath, filename), join(debugDirPath, filename));
 }
 
 console.log('Build complete!');

apps/oxlint/src-js/globals.d.ts

@@ -0,0 +1,2 @@
+// Global constant defined at build time by TSDown
+declare const DEBUG: boolean;

apps/oxlint/src-js/plugins/utils.ts

@@ -45,13 +45,20 @@ export function assertIs<T>(value: unknown): asserts value is T {}
 /**
  * Assert a value is not `null` or `undefined`.
  *
- * Has no runtime effect - only for guiding the type-checker.
- * Minification removes this function and all calls to it, so it has zero runtime cost.
+ * In release builds, is a no-op. Only does runtime checks in debug builds.
+ * Minification removes this function and all calls to it in release builds, so it has zero runtime cost.
  *
  * @param value - Value
  */
 // oxlint-disable-next-line no-unused-vars
-export function assertIsNonNull<T>(value: T | null | undefined): asserts value is T {}
+export function assertIsNonNull<T>(value: T | null | undefined): asserts value is T {
+  if (!DEBUG) return;
+
+  if (value === null || value === undefined) {
+    // oxlint-disable-next-line typescript/restrict-template-expressions
+    throw new Error(`Expected non-null value, got ${value}`);
+  }
+}
 
 /**
  * Utility type to make specified properties of a type nullable.

apps/oxlint/test/e2e.test.ts

@@ -4,7 +4,7 @@ import { PACKAGE_ROOT_PATH, getFixtures, testFixtureWithCommand } from './utils.
 
 import type { Fixture } from './utils.ts';
 
-const CLI_PATH = pathJoin(PACKAGE_ROOT_PATH, 'dist/cli.js');
+const CLI_PATH = pathJoin(PACKAGE_ROOT_PATH, 'debug/cli.js');
 
 // Use current NodeJS executable, rather than `node`, to avoid problems with a Node version manager
 // installed on system resulting in using wrong NodeJS version

apps/oxlint/tsdown.config.ts

@@ -21,10 +21,11 @@ const commonConfig: UserConfig = {
     mangle: false,
     codegen: { removeWhitespace: false },
   },
+  define: { DEBUG: 'false' },
 };
 
 // Only generate `.d.ts` file for main export, not for CLI
-export default defineConfig([
+const configs = defineConfig([
   {
     entry: 'src-js/cli.ts',
     ...commonConfig,
@@ -37,3 +38,13 @@ export default defineConfig([
     attw: true,
   },
 ]);
+
+// Create separate debug build with debug assertions enabled
+const debugConfigs = configs.map((config) => ({
+  ...config,
+  outDir: 'debug',
+  define: { DEBUG: 'true' },
+}));
+configs.push(...debugConfigs);
+
+export default configs;

apps/oxlint/vitest.config.ts

@@ -4,4 +4,7 @@ export default defineConfig({
   test: {
     exclude: [...configDefaults.exclude, 'fixtures/**'],
   },
+  define: {
+    DEBUG: 'true',
+  },
 });