borp 0.15.0 → 0.17.0

package/.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 21.x]
+        node-version: [18.x, 20.x, 21.x, 22.x]
         os: [ubuntu-latest, windows-latest]
         exclude:
           - os: windows-latest
@@ -39,4 +39,4 @@ jobs:
 
       - name: Run tests
         run: |
-          npm run unit -- --reporter spec
+          npm run unit

package/README.md

@@ -18,6 +18,15 @@ borp --coverage
 
 # with check coverage active
 borp --coverage --check-coverage --lines 95
+
+# with a node_modules located reporter
+borp --reporter foo
+
+# with a node_modules located reporter writing to stderr
+borp --reporter foo:stderr
+
+# with a local custom reporter
+borp --reporter ./lib/some-reporter.mjs
 ```
 
 Borp will automatically run all tests files matching `*.test.{js|ts}`.
@@ -98,7 +107,7 @@ Note the use of `incremental: true`, which speed up compilation massively.
 * `--ignore` or `-i`, ignore a glob pattern, and not look for tests there
 * `--expose-gc`, exposes the gc() function to tests
 * `--pattern` or `-p`, run tests matching the given glob pattern
-* `--reporter` or `-r`, set up a reporter, use a colon to set a file destination. Default: `spec`.
+* `--reporter` or `-r`, set up a reporter, use a colon to set a file destination. Reporter may either be a module name resolvable by standard `node_modules` resolution, or a path to a script relative to the process working directory (must be an ESM script). Default: `spec`.
 * `--no-typescript` or `-T`, disable automatic TypeScript compilation if `tsconfig.json` is found.
 * `--post-compile` or `-P`, the path to a file that will be executed after each typescript compilation.
 * `--check-coverage`, enables c8 check coverage; default is false

package/borp.js

@@ -114,7 +114,19 @@ try {
 
   for (const input of args.values.reporter) {
     const [name, dest] = input.split(':')
-    const Ctor = reporters[name] || await import(name).then((m) => m.default || m)
+    let Ctor
+    if (Object.prototype.hasOwnProperty.call(reporters, name) === true) {
+      Ctor = reporters[name]
+    } else {
+      try {
+        // Try to load a custom reporter from a file relative to the process.
+        const modPath = join(process.cwd(), name.replace(/^['"]/, '').replace(/['"]$/, ''))
+        Ctor = await import(modPath).then((m) => m.default || m)
+      } catch {
+        // Fallback to trying to load the reporter from node_modules resolution.
+        Ctor = await import(name).then((m) => m.default || m)
+      }
+    }
     const reporter = Ctor.prototype && Object.getOwnPropertyDescriptor(Ctor.prototype, 'constructor') ? new Ctor() : Ctor
     let output = process.stdout
     if (dest) {

package/fixtures/files-glob/lib/add.js

@@ -0,0 +1,3 @@
+export function add (x, y) {
+  return x + y
+}

package/fixtures/files-glob/test1/add.test.js

@@ -0,0 +1,7 @@
+import { test } from 'node:test'
+import { add } from '../lib/add.js'
+import { strictEqual } from 'node:assert'
+
+test('add', () => {
+  strictEqual(add(1, 2), 3)
+})

package/fixtures/files-glob/test2/nested/add2.test.js

@@ -0,0 +1,7 @@
+import { test } from 'node:test'
+import { add } from '../../lib/add.js'
+import { strictEqual } from 'node:assert'
+
+test('add2', () => {
+  strictEqual(add(3, 2), 5)
+})

package/fixtures/relative-reporter/lib/add.js

@@ -0,0 +1,3 @@
+export function add (x, y) {
+  return x + y
+}

package/fixtures/relative-reporter/reporter.js

@@ -0,0 +1,24 @@
+'use strict'
+
+import { Transform } from 'node:stream'
+
+const testReporter = new Transform({
+  writableObjectMode: true,
+  transform (event, encoding, callback) {
+    switch (event.type) {
+      case 'test:pass': {
+        return callback(null, `passed: ${event.data.file}\n`)
+      }
+
+      case 'test:fail': {
+        return callback(null, `failed: ${event.data.file}\n`)
+      }
+
+      default: {
+        callback(null, null)
+      }
+    }
+  }
+})
+
+export default testReporter

package/fixtures/relative-reporter/test/add.test.js

@@ -0,0 +1,7 @@
+import { test } from 'node:test'
+import { add } from '../lib/add.js'
+import { strictEqual } from 'node:assert'
+
+test('add', () => {
+  strictEqual(add(1, 2), 3)
+})

package/fixtures/relative-reporter/test/add2.test.js

@@ -0,0 +1,7 @@
+import { test } from 'node:test'
+import { add } from '../lib/add.js'
+import { strictEqual } from 'node:assert'
+
+test('add2', () => {
+  strictEqual(add(3, 2), 5)
+})

package/lib/run.js

@@ -3,7 +3,7 @@ import { glob } from 'glob'
 import { findUp } from 'find-up'
 import { createRequire } from 'node:module'
 import { join, dirname } from 'node:path'
-import { access, readFile } from 'node:fs/promises'
+import { access } from 'node:fs/promises'
 import { execa } from 'execa'
 
 function deferred () {
@@ -17,7 +17,7 @@ function deferred () {
 }
 
 function enableSourceMapSupport (tsconfig) {
-  if (!tsconfig?.compilerOptions?.sourceMap) {
+  if (!tsconfig?.options?.sourceMap) {
     return
   }
 
@@ -56,13 +56,21 @@ export default async function runWithTypeScript (config) {
   }
 
   if (tsconfigPath && config.typescript !== false) {
-    const tsconfig = JSON.parse(await readFile(tsconfigPath))
     const _require = createRequire(tsconfigPath)
+    const { parseJsonConfigFileContent, readConfigFile, sys } = _require('typescript')
+
+    const configFile = readConfigFile(tsconfigPath, sys.readFile)
+    const tsconfig = parseJsonConfigFileContent(
+      configFile.config,
+      sys,
+      dirname(tsconfigPath)
+    )
+
     const typescriptPathCWD = _require.resolve('typescript')
     tscPath = join(typescriptPathCWD, '..', '..', 'bin', 'tsc')
-    const outDir = tsconfig.compilerOptions.outDir
+    const outDir = tsconfig.options.outDir
     if (outDir) {
-      prefix = join(dirname(tsconfigPath), outDir)
+      prefix = outDir
     }
 
     enableSourceMapSupport(tsconfig)
@@ -73,7 +81,7 @@ export default async function runWithTypeScript (config) {
 
       // Watch is handled aftterwards
       if (!config.watch) {
-        if (Array.isArray(tsconfig.references) && tsconfig.references.length > 0) {
+        if (Array.isArray(tsconfig.projectReferences) && tsconfig.projectReferences.length > 0) {
           typescriptCliArgs.push('--build')
         }
         const start = Date.now()
@@ -123,8 +131,17 @@ export default async function runWithTypeScript (config) {
     p = deferred()
     let outDir = ''
     if (config['post-compile'] && tsconfigPath) {
-      const tsconfig = JSON.parse(await readFile(tsconfigPath))
-      outDir = tsconfig.compilerOptions.outDir
+      const _require = createRequire(tsconfigPath)
+      const { parseJsonConfigFileContent, readConfigFile, sys } = _require('typescript')
+
+      const configFile = readConfigFile(tsconfigPath, sys.readFile)
+      const tsconfig = parseJsonConfigFileContent(
+        configFile.config,
+        sys,
+        dirname(tsconfigPath)
+      )
+
+      outDir = tsconfig.options.outDir
 
       enableSourceMapSupport(tsconfig)
     }
@@ -158,6 +175,9 @@ export default async function runWithTypeScript (config) {
         })
       }
     })
+    // We must noop `.catch()`, otherwise `tscChild` will
+    // reject.
+    tscChild.catch(() => {})
     if (config.signal) {
       config.signal.addEventListener('abort', () => {
         tscChild.kill()
@@ -176,6 +196,16 @@ export default async function runWithTypeScript (config) {
     if (prefix) {
       files = files.map((file) => join(prefix, file.replace(/ts$/, 'js')))
     }
+    const expandedFiles = []
+    for (let i = 0; i < files.length; i += 1) {
+      if (files[i].includes('*') === false) {
+        expandedFiles.push(files[i])
+        continue
+      }
+      const parsed = await glob(files[i].replace(/^['"]/, '').replace(/['"]$/, ''), { ignore, cwd, windowsPathsNoEscape: true })
+      Array.prototype.push.apply(expandedFiles, parsed)
+    }
+    files = expandedFiles
   } else if (config.pattern) {
     let pattern = config.pattern
     if (prefix) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "borp",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "type": "module",
   "description": "node:test wrapper with TypeScript support",
   "main": "borp.js",
@@ -33,7 +33,7 @@
   "dependencies": {
     "@reporters/github": "^1.5.4",
     "c8": "^10.0.0",
-    "execa": "^8.0.1",
+    "execa": "^9.3.0",
     "find-up": "^7.0.0",
     "glob": "^10.3.10"
   }

package/test/cli.test.js

@@ -74,6 +74,19 @@ test('reporter from node_modules', async () => {
   strictEqual(stdout.indexOf('tests 2') >= 0, true)
 })
 
+test('reporter from relative path', async () => {
+  const cwd = join(import.meta.url, '..', 'fixtures', 'relative-reporter')
+  const { stdout } = await execa('node', [
+    borp,
+    '--reporter=./fixtures/relative-reporter/reporter.js'
+  ], {
+    cwd
+  })
+
+  strictEqual(/passed:.+add\.test\.js/.test(stdout), true)
+  strictEqual(/passed:.+add2\.test\.js/.test(stdout), true)
+})
+
 test('gh reporter', async () => {
   const cwd = join(import.meta.url, '..', 'fixtures', 'js-esm')
   const { stdout } = await execa('node', [
@@ -89,6 +102,19 @@ test('gh reporter', async () => {
   strictEqual(stdout.indexOf('::notice') >= 0, true)
 })
 
+test('interprets globs for files', async () => {
+  const cwd = join(import.meta.url, '..', 'fixtures', 'files-glob')
+  const { stdout } = await execa('node', [
+    borp,
+    '\'test1/*.test.js\'',
+    '\'test2/**/*.test.js\''
+  ], {
+    cwd
+  })
+
+  strictEqual(stdout.indexOf('tests 2') >= 0, true)
+})
+
 test('Post compile script should be executed when --post-compile  is sent with esm', async () => {
   const cwd = join(import.meta.url, '..', 'fixtures', 'ts-esm-post-compile')
   const { stdout } = await execa('node', [

package/test/watch.test.js

@@ -6,7 +6,10 @@ import { mkdtemp, cp, writeFile, rm } from 'node:fs/promises'
 import path from 'node:path'
 import { once } from 'node:events'
 
-test('watch', async (t) => {
+// These tests are currently broken on node v22
+const skip = process.platform === 'darwin' && process.version.startsWith('v22')
+
+test('watch', { skip }, async (t) => {
   const { strictEqual, completed, match } = tspl(t, { plan: 3 })
 
   const dir = path.resolve(await mkdtemp('.test-watch'))
@@ -24,15 +27,17 @@ test('watch', async (t) => {
 
   const config = {
     files: [],
-    cwd: dir,
     signal: controller.signal,
+    cwd: dir,
     watch: true
   }
 
+  process._rawDebug('dir', dir)
   const stream = await runWithTypeScript(config)
 
   const fn = (test) => {
     if (test.type === 'test:fail') {
+      console.log('test', test)
       match(test.data.name, /add/)
       stream.removeListener('data', fn)
     }
@@ -58,7 +63,7 @@ test('add', () => {
   await completed
 })
 
-test('watch file syntax error', async (t) => {
+test('watch file syntax error', { skip }, async (t) => {
   const { strictEqual, completed, match } = tspl(t, { plan: 3 })
 
   const dir = path.resolve(await mkdtemp('.test-watch'))
@@ -110,7 +115,7 @@ test('add', () => {
   await completed
 })
 
-test('watch with post compile hook should call the hook the right number of times', async (t) => {
+test('watch with post compile hook should call the hook the right number of times', { skip }, async (t) => {
   const { completed, ok, match } = tspl(t, { plan: 2 })
 
   const dir = path.resolve(await mkdtemp('.test-watch-with-post-compile-hook'))