borp 0.20.2 → 1.0.0

package/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(gh pr checks:*)"
+    ]
+  }
+}

package/.github/workflows/ci.yml

@@ -16,11 +16,8 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 21.x, 22.x, 23.x, 24.x]
+        node-version: [22.x, 24.x, 25.x]
         os: [ubuntu-latest, windows-latest]
-        exclude:
-          - os: windows-latest
-            node-version: 21.x
     steps:
       - uses: actions/checkout@v4
 

package/.github/workflows/publish-release.yml

@@ -0,0 +1,43 @@
+name: Publish release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'The version number to tag and release'
+        required: true
+        type: string
+      prerelease:
+        description: 'Release as pre-release'
+        required: false
+        type: boolean
+        default: false
+
+jobs:
+  release-npm:
+    runs-on: ubuntu-latest
+    environment: main
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install npm -g
+      - run: npm install
+      - name: Change version number and sync
+        run: |
+          node scripts/sync-version.mjs ${{ inputs.version }}
+      - name: GIT commit and push all changed files
+        run: |
+          git config --global user.name "mcollina"
+          git config --global user.email "hello@matteocollina.com"
+          git commit -n -a -m "Bumped v${{ inputs.version }}"
+          git push origin HEAD:${{ github.ref }}
+      - run: npm publish --access public --tag ${{ inputs.prerelease == true && 'next' || 'latest' }}
+      - name: 'Create release notes'
+        run: |
+          npx @matteo.collina/release-notes -a ${{ secrets.GITHUB_TOKEN }} -t v${{ inputs.version }} -r mcollina -o borp ${{ github.event.inputs.prerelease == 'true' && '-p' || '' }} -c ${{ github.ref }}

package/README.md

@@ -1,10 +1,15 @@
 # borp
 
-Borp is a typescript-aware test runner for `node:test`.
-It also support code coverage via [c8](http://npm.im/c8).
+Borp is a TypeScript-aware test runner for `node:test` with built-in code coverage support via [c8](https://npm.im/c8).
+
+Borp uses Node.js native [type stripping](https://nodejs.org/api/typescript.html) to run TypeScript files directly without compilation. No build step required!
 
 Borp is self-hosted, i.e. Borp runs its own tests.
 
+## Requirements
+
+- Node.js >= 22.6.0 (22.19.0+ or 24.x+ recommended for best TypeScript support)
+
 ## Install
 
 ```bash
@@ -14,40 +19,47 @@ npm i borp --save-dev
 ## Usage
 
 ```bash
+# Run all tests
+borp
+
+# With code coverage
 borp --coverage
 
-# with check coverage active
+# With coverage threshold checking
 borp --coverage --check-coverage --lines 95
 
-# with a node_modules located reporter
+# With a node_modules located reporter
 borp --reporter foo
 
-# with a node_modules located reporter writing to stderr
+# With a node_modules located reporter writing to stderr
 borp --reporter foo:stderr
 
-# with a local custom reporter
+# With a local custom reporter
 borp --reporter ./lib/some-reporter.mjs
 
-# matching all test.js files except ones in nested node_modules directories
+# Matching all test.js files except ones in nested node_modules directories
 borp 'test/**/*.test.js' '!test/**/node_modules/**/*.test.js'
 ```
 
-Borp will automatically run all tests files matching `*.test.{js|ts}`.
+Borp will automatically run all test files matching `*.test.{js|ts|mts|cts}`.
+
+## TypeScript Support
+
+Borp uses Node.js native type stripping to run TypeScript files directly. No compilation step is required!
 
 ### Example project setup
 
 ```
 .
 ├── src
-│   ├── lib
-│   │   └── math.ts
-│   └── test
-│       └── math.test.ts
-└── tsconfig.json
-
+│   ├── lib
+│   │   └── math.ts
+│   └── test
+│       └── math.test.ts
+└── package.json
 ```
 
-As an example, consider having a `src/lib/math.ts` file  
+As an example, consider having a `src/lib/math.ts` file:
 
 ```typescript
 export function math (x: number, y: number): number {
@@ -59,7 +71,7 @@ and a `src/test/math.test.ts` file:
 
 ```typescript
 import { test } from 'node:test'
-import { math } from '../lib/math.js'
+import { math } from '../lib/math.ts'
 import { strictEqual } from 'node:assert'
 
 test('math', () => {
@@ -67,43 +79,51 @@ test('math', () => {
 })
 ```
 
-and the following `tsconfig.json`:
+Note: Use `.ts` extensions in your imports, not `.js`!
+
+### TypeScript Constraints
+
+Type stripping has some limitations compared to full TypeScript compilation. Your code must follow these rules:
+
+- **Use type-only imports**: Use `import type { Foo }` or `import { type Foo }` for type imports
+- **No enums**: Use const objects with `as const` instead
+- **No namespaces**: Use regular modules instead
+- **No parameter properties**: Explicitly declare class properties in the constructor body
+- **File extensions**: Import `.ts` files with `.ts` extension
+
+See the [Node.js TypeScript documentation](https://nodejs.org/api/typescript.html) for full details.
+
+### Optional tsconfig.json
+
+A `tsconfig.json` is not required for borp to work, but you can include one for IDE support and type checking:
 
 ```json
 {
-  "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "outDir": "dist",
-    "sourceMap": true,
     "target": "ES2022",
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
-    "esModuleInterop": true,
     "strict": true,
-    "resolveJsonModule": true,
-    "removeComments": true,
-    "newLine": "lf",
-    "noUnusedLocals": true,
-    "noFallthroughCasesInSwitch": true,
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
     "isolatedModules": true,
-    "forceConsistentCasingInFileNames": true,
-    "skipLibCheck": true,
-    "lib": [
-      "ESNext"
-    ],
-    "incremental": true
+    "skipLibCheck": true
   }
 }
 ```
 
-Note the use of `incremental: true`, which speed up compilation massively.
+Key options:
+- `noEmit: true` - No compilation output needed
+- `allowImportingTsExtensions: true` - Allow `.ts` imports
+- `verbatimModuleSyntax: true` - Enforce type-only imports
 
 ## Options
 
 * `--concurrency` or `-c`, to set the number of concurrent tests. Defaults to the number of available CPUs minus one.
 * `--coverage` or `-C`, enables code coverage
-* `--only` or `-o`, only run `node:test` with the `only` option set  
-* `--watch` or `-w`, re-run tests on changes
+* `--only` or `-o`, only run `node:test` with the `only` option set
+* `--watch` or `-w`, re-run tests on file changes using Node.js native watch mode
 * `--timeout` or `-t`, timeouts the tests after a given time; default is 30000 ms
 * `--no-timeout`, disables the timeout
 * `--coverage-exclude` or `-X`, a list of comma-separated patterns to exclude from the coverage report. All tests files are ignored by default.
@@ -111,14 +131,16 @@ Note the use of `incremental: true`, which speed up compilation massively.
 * `--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. 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
+* `--coverage-html`, generates c8 html report; default is false
+
 ### Check coverage options
+
 * `--lines`, set the lines threshold when check coverage is active; default is 100
 * `--functions`, set the functions threshold when check coverage is active; default is 100
 * `--statements`, set the statements threshold when check coverage is active; default is 100
 * `--branches`, set the branches threshold when check coverage is active; default is 100
+
 ## Reporters
 
 Here are the available reporters:
@@ -131,24 +153,30 @@ Here are the available reporters:
 
 ## Config File Support
 
-A limited set of options may be specified via a configuration file. The
-configuration file is expected to be in the process's working directory, and
-named either `.borp.yaml` or `.borp.yml`; it may also be specified by
-defining the environment variable `BORP_CONF_FILE` and setting it to the
-full path to some yaml file.
+A limited set of options may be specified via a configuration file. The configuration file is expected to be in the process's working directory, and named either `.borp.yaml` or `.borp.yml`; it may also be specified by defining the environment variable `BORP_CONF_FILE` and setting it to the full path to some yaml file.
 
 The current supported options are:
 
-+ `files` (string[]): An array of test files to include. Globs are supported.
-  Note: any glob that starts with a `!` (bang character) will be treated as
-  an ignore glob, e.g. `'!test/**/node_modules/**/*'` will ignore all files
-  in nested `node_modules` directories that would otherwise be matched.
-+ `reporters` (string[]): An array of reporters to use. May be relative path
-strings, or module name strings.
++ `coverage` (object): A hash of options relating to test coverage. By defining this configuration object, coverage reporting will be enabled.
+  - `check-coverage` (boolean): Set to `true` to enable coverage checking. Omit to disable coverage checking.
+  - `coverage-html` (boolean): Set to `true` to generate an HTML coverage report.
+  - `branches` (number): Define the percentage of acceptable coverage for branches. Default: 100.
+  - `functions` (number): Define the percentage of acceptable coverage for functions. Default: 100.
+  - `lines` (number): Define the percentage of acceptable coverage for lines. Default: 100.
+  - `statements` (number): Define the percentage of acceptable coverage for statements. Default: 100.
++ `files` (string[]): An array of test files to include. Globs are supported. Note: any glob that starts with a `!` (bang character) will be treated as an ignore glob, e.g. `'!test/**/node_modules/**/*'` will ignore all files in nested `node_modules` directories that would otherwise be matched.
++ `reporters` (string[]): An array of reporters to use. May be relative path strings, or module name strings.
 
 ### Example
 
 ```yaml
+coverage:
+  check-coverage: true
+  branches: 99
+  functions: 98
+  lines: 97
+  statements: 96
+
 files:
   - 'test/one.test.js'
   - 'test/foo/*.test.js'
@@ -159,6 +187,16 @@ reporters:
   - '@reporters/silent'
 ```
 
+## Migration from borp < 1.0
+
+If you're upgrading from an older version of borp, here are the key changes:
+
+1. **No compilation step**: Tests run directly from source files
+2. **Import extensions**: Change `.js` to `.ts` in your TypeScript imports
+3. **No outDir**: Remove `outDir` from tsconfig or set to your source directory
+4. **Removed options**: `--no-typescript` and `--post-compile` are removed
+5. **Type constraints**: See TypeScript Constraints section above
+
 ## License
 
 MIT

package/borp.js

@@ -1,14 +1,13 @@
 #! /usr/bin/env node
 
 import { parseArgs } from 'node:util'
+import runTests from './lib/run.js'
 import Reporters from 'node:test/reporters'
 import { findUp } from 'find-up'
 import { mkdtemp, rm, readFile } from 'node:fs/promises'
 import { createWriteStream } from 'node:fs'
 import { finished } from 'node:stream/promises'
-import { join, relative, resolve } from 'node:path'
-import posix from 'node:path/posix'
-import runWithTypeScript from './lib/run.js'
+import { join, resolve } from 'node:path'
 import githubReporter from '@reporters/github'
 import { Report } from 'c8'
 import { checkCoverages } from 'c8/lib/commands/check-coverage.js'
@@ -17,6 +16,10 @@ import { execa } from 'execa'
 import { pathToFileURL } from 'node:url'
 import loadConfig from './lib/conf.js'
 
+// This is a hack to override
+// https://github.com/nodejs/node/commit/d5c9adf3df
+delete process.env.NODE_TEST_CONTEXT
+
 /* c8 ignore next 4 */
 process.on('unhandledRejection', (err) => {
   console.error(err)
@@ -38,10 +41,9 @@ Options:
   -X, --coverage-exclude      Exclude patterns from coverage (can be used multiple times)
   -i, --ignore <pattern>      Ignore glob pattern (can be used multiple times)
       --expose-gc             Expose the gc() function to tests
-  -T, --no-typescript         Disable automatic TypeScript compilation
-  -P, --post-compile <file>   Execute file after TypeScript compilation
   -r, --reporter <name>       Set reporter (can be used multiple times, default: spec)
       --check-coverage        Enable coverage threshold checking
+      --coverage-html         Generate HTML coverage report
       --lines <threshold>     Set lines coverage threshold (default: 100)
       --branches <threshold>  Set branches coverage threshold (default: 100)
       --functions <threshold> Set functions coverage threshold (default: 100)
@@ -58,6 +60,7 @@ Examples:
 const foundConfig = await loadConfig()
 if (foundConfig.length > 0) {
   Array.prototype.push.apply(process.argv, foundConfig)
+  process.stderr.write(`parsed config: ${foundConfig.join(' ')}\n`)
 }
 
 const optionsConfig = {
@@ -72,8 +75,6 @@ const optionsConfig = {
   ignore: { type: 'string', short: 'i', multiple: true },
   'expose-gc': { type: 'boolean' },
   help: { type: 'boolean', short: 'h' },
-  'no-typescript': { type: 'boolean', short: 'T' },
-  'post-compile': { type: 'string', short: 'P' },
   reporter: {
     type: 'string',
     short: 'r',
@@ -81,6 +82,7 @@ const optionsConfig = {
     multiple: true
   },
   'check-coverage': { type: 'boolean' },
+  'coverage-html': { type: 'boolean' },
   lines: { type: 'string', default: '100' },
   branches: { type: 'string', default: '100' },
   functions: { type: 'string', default: '100' },
@@ -115,16 +117,16 @@ if (args.values.help) {
 
 /* c8 ignore next 20 */
 if (args.values['expose-gc'] && typeof global.gc !== 'function') {
-  const args = [...process.argv.slice(1)]
+  const spawnArgs = [...process.argv.slice(1)]
   const nodeVersion = process.version.split('.').map((v) => parseInt(v.replace('v', '')))[0]
   if (nodeVersion >= 24) {
     process.env.NODE_OPTIONS = (process.env.NODE_OPTIONS ? process.env.NODE_OPTIONS + ' ' : '') + '--expose-gc'
   } else {
-    args.unshift('--expose-gc')
+    spawnArgs.unshift('--expose-gc')
   }
 
   try {
-    await execa('node', args, {
+    await execa('node', spawnArgs, {
       stdio: 'inherit',
       env: {
         ...process.env
@@ -154,14 +156,6 @@ if (args.values.coverage) {
   process.env.NODE_V8_COVERAGE = covDir
 }
 
-const config = {
-  ...args.values,
-  typescript: !args.values['no-typescript'],
-  files: args.positionals,
-  pattern: args.values.pattern,
-  cwd: process.cwd()
-}
-
 try {
   const pipes = []
 
@@ -204,7 +198,14 @@ try {
     pipes.push([reporter, output])
   }
 
-  const stream = await runWithTypeScript(config)
+  const config = {
+    ...args.values,
+    files: args.positionals,
+    pattern: args.values.pattern,
+    cwd: process.cwd()
+  }
+
+  const stream = await runTests(config)
 
   stream.on('test:fail', () => {
     process.exitCode = 1
@@ -217,18 +218,25 @@ try {
   await finished(stream)
 
   if (covDir) {
-    let exclude = args.values['coverage-exclude']
-
-    if (exclude && config.prefix) {
-      const localPrefix = relative(process.cwd(), config.prefix)
-      exclude = exclude.map((file) => posix.join(localPrefix, file))
-    }
+    const exclude = args.values['coverage-exclude']
     const nycrc = await findUp(['.c8rc', '.c8rc.json', '.nycrc', '.nycrc.json'], { cwd: config.cwd })
+    const nycrcConfig = nycrc ? JSON.parse(await readFile(nycrc, 'utf8')) : {}
+    const configuredReporters = Array.isArray(nycrcConfig.reporter)
+      ? nycrcConfig.reporter
+      : typeof nycrcConfig.reporter === 'string' && nycrcConfig.reporter.length > 0
+        ? [nycrcConfig.reporter]
+        : ['text']
+
+    const coverageReporters = args.values['coverage-html']
+      ? Array.from(new Set([...configuredReporters, 'html']))
+      : configuredReporters
+
+    delete nycrcConfig.reporter
     const report = Report({
-      reporter: ['text'],
+      reporter: coverageReporters,
       tempDirectory: covDir,
       exclude,
-      ...nycrc && JSON.parse(await readFile(nycrc, 'utf8'))
+      ...nycrcConfig
     })
 
     if (args.values['check-coverage']) {

package/fixtures/conf/cov-html.yaml

@@ -0,0 +1,2 @@
+coverage:
+  coverage-html: true

package/fixtures/conf/coverage.yaml

@@ -0,0 +1,7 @@
+coverage:
+  check-coverage: true
+  branches: 95
+  functions: 90
+  lines: 98
+  statements: 80
+  foo: bar

package/fixtures/only-src/src/add.test.ts

@@ -1,5 +1,5 @@
 import { test } from 'node:test'
-import { add } from './add.js'
+import { add } from './add.ts'
 import { strictEqual } from 'node:assert'
 
 test('add', () => {

package/fixtures/only-src/src/add2.test.ts

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

package/fixtures/ts-esm/test/add.test.ts

@@ -1,5 +1,5 @@
 import { test } from 'node:test'
-import { add } from '../src/add.js'
+import { add } from '../src/add.ts'
 import { strictEqual } from 'node:assert'
 
 test('add', () => {

package/fixtures/ts-esm/test/add2.test.ts

@@ -1,5 +1,5 @@
 import { test } from 'node:test'
-import { add } from '../src/add.js'
+import { add } from '../src/add.ts'
 import { strictEqual } from 'node:assert'
 
 test('add2', () => {

package/fixtures/ts-esm-check-coverage/test/add.test.ts

@@ -1,5 +1,5 @@
 import { test } from 'node:test'
-import { add } from '../src/math.js'
+import { add } from '../src/math.ts'
 import { strictEqual } from 'node:assert'
 
 test('add', () => {

package/fixtures/ts-esm2/test/add.test.ts

@@ -1,5 +1,5 @@
 import { test } from 'node:test'
-import { add } from '../src/add.js'
+import { add } from '../src/add.ts'
 import { strictEqual } from 'node:assert'
 
 test('add', () => {

package/fixtures/ts-esm2/test/add2.test.ts

@@ -1,5 +1,5 @@
 import { test } from 'node:test'
-import { add } from '../src/add.js'
+import { add } from '../src/add.ts'
 import { strictEqual } from 'node:assert'
 
 test('add2', () => {

package/lib/conf.js

@@ -59,6 +59,24 @@ async function loadConfig () {
     return result
   }
 
+  if (options.coverage) {
+    result.push('--coverage')
+    const allowed = ['branches', 'functions', 'lines', 'statements']
+    for (const [option, value] of Object.entries(options.coverage)) {
+      if (option === 'check-coverage' && value === true) {
+        result.push('--check-coverage')
+        continue
+      }
+      if (option === 'coverage-html' && value === true) {
+        result.push('--coverage-html')
+        continue
+      }
+      if (allowed.includes(option) === false) continue
+      if (isNaN(parseInt(value, 10)) === true) continue
+      result.push(`--${option}=${value}`)
+    }
+  }
+
   if (options.reporters) {
     for (const reporter of options.reporters) {
       result.push('--reporter')