feat: Added skip option.

Author: ShogunPanda

.swcrc

@@ -58,6 +58,7 @@ A test can be defined as a function containing the test to run or an object cont
 - `test`: The function containing the test to run. If omitted, the test will be a no-op.
 - `before`: A setup function to execute before starting test iteration.
 - `after`: A cleanup function to execute after all test iteration have been run.
+- `skip`: If a test should be skipped.
 
 Each of the `test` functions above can be either a function, a function accepting a Node style callback or a function returning a promise (hence also async functions).
 

README.md

@@ -27,14 +27,13 @@
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "dev": "swc --strip-leading-paths --delete-dir-on-start -s -w -d dist src",
-    "build": "swc --strip-leading-paths --delete-dir-on-start -d dist src",
-    "postbuild": "concurrently npm:lint npm:typecheck",
+    "build": "tsc -p .",
+    "postbuild": "npm run lint",
     "format": "prettier -w src test",
     "lint": "eslint --cache",
-    "typecheck": "tsc -p . --emitDeclarationOnly",
-    "test": "cross-env TS_NODE_PROJECT=tsconfig.test.json c8 -c test/config/c8-local.json node --import @swc-node/register/esm-register --test test/*.test.ts",
-    "test:ci": "cross-env TS_NODE_PROJECT=tsconfig.test.json c8 -c test/config/c8-ci.json node --import @swc-node/register/esm-register --test-reporter=tap --test test/*.test.ts",
+    "typecheck": "tsc -p . --noEmit",
+    "test": "c8 -c test/config/c8-local.json node --env-file=test/config/env --test test/*.test.ts",
+    "test:ci": "c8 -c test/config/c8-ci.json node --env-file=test/config/env --test test/*.test.ts",
     "ci": "npm run build && npm run test:ci",
     "prepublishOnly": "npm run ci",
     "postpublish": "git push origin && git push origin -f --tags"
@@ -46,13 +45,10 @@
     "table": "^6.9.0"
   },
   "devDependencies": {
-    "@cowtech/eslint-config": "10.2.0",
-    "@swc/cli": "^0.6.0",
-    "@swc/core": "^1.10.7",
+    "@cowtech/eslint-config": "10.4.0",
     "@types/node": "^22.10.2",
     "c8": "^10.1.3",
-    "chokidar": "^4.0.3",
-    "concurrently": "^9.1.1",
+    "cleaner-spec-reporter": "^0.3.1",
     "cross-env": "^7.0.3",
     "eslint": "^9.17.0",
     "prettier": "^3.4.2",

package.json

@@ -9,13 +9,13 @@ import {
   type Result,
   type Results,
   type Tests
-} from './models.js'
-import { printResults } from './print.js'
+} from './models.ts'
+import { printResults } from './print.ts'
 
 type PromiseResolver<T> = (value: T) => void
 type PromiseRejecter = (err: Error) => void
 
-export * from './models.js'
+export * from './models.ts'
 
 function scheduleNextTest(context: Context): void {
   // We still have work to do
@@ -106,7 +106,7 @@ export function cronometro(
   cb?: Callback
 ): Promise<Results> | void {
   if (!isMainThread) {
-    workerData.tests = Object.entries(tests)
+    workerData.tests = Object.entries(tests).filter(test => test[1]?.skip !== true)
     return
   }
 
@@ -174,7 +174,7 @@ export function cronometro(
     iterations,
     errorThreshold: errorThreshold / 100,
     print,
-    tests: Object.entries(tests), // Convert tests to a easier to process [name, func] list,
+    tests: Object.entries(tests).filter(test => test[1]?.skip !== true), // Convert tests to a easier to process [name, func] list,
     results: {},
     current: 0,
     callback,

src/index.ts

@@ -1,5 +1,4 @@
 import { type Histogram } from 'hdr-histogram-js'
-import { resolve, dirname } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { type Worker } from 'node:worker_threads'
 
@@ -27,12 +26,13 @@ export interface Options {
 export type StaticTest = () => any
 export type AsyncTest = (cb: Callback) => any
 export type PromiseTest = () => Promise<any>
-export type TestFunction = StaticTest | AsyncTest | PromiseTest
+export type TestFunction = (StaticTest | AsyncTest | PromiseTest) & { skip?: boolean }
 
 export interface Test {
   test?: TestFunction
   before?: SetupFunction
   after?: SetupFunction
+  skip?: boolean
 }
 
 export type Percentiles = Record<string, number>
@@ -100,9 +100,4 @@ export const defaultOptions = {
 
 export const percentiles = [0.001, 0.01, 0.1, 1, 2.5, 10, 25, 50, 75, 90, 97.5, 99, 99.9, 99.99, 99.999]
 
-export const runnerPath = resolve(
-  dirname(fileURLToPath(import.meta.url))
-    .replace('src', 'dist')
-    .replace(/models.(js|ts)/, ''),
-  './runner.js'
-)
+export const runnerPath = fileURLToPath(new URL(`./runner.${import.meta.url.slice(-2)}`, import.meta.url))

src/models.ts

@@ -1,6 +1,6 @@
 import { clean, colorize } from 'acquerello'
 import { table } from 'table'
-import { type Results } from './models.js'
+import { type Results } from './models.ts'
 
 const styles = ['red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'gray']
 

src/print.ts

@@ -1,7 +1,7 @@
 /* c8 ignore start */
 import { isMainThread, parentPort, workerData } from 'node:worker_threads'
-import { type WorkerContext } from './models.js'
-import { runWorker } from './worker.js'
+import { type WorkerContext } from './models.ts'
+import { runWorker } from './worker.ts'
 
 if (isMainThread) {
   throw new Error('Do not run this file as main script.')

src/runner.ts

@@ -6,7 +6,7 @@ import {
   type TestContext,
   type TestFunction,
   type WorkerContext
-} from './models.js'
+} from './models.ts'
 
 function noOp(): void {
   // No-op

src/worker.ts

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ifError, ok } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro, percentiles } from '../src/index.js'
+import { cronometro, percentiles } from '../src/index.ts'
 
 await new Promise(resolve => setTimeout(resolve, 100))
 

test.env

@@ -1,7 +1,7 @@
 import { deepStrictEqual, match, ok } from 'node:assert'
 import { test } from 'node:test'
 import { Worker, isMainThread, parentPort } from 'node:worker_threads'
-import { cronometro, type Result, type TestFunction } from '../src/index.js'
+import { cronometro, type Result, type TestFunction } from '../src/index.ts'
 
 if (!isMainThread) {
   parentPort!.postMessage('another')
@@ -14,7 +14,11 @@ if (!isMainThread) {
       multiple() {
         throw new Error('INVALID')
       },
-      missing: undefined as unknown as TestFunction
+      missing: undefined as unknown as TestFunction,
+      skipped: {
+        test() {},
+        skip: true
+      }
     },
     () => false
   )
@@ -30,6 +34,10 @@ if (!isMainThread) {
         },
         missing() {
           Buffer.alloc(10)
+        },
+        skipped: {
+          test() {},
+          skip: true
         }
       },
       {

test/asyncImport.test.ts

@@ -1,7 +1,6 @@
 {
   "check-coverage": true,
   "reporter": ["text", "json"],
-  "exclude": ["dist", "test"],
   "branches": 90,
   "functions": 90,
   "lines": 90,

test/callbacks.test.ts

@@ -1,4 +1,6 @@
 {
-  "exclude": ["dist", "test"],
-  "reporter": ["text", "html"]
+  "reporter": ["text", "html"],
+  "all": true,
+  "include": ["src/**/*.ts"],
+  "exclude": ["**/node_modules/**", "test/**/*.ts"]
 }

test/config/c8-ci.json

@@ -0,0 +1 @@
+NODE_OPTIONS="--experimental-strip-types --test-reporter=cleaner-spec-reporter --disable-warning=ExperimentalWarning"

test/config/c8-local.json

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ifError, ok, rejects } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro, percentiles } from '../src/index.js'
+import { cronometro, percentiles } from '../src/index.ts'
 
 if (!isMainThread) {
   cronometro(
@@ -57,7 +57,7 @@ if (!isMainThread) {
   })
 
   test('Runner cannot be run in main thread', async () => {
-    await rejects(import('../src/runner.js'), { message: 'Do not run this file as main script.' })
+    await rejects(import('../src/runner.ts'), { message: 'Do not run this file as main script.' })
   })
 
   test('Runner reports setup errors', async () => {

test/config/env

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ok } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro, type Tests } from '../src/index.js'
+import { cronometro, type Tests } from '../src/index.ts'
 
 if (!isMainThread) {
   cronometro(undefined as unknown as Tests, () => false)

test/errorHandling.test.ts

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ok } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro } from '../src/index.js'
+import { cronometro } from '../src/index.ts'
 
 if (isMainThread) {
   test('Errors are properly handled when no tests are exported in the worker threads', async () => {

test/genericErrorHandling.test.ts

@@ -1,6 +1,6 @@
 import { deepStrictEqual, ok, rejects } from 'node:assert'
 import { test } from 'node:test'
-import { cronometro } from '../src/index.js'
+import { cronometro } from '../src/index.ts'
 
 test('Options validation', async () => {
   await rejects(

test/notTestExportedInWorkers.test.ts

@@ -1,8 +1,8 @@
 import { deepStrictEqual, ifError, match, ok } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro, defaultOptions, percentiles } from '../src/index.js'
-import { setLogger } from '../src/print.js'
+import { cronometro, defaultOptions, percentiles } from '../src/index.ts'
+import { setLogger } from '../src/print.ts'
 
 function removeStyle(source: string): string {
   // eslint-disable-next-line no-control-regex

test/optionsValidation.test.ts

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ifError, ok } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro, percentiles } from '../src/index.js'
+import { cronometro, percentiles } from '../src/index.ts'
 
 if (!isMainThread) {
   cronometro(

test/print.test.ts

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ifError, ok } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro, type SetupFunctionCallback } from '../src/index.js'
+import { cronometro, type SetupFunctionCallback } from '../src/index.ts'
 
 if (!isMainThread) {
   cronometro(

test/success.test.ts

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ifError, ok } from 'node:assert'
 import { test } from 'node:test'
 import { isMainThread } from 'node:worker_threads'
-import { cronometro, percentiles, type Callback } from '../src/index.js'
+import { cronometro, percentiles, type Callback } from '../src/index.ts'
 
 if (!isMainThread) {
   cronometro(

test/testsCallbacks.test.ts

@@ -1,7 +1,7 @@
 import { deepStrictEqual, ifError, ok } from 'node:assert'
 import { test } from 'node:test'
-import { percentiles, type AsyncTest, type Result } from '../src/index.js'
-import { runWorker } from '../src/worker.js'
+import { percentiles, type AsyncTest, type Result } from '../src/index.ts'
+import { runWorker } from '../src/worker.ts'
 
 test('Worker execution - Handle sync functions that succeed', (t, done) => {
   let mainCalls = 0

test/unhandledErrorHandling.test.ts

@@ -15,7 +15,9 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "strictNullChecks": true,
-    "useUnknownInCatchVariables": false
+    "useUnknownInCatchVariables": false,
+    "allowImportingTsExtensions": true,
+    "rewriteRelativeImportExtensions": true
   },
   "include": ["src/*.ts"]
 }