@bicycle-codes/tapzero - npm Package Compare versions

Comparing version 0.9.3 to 0.10.0

dist/fast-deep-equal.d.ts

+export function equal(a: any, b: any): boolean;

dist/index.d.ts

+/**
+ * @param {string} name
+ * @param {TestFn} [fn]
+ * @returns {void}
+ */
+export function only(name: string, fn?: TestFn): void;
+/**
+ * @param {string} _name
+ * @param {TestFn} [_fn]
+ * @returns {void}
+ */
+export function skip(_name: string, _fn?: TestFn): void;
+/**
+ * @param {boolean} strict
+ * @returns {void}
+ */
+export function setStrict(strict: boolean): void;
+/**
+ * @type {{
+ *    (name: string, fn?: TestFn): void
+ *    only(name: string, fn?: TestFn): void
+ *    skip(name: string, fn?: TestFn): void
+ * }}
+ *
+ * @param {string} name
+ * @param {TestFn} [fn]
+ * @returns {void}
+ */
+export function test(name: string, fn?: TestFn): void;
+export namespace test {
+    export { only };
+    export { skip };
+}
+/**
+ * @typedef {(t: Test) => (void | Promise<void>)} TestFn
+ */
+/**
+ * @class
+ */
+export class Test {
+    /**
+     * @constructor
+     * @param {string} name
+     * @param {TestFn} fn
+     * @param {TestRunner} runner
+     */
+    constructor(name: string, fn: TestFn, runner: TestRunner);
+    /** @type {string} */
+    name: string;
+    /** @type {null|number} */
+    _planned: null | number;
+    /** @type {null|number} */
+    _actual: null | number;
+    /** @type {TestFn} */
+    fn: TestFn;
+    /** @type {TestRunner} */
+    runner: TestRunner;
+    /** @type {{ pass: number, fail: number }} */
+    _result: {
+        pass: number;
+        fail: number;
+    };
+    /** @type {boolean} */
+    done: boolean;
+    /** @type {boolean} */
+    strict: boolean;
+    /**
+     * @param {string} msg
+     * @returns {void}
+     */
+    comment(msg: string): void;
+    /**
+     * Plan the number of assertions.
+     *
+     * @param {number} n
+     * @returns {void}
+     */
+    plan(n: number): void;
+    /**
+     * @template T
+     * @param {T} actual
+     * @param {T} expected
+     * @param {string} [msg]
+     * @returns {void}
+     */
+    deepEqual<T>(actual: T, expected: T, msg?: string): void;
+    /**
+     * @template T
+     * @param {T} actual
+     * @param {T} expected
+     * @param {string} [msg]
+     * @returns {void}
+     */
+    notDeepEqual<T_1>(actual: T_1, expected: T_1, msg?: string): void;
+    /**
+     * @template T
+     * @param {T} actual
+     * @param {T} expected
+     * @param {string} [msg]
+     * @returns {void}
+     */
+    equal<T_2>(actual: T_2, expected: T_2, msg?: string): void;
+    /**
+     * @param {unknown} actual
+     * @param {unknown} expected
+     * @param {string} [msg]
+     * @returns {void}
+     */
+    notEqual(actual: unknown, expected: unknown, msg?: string): void;
+    /**
+     * @param {string} [msg]
+     * @returns {void}
+     */
+    fail(msg?: string): void;
+    /**
+     * @param {unknown} actual
+     * @param {string} [msg]
+     * @returns {void}
+     */
+    ok(actual: unknown, msg?: string): void;
+    /**
+     * @param {Error | null | undefined} err
+     * @param {string} [msg]
+     * @returns {void}
+     */
+    ifError(err: Error | null | undefined, msg?: string): void;
+    /**
+     * @param {Function} fn
+     * @param {RegExp | any} [expected]
+     * @param {string} [message]
+     * @returns {void}
+     */
+    throws(fn: Function, expected?: RegExp | any, message?: string): void;
+    /**
+     * @param {boolean} pass
+     * @param {unknown} actual
+     * @param {unknown} expected
+     * @param {string} description
+     * @param {string} operator
+     * @returns {void}
+     */
+    _assert(pass: boolean, actual: unknown, expected: unknown, description: string, operator: string): void;
+    /**
+     * @returns {Promise<{
+     *   pass: number,
+     *   fail: number
+     * }>}
+     */
+    run(): Promise<{
+        pass: number;
+        fail: number;
+    }>;
+}
+/**
+ * @class
+ */
+export class TestRunner {
+    /**
+     * @constructor
+     * @param {(lines: string) => void} [report]
+     */
+    constructor(report?: (lines: string) => void);
+    /** @type {(lines: string) => void} */
+    report: (lines: string) => void;
+    /** @type {Test[]} */
+    tests: Test[];
+    /** @type {Test[]} */
+    onlyTests: Test[];
+    /** @type {boolean} */
+    scheduled: boolean;
+    /** @type {number} */
+    _id: number;
+    /** @type {boolean} */
+    completed: boolean;
+    /** @type {boolean} */
+    rethrowExceptions: boolean;
+    /** @type {boolean} */
+    strict: boolean;
+    /** @type {function | void} */
+    _onFinishCallback: Function | void;
+    /**
+     * @returns {string}
+     */
+    nextId(): string;
+    /**
+     * @param {string} name
+     * @param {TestFn} fn
+     * @param {boolean} only
+     * @returns {void}
+     */
+    add(name: string, fn: TestFn, only: boolean): void;
+    /**
+     * @returns {Promise<void>}
+     */
+    run(): Promise<void>;
+    /**
+     * @param {(result: { total: number, success: number, fail: number }) => void} callback
+     * @returns {void}
+     */
+    onFinish(callback: (result: {
+        total: number;
+        success: number;
+        fail: number;
+    }) => void): void;
+}
+export const GLOBAL_TEST_RUNNER: TestRunner;
+export type TestFn = (t: Test) => (void | Promise<void>);

package.json

 {
   "name": "@bicycle-codes/tapzero",
-  "version": "0.9.3",
+  "version": "0.10.0",
   "description": "Smallest test library",
@@ -8,6 +8,7 @@ "main": "dist/index.js",
   "scripts": {
-    "build": "mkdir -p ./dist && rm -rf ./dist/* && npm run build-cjs && npm run build-esm",
+    "build": "mkdir -p ./dist && rm -rf ./dist/* && npm run build-cjs && npm run build-esm && npm run build-types",
     "build-cjs": "esbuild ./index.js --bundle --format=cjs --keep-names --outdir=./dist --out-extension:.js=.cjs",
     "build-esm": "esbuild index.js --bundle --format=esm --keep-names --outdir=./dist",
     "test": "npm run build && node ./test/index.js | tap-arc",
+    "build-types": "tsc ./index.js --declaration --emitDeclarationOnly --allowJs --outDir dist",
     "coverage": "type-coverage",
@@ -63,3 +64,3 @@ "report": "typescript-coverage-report && open coverage-ts/index.html",
     "type-coverage": "2.27.1",
-    "typescript": "5.3.3",
+    "typescript": "5.4.5",
     "typescript-coverage-report": "^1.0.0"
@@ -66,0 +67,0 @@ },

README.md

 # tapzero
 ![tests](https://github.com/bicycle-codes/tapzero/actions/workflows/nodejs.yml/badge.svg)
-[![Socket Badge](https://socket.dev/api/badge/npm/package/@bicycle-codes/tapzero)](https://socket.dev/npm/package/@bicycle-codes/tapzero)
 [![module](https://img.shields.io/badge/module-ESM%2FCJS-blue?style=flat-square)](README.md)
@@ -5,0 +4,0 @@ [![dependencies](https://img.shields.io/badge/dependencies-zero-brightgreen.svg?style=flat-square)](package.json)

No alert changes

Improved metrics

Total package byte prevSize

42223

13.52%

Number of package files

7

40%

Lines of code

1266

19.66%

Worsened metrics

Number of lines in readme file

187

-0.53%

No dependency changes