@logtape/testing-node 2.3.0-dev.0

package/dist/mod.js

@@ -0,0 +1,143 @@
+import nodeTest, { after, afterEach, before, beforeEach, describe, it as it$1, mock, run, suite } from "node:test";
+import { createFailureLogReporter } from "@logtape/testing/reporter";
+
+//#region src/mod.ts
+/**
+* Creates a `node:test` test function that reports LogTape records from failed
+* test callbacks.
+*
+* The returned function preserves Node.js test options and shorthand helpers
+* such as `test.only()`, `test.skip()`, and `test.todo()`.  Only callback
+* arguments are adapted; options are passed through to `node:test`.
+*
+* @param options Failure log reporter options.
+* @returns A configured `node:test`-compatible test function.
+* @since 2.3.0
+*/
+function createTest(options = {}) {
+	return createNodeTestFunction(nodeTest, options);
+}
+/**
+* Creates an `it()` alias that reports LogTape records from failed test
+* callbacks.
+*
+* @param options Failure log reporter options.
+* @returns A configured `node:test`-compatible `it()` function.
+* @since 2.3.0
+*/
+function createIt(options = {}) {
+	return createNodeTestFunction(it$1, options);
+}
+/**
+* A `node:test` test function that reports LogTape records from failed test
+* callbacks using the default reporter options.
+*
+* @since 2.3.0
+*/
+const test = createTest();
+/**
+* A `node:test` `it()` alias that reports LogTape records from failed test
+* callbacks using the default reporter options.
+*
+* @since 2.3.0
+*/
+const it = createIt();
+/**
+* Shorthand for marking a test as `only`.
+*
+* @since 2.3.0
+*/
+const only = test.only;
+/**
+* Shorthand for skipping a test.
+*
+* @since 2.3.0
+*/
+const skip = test.skip;
+/**
+* Shorthand for marking a test as TODO.
+*
+* @since 2.3.0
+*/
+const todo = test.todo;
+/**
+* Shorthand for expecting a test to fail when supported by the active Node.js
+* runtime.
+*
+* @since 2.3.0
+*/
+const expectFailure = test.expectFailure;
+/**
+* Node.js' test assertion tracker when supported by the active runtime.
+*
+* @since 2.3.0
+*/
+const assert = test.assert;
+/**
+* Node.js' snapshot helper when supported by the active runtime.
+*
+* @since 2.3.0
+*/
+const snapshot = test.snapshot;
+var src_default = test;
+function createNodeTestFunction(baseTest, options, includeExtendedProperties = true) {
+	const register = (...args) => Reflect.apply(baseTest, void 0, wrapCallbackArgument(args, options));
+	const baseExpectFailure = baseTest.expectFailure;
+	const wrapped = Object.assign(register, baseTest, {
+		only: (...args) => Reflect.apply(baseTest.only, void 0, wrapCallbackArgument(args, options)),
+		skip: (...args) => Reflect.apply(baseTest.skip, void 0, wrapCallbackArgument(args, options)),
+		todo: (...args) => Reflect.apply(baseTest.todo, void 0, wrapCallbackArgument(args, options)),
+		expectFailure: typeof baseExpectFailure === "function" ? (...args) => Reflect.apply(baseExpectFailure, void 0, wrapCallbackArgument(args, options)) : void 0
+	});
+	if (includeExtendedProperties) {
+		if (typeof baseTest.it === "function") Object.defineProperty(wrapped, "it", {
+			configurable: true,
+			enumerable: true,
+			value: createNodeTestFunction(baseTest.it, options, false),
+			writable: true
+		});
+		if (typeof baseTest.test === "function") Object.defineProperty(wrapped, "test", {
+			configurable: true,
+			enumerable: true,
+			value: wrapped,
+			writable: true
+		});
+	}
+	return wrapped;
+}
+function wrapCallbackArgument(args, options) {
+	const callback = args.at(-1);
+	if (typeof callback !== "function") return [...args];
+	const reporter = createFailureLogReporter(options);
+	const wrapped = wrapNodeCallback(reporter.wrap.bind(reporter), callback);
+	return [...args.slice(0, -1), wrapped];
+}
+function wrapNodeCallback(wrap, callback) {
+	if (callback.length >= 2) return function(context, done) {
+		const runCallback = (...args) => Reflect.apply(callback, this, args);
+		wrap(() => new Promise((resolve, reject) => {
+			let settled = false;
+			const wrappedDone = (error) => {
+				if (settled) return;
+				settled = true;
+				if (error == null) resolve();
+				else reject(error);
+			};
+			try {
+				runCallback(context, wrappedDone);
+			} catch (error) {
+				reject(error);
+			}
+		}))().then(() => done(), (error) => done(error));
+	};
+	if (callback.length === 0) return function() {
+		return wrap(() => Reflect.apply(callback, this, []))();
+	};
+	return function(context) {
+		return wrap(() => Reflect.apply(callback, this, [context]))();
+	};
+}
+
+//#endregion
+export { after, afterEach, assert, before, beforeEach, createIt, createTest, src_default as default, describe, expectFailure, it, mock, only, run, skip, snapshot, suite, test, todo };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: FailureLogReporterOptions","nodeIt","test: NodeTestFunction","it: NodeTestFunction","only: NodeTestFunction","skip: NodeTestFunction","todo: NodeTestFunction","expectFailure: NodeTestFunction | undefined","assert: unknown","snapshot: unknown","baseTest: BaseNodeTestFunction","args: readonly unknown[]","wrap: ReturnType<typeof createFailureLogReporter>[\"wrap\"]","callback: AnyFunction","context: TestContext","done: NodeDoneCallback","wrappedDone: NodeDoneCallback","error?: unknown","error: unknown"],"sources":["../src/mod.ts"],"sourcesContent":["import nodeTest, { it as nodeIt } from \"node:test\";\nimport type { TestContext } from \"node:test\";\n\nimport {\n  createFailureLogReporter,\n  type FailureLogReporterOptions,\n} from \"@logtape/testing/reporter\";\n\nexport type {\n  FailureLogReporterOptions,\n  FailureLogReportMode,\n} from \"@logtape/testing/reporter\";\nexport {\n  after,\n  afterEach,\n  before,\n  beforeEach,\n  describe,\n  mock,\n  run,\n  suite,\n} from \"node:test\";\n\n/**\n * Options accepted by Node.js `test()` and `it()` functions.\n *\n * The shape intentionally mirrors Node's documented option bag while allowing\n * newer Node.js options to pass through even when a runtime's bundled TypeScript\n * declarations lag behind the current documentation.\n *\n * @since 2.3.0\n */\nexport interface NodeTestOptions {\n  readonly concurrency?: number | boolean;\n  readonly expectFailure?:\n    | boolean\n    | string\n    | RegExp\n    | ((error: unknown) => boolean)\n    | object\n    | Error;\n  readonly only?: boolean;\n  readonly signal?: AbortSignal;\n  readonly skip?: boolean | string;\n  readonly tags?: readonly string[];\n  readonly todo?: boolean | string;\n  readonly timeout?: number;\n  readonly plan?: number;\n}\n\n/**\n * A callback passed to Node.js `test()` or `it()`.\n *\n * @since 2.3.0\n */\nexport type NodeTestCallback = (\n  context: TestContext,\n  done?: NodeDoneCallback,\n) => unknown;\n\n/**\n * A Node.js `test()`-compatible function.\n *\n * @since 2.3.0\n */\nexport interface NodeTestFunction {\n  (name?: string, options?: NodeTestOptions, fn?: NodeTestCallback): Promise<\n    void\n  >;\n  (name?: string, fn?: NodeTestCallback): Promise<void>;\n  (options?: NodeTestOptions, fn?: NodeTestCallback): Promise<void>;\n  (fn?: NodeTestCallback): Promise<void>;\n  readonly only: NodeTestFunction;\n  readonly skip: NodeTestFunction;\n  readonly todo: NodeTestFunction;\n  readonly expectFailure?: NodeTestFunction;\n  readonly it?: NodeTestFunction;\n  readonly test?: NodeTestFunction;\n}\n\ntype NodeDoneCallback = (error?: unknown) => void;\ntype AnyFunction = (...args: never[]) => unknown;\ntype BaseNodeTestFunction = AnyFunction & {\n  readonly only: AnyFunction;\n  readonly skip: AnyFunction;\n  readonly todo: AnyFunction;\n  readonly expectFailure?: AnyFunction;\n  readonly it?: AnyFunction;\n  readonly test?: AnyFunction;\n};\n\n/**\n * Creates a `node:test` test function that reports LogTape records from failed\n * test callbacks.\n *\n * The returned function preserves Node.js test options and shorthand helpers\n * such as `test.only()`, `test.skip()`, and `test.todo()`.  Only callback\n * arguments are adapted; options are passed through to `node:test`.\n *\n * @param options Failure log reporter options.\n * @returns A configured `node:test`-compatible test function.\n * @since 2.3.0\n */\nexport function createTest(\n  options: FailureLogReporterOptions = {},\n): NodeTestFunction {\n  return createNodeTestFunction(\n    nodeTest as unknown as BaseNodeTestFunction,\n    options,\n  );\n}\n\n/**\n * Creates an `it()` alias that reports LogTape records from failed test\n * callbacks.\n *\n * @param options Failure log reporter options.\n * @returns A configured `node:test`-compatible `it()` function.\n * @since 2.3.0\n */\nexport function createIt(\n  options: FailureLogReporterOptions = {},\n): NodeTestFunction {\n  return createNodeTestFunction(\n    nodeIt as unknown as BaseNodeTestFunction,\n    options,\n  );\n}\n\n/**\n * A `node:test` test function that reports LogTape records from failed test\n * callbacks using the default reporter options.\n *\n * @since 2.3.0\n */\nexport const test: NodeTestFunction = createTest();\n\n/**\n * A `node:test` `it()` alias that reports LogTape records from failed test\n * callbacks using the default reporter options.\n *\n * @since 2.3.0\n */\nexport const it: NodeTestFunction = createIt();\n\n/**\n * Shorthand for marking a test as `only`.\n *\n * @since 2.3.0\n */\nexport const only: NodeTestFunction = test.only;\n\n/**\n * Shorthand for skipping a test.\n *\n * @since 2.3.0\n */\nexport const skip: NodeTestFunction = test.skip;\n\n/**\n * Shorthand for marking a test as TODO.\n *\n * @since 2.3.0\n */\nexport const todo: NodeTestFunction = test.todo;\n\n/**\n * Shorthand for expecting a test to fail when supported by the active Node.js\n * runtime.\n *\n * @since 2.3.0\n */\nexport const expectFailure: NodeTestFunction | undefined = test.expectFailure;\n\n/**\n * Node.js' test assertion tracker when supported by the active runtime.\n *\n * @since 2.3.0\n */\nexport const assert: unknown = (test as { readonly assert?: unknown }).assert;\n\n/**\n * Node.js' snapshot helper when supported by the active runtime.\n *\n * @since 2.3.0\n */\nexport const snapshot: unknown = (test as { readonly snapshot?: unknown })\n  .snapshot;\n\nexport default test;\n\nfunction createNodeTestFunction(\n  baseTest: BaseNodeTestFunction,\n  options: FailureLogReporterOptions,\n  includeExtendedProperties = true,\n): NodeTestFunction {\n  const register = ((...args: unknown[]) =>\n    Reflect.apply(\n      baseTest,\n      undefined,\n      wrapCallbackArgument(args, options),\n    )) as NodeTestFunction;\n\n  const baseExpectFailure = baseTest.expectFailure;\n  const wrapped = Object.assign(register, baseTest, {\n    only: ((...args: unknown[]) =>\n      Reflect.apply(\n        baseTest.only,\n        undefined,\n        wrapCallbackArgument(args, options),\n      )) as NodeTestFunction[\"only\"],\n    skip: ((...args: unknown[]) =>\n      Reflect.apply(\n        baseTest.skip,\n        undefined,\n        wrapCallbackArgument(args, options),\n      )) as NodeTestFunction[\"skip\"],\n    todo: ((...args: unknown[]) =>\n      Reflect.apply(\n        baseTest.todo,\n        undefined,\n        wrapCallbackArgument(args, options),\n      )) as NodeTestFunction[\"todo\"],\n    expectFailure: typeof baseExpectFailure === \"function\"\n      ? ((...args: unknown[]) =>\n        Reflect.apply(\n          baseExpectFailure,\n          undefined,\n          wrapCallbackArgument(args, options),\n        )) as NodeTestFunction[\"expectFailure\"]\n      : undefined,\n  });\n\n  if (includeExtendedProperties) {\n    if (typeof baseTest.it === \"function\") {\n      Object.defineProperty(wrapped, \"it\", {\n        configurable: true,\n        enumerable: true,\n        value: createNodeTestFunction(\n          baseTest.it as BaseNodeTestFunction,\n          options,\n          false,\n        ),\n        writable: true,\n      });\n    }\n    if (typeof baseTest.test === \"function\") {\n      Object.defineProperty(wrapped, \"test\", {\n        configurable: true,\n        enumerable: true,\n        value: wrapped,\n        writable: true,\n      });\n    }\n  }\n\n  return wrapped;\n}\n\nfunction wrapCallbackArgument(\n  args: readonly unknown[],\n  options: FailureLogReporterOptions,\n): unknown[] {\n  const callback = args.at(-1);\n  if (typeof callback !== \"function\") return [...args];\n\n  const reporter = createFailureLogReporter(options);\n  const wrapped = wrapNodeCallback(\n    reporter.wrap.bind(reporter),\n    callback as unknown as AnyFunction,\n  );\n  return [...args.slice(0, -1), wrapped];\n}\n\nfunction wrapNodeCallback(\n  wrap: ReturnType<typeof createFailureLogReporter>[\"wrap\"],\n  callback: AnyFunction,\n): AnyFunction {\n  if (callback.length >= 2) {\n    return function (\n      this: unknown,\n      context: TestContext,\n      done: NodeDoneCallback,\n    ): void {\n      const runCallback = (...args: readonly unknown[]): unknown =>\n        Reflect.apply(callback, this, args);\n      void wrap(() =>\n        new Promise<void>((resolve, reject) => {\n          let settled = false;\n          const wrappedDone: NodeDoneCallback = ((error?: unknown) => {\n            if (settled) return;\n            settled = true;\n            if (error == null) resolve();\n            else reject(error);\n          }) as NodeDoneCallback;\n\n          try {\n            runCallback(context, wrappedDone);\n          } catch (error) {\n            reject(error);\n          }\n        })\n      )().then(\n        () => done(),\n        (error: unknown) => done(error),\n      );\n    };\n  }\n\n  if (callback.length === 0) {\n    return function (this: unknown): Promise<unknown> {\n      return wrap(() => Reflect.apply(callback, this, []))();\n    };\n  }\n\n  return function (this: unknown, context: TestContext): Promise<unknown> {\n    return wrap(() => Reflect.apply(callback, this, [context]))();\n  };\n}\n\nexport type { TestContext };\n"],"mappings":";;;;;;;;;;;;;;;;AAuGA,SAAgB,WACdA,UAAqC,CAAE,GACrB;AAClB,QAAO,uBACL,UACA,QACD;AACF;;;;;;;;;AAUD,SAAgB,SACdA,UAAqC,CAAE,GACrB;AAClB,QAAO,uBACLC,MACA,QACD;AACF;;;;;;;AAQD,MAAaC,OAAyB,YAAY;;;;;;;AAQlD,MAAaC,KAAuB,UAAU;;;;;;AAO9C,MAAaC,OAAyB,KAAK;;;;;;AAO3C,MAAaC,OAAyB,KAAK;;;;;;AAO3C,MAAaC,OAAyB,KAAK;;;;;;;AAQ3C,MAAaC,gBAA8C,KAAK;;;;;;AAOhE,MAAaC,SAAmB,KAAuC;;;;;;AAOvE,MAAaC,WAAqB,KAC/B;AAEH,kBAAe;AAEf,SAAS,uBACPC,UACAV,SACA,4BAA4B,MACV;CAClB,MAAM,WAAY,CAAC,GAAG,SACpB,QAAQ,MACN,kBAEA,qBAAqB,MAAM,QAAQ,CACpC;CAEH,MAAM,oBAAoB,SAAS;CACnC,MAAM,UAAU,OAAO,OAAO,UAAU,UAAU;EAChD,MAAO,CAAC,GAAG,SACT,QAAQ,MACN,SAAS,cAET,qBAAqB,MAAM,QAAQ,CACpC;EACH,MAAO,CAAC,GAAG,SACT,QAAQ,MACN,SAAS,cAET,qBAAqB,MAAM,QAAQ,CACpC;EACH,MAAO,CAAC,GAAG,SACT,QAAQ,MACN,SAAS,cAET,qBAAqB,MAAM,QAAQ,CACpC;EACH,sBAAsB,sBAAsB,aACvC,CAAC,GAAG,SACL,QAAQ,MACN,2BAEA,qBAAqB,MAAM,QAAQ,CACpC;CAEN,EAAC;AAEF,KAAI,2BAA2B;AAC7B,aAAW,SAAS,OAAO,WACzB,QAAO,eAAe,SAAS,MAAM;GACnC,cAAc;GACd,YAAY;GACZ,OAAO,uBACL,SAAS,IACT,SACA,MACD;GACD,UAAU;EACX,EAAC;AAEJ,aAAW,SAAS,SAAS,WAC3B,QAAO,eAAe,SAAS,QAAQ;GACrC,cAAc;GACd,YAAY;GACZ,OAAO;GACP,UAAU;EACX,EAAC;CAEL;AAED,QAAO;AACR;AAED,SAAS,qBACPW,MACAX,SACW;CACX,MAAM,WAAW,KAAK,GAAG,GAAG;AAC5B,YAAW,aAAa,WAAY,QAAO,CAAC,GAAG,IAAK;CAEpD,MAAM,WAAW,yBAAyB,QAAQ;CAClD,MAAM,UAAU,iBACd,SAAS,KAAK,KAAK,SAAS,EAC5B,SACD;AACD,QAAO,CAAC,GAAG,KAAK,MAAM,GAAG,GAAG,EAAE,OAAQ;AACvC;AAED,SAAS,iBACPY,MACAC,UACa;AACb,KAAI,SAAS,UAAU,EACrB,QAAO,SAELC,SACAC,MACM;EACN,MAAM,cAAc,CAAC,GAAG,SACtB,QAAQ,MAAM,UAAU,MAAM,KAAK;AACrC,EAAK,KAAK,MACR,IAAI,QAAc,CAAC,SAAS,WAAW;GACrC,IAAI,UAAU;GACd,MAAMC,cAAiC,CAACC,UAAoB;AAC1D,QAAI,QAAS;AACb,cAAU;AACV,QAAI,SAAS,KAAM,UAAS;QACvB,QAAO,MAAM;GACnB;AAED,OAAI;AACF,gBAAY,SAAS,YAAY;GAClC,SAAQ,OAAO;AACd,WAAO,MAAM;GACd;EACF,GACF,EAAE,CAAC,KACF,MAAM,MAAM,EACZ,CAACC,UAAmB,KAAK,MAAM,CAChC;CACF;AAGH,KAAI,SAAS,WAAW,EACtB,QAAO,WAA2C;AAChD,SAAO,KAAK,MAAM,QAAQ,MAAM,UAAU,MAAM,CAAE,EAAC,CAAC,EAAE;CACvD;AAGH,QAAO,SAAyBJ,SAAwC;AACtE,SAAO,KAAK,MAAM,QAAQ,MAAM,UAAU,MAAM,CAAC,OAAQ,EAAC,CAAC,EAAE;CAC9D;AACF"}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@logtape/testing-node",
+  "version": "2.3.0-dev.0",
+  "description": "Node.js test runner integration for LogTape failure log reporting",
+  "keywords": [
+    "logging",
+    "log",
+    "logger",
+    "logtape",
+    "testing",
+    "test",
+    "node:test"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Hong Minhee",
+    "email": "hong@minhee.org",
+    "url": "https://hongminhee.org/"
+  },
+  "homepage": "https://logtape.org/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dahlia/logtape.git",
+    "directory": "packages/testing-node/"
+  },
+  "bugs": {
+    "url": "https://github.com/dahlia/logtape/issues"
+  },
+  "funding": [
+    "https://github.com/sponsors/dahlia"
+  ],
+  "type": "module",
+  "module": "./dist/mod.js",
+  "main": "./dist/mod.cjs",
+  "types": "./dist/mod.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/mod.d.ts",
+        "require": "./dist/mod.d.cts"
+      },
+      "import": "./dist/mod.js",
+      "require": "./dist/mod.cjs"
+    },
+    "./autoload": {
+      "types": {
+        "import": "./dist/autoload.d.ts",
+        "require": "./dist/autoload.d.cts"
+      },
+      "import": "./dist/autoload.js",
+      "require": "./dist/autoload.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": [
+    "./dist/autoload.js",
+    "./dist/autoload.cjs"
+  ],
+  "files": [
+    "dist/"
+  ],
+  "dependencies": {
+    "@logtape/testing": "^2.3.0"
+  },
+  "peerDependencies": {
+    "@logtape/logtape": "^2.3.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3",
+    "@logtape/logtape": "^2.3.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepublish": "tsdown",
+    "test": "tsdown && node --experimental-transform-types --test",
+    "test:bun": "tsdown && bun test",
+    "test:deno": "deno test --allow-read",
+    "test-all": "tsdown && node --experimental-transform-types --test && bun test && deno test --allow-read"
+  }
+}