@aljazmc/testero 0.3.2 → 0.4.0

package/bin/types/ambient.d.ts

@@ -0,0 +1,35 @@
+/** The globals of test files, for tsconfig's `types` as `@aljazmc/testero/globals`. */
+import type { DescribeApi, TestApi } from "./collector.js";
+import type Expect from "./expect/expect.js";
+import type Mocks from "./mock.js";
+import type { Body } from "./suite.js";
+type Hook = (body: Body, timeout?: number) => void;
+/** `testero` and `jest`, their methods return them to chain calls. */
+interface Testero {
+    fn: typeof Mocks.fn;
+    spyOn: typeof Mocks.spyOn;
+    isMockFunction: typeof Mocks.isMockFunction;
+    clearAllMocks(): Testero;
+    resetAllMocks(): Testero;
+    restoreAllMocks(): Testero;
+    /** Sets the timeout of the tests and hooks of this file. */
+    setTimeout(timeout: number): Testero;
+}
+declare global {
+    const describe: DescribeApi;
+    const fdescribe: DescribeApi["only"];
+    const xdescribe: DescribeApi["skip"];
+    const test: TestApi;
+    const it: TestApi;
+    const fit: TestApi["only"];
+    const xit: TestApi["skip"];
+    const xtest: TestApi["skip"];
+    const beforeAll: Hook;
+    const afterAll: Hook;
+    const beforeEach: Hook;
+    const afterEach: Hook;
+    const expect: ReturnType<Expect["create"]>;
+    const testero: Testero;
+    const jest: Testero;
+}
+export {};

package/bin/types/collector.d.ts

@@ -1,7 +1,9 @@
 import { type Body, type HookKind, Suite } from "./suite.js";
 type TestFunction = (name: string, body?: Body, timeout?: number) => void;
 type DescribeFunction = (name: string, body: () => unknown) => void;
-type Table = (table: unknown, ...values: unknown[]) => unknown;
+type Row = (...args: any[]) => unknown;
+/** `each` takes a table, then declares a test or suite for each of its rows. */
+type Table = (table: unknown, ...values: unknown[]) => (name: string, body: Row, timeout?: number) => void;
 /** `test` and `it`, with `only`, `skip`, `todo` and `each`. */
 export interface TestApi extends TestFunction {
     only: TestFunction & {

package/bin/types/shared/config/config.d.ts

@@ -0,0 +1,31 @@
+import Ignore from "./ignore.js";
+export interface Options<Rules extends object = object> {
+    ignore: string[];
+    rules: Rules;
+}
+/** A text file found by a tool, with its path relative to the root. */
+export interface Source {
+    file: string;
+    path: string;
+    text: string;
+}
+export default class Config<Rules extends object = object> {
+    #private;
+    static readonly extensions: string[];
+    readonly root: string;
+    readonly ignore: Ignore;
+    readonly rules: Rules;
+    /** What the config file set, before the defaults were merged in. */
+    readonly custom: Partial<Options<Rules>>;
+    constructor(options: Options<Rules>, root?: string, custom?: Partial<Options<Rules>>);
+    static load<Rules extends object>(name: string, defaults: Options<Rules>, root?: string): Promise<Config<Rules>>;
+    /** Handles `--config`, writing the defaults to a TypeScript config file, or with `--config js` a JavaScript one. Returns whether it was given. */
+    static init(name: string, defaults: Options, argv?: string[], root?: string): boolean;
+    /** Writes the defaults to `<name>.config.<extension>` in the root, unless a config file is there already. */
+    static export(name: string, defaults: Options, extension?: string, root?: string): string;
+    /** Deep merges plain objects, anything else in override replaces base. */
+    static merge<T>(base: T, override: unknown): T;
+    files(directory?: string): Generator<string>;
+    /** Text files that are not ignored and that accepts takes, binaries are skipped. */
+    sources(accepts?: (file: string) => boolean): Generator<Source>;
+}

package/bin/types/shared/config/ignore.d.ts

@@ -0,0 +1,5 @@
+export default class Ignore {
+    #private;
+    constructor(sources: readonly string[]);
+    matches(path: string): boolean;
+}

package/bin/types/shared/config/includes.d.ts

@@ -0,0 +1,6 @@
+/** Biome style `includes`: globs in order, the last one matching a file decides, `!` excludes. */
+export default class Includes {
+    #private;
+    constructor(globs: readonly string[]);
+    matches(file: string): boolean;
+}

package/bin/types/shared/config/index.d.ts

@@ -0,0 +1,4 @@
+export type { Options, Source } from "./config.js";
+export { default } from "./config.js";
+export { default as Includes } from "./includes.js";
+export { default as Pattern } from "./pattern.js";

package/bin/types/shared/config/pattern.d.ts

@@ -0,0 +1,5 @@
+export default class Pattern {
+    #private;
+    constructor(source: string);
+    matches(path: string): boolean;
+}

package/bin/types/testero.d.ts

@@ -1,4 +1,4 @@
-import type Config from "@aljazmc/config";
+import type Config from "./shared/config/index.js";
 import Reporter from "./reporter.js";
 import type { Rules } from "./rules.js";
 /** The rules, with what the command line adds to them. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aljazmc/testero",
-  "version": "0.3.2",
-  "description": "A simple, Jest like test runner. Easy to understand, easy to customize and easy to extend.",
+  "version": "0.4.0",
+  "description": "A simple, Jest-like test runner for JavaScript, TypeScript and JSX, compiling tests with esbuild. Easy to understand, easy to customize and easy to extend.",
   "author": "aljazmc",
   "license": "MIT",
   "type": "module",
@@ -20,7 +20,7 @@
     "modular"
   ],
   "engines": {
-    "node": "^22.18.0 || ^24 || ^25 || ^26"
+    "node": "^22.18.0 || ^24.2.0 || ^25 || ^26"
   },
   "types": "./bin/types/testero.d.ts",
   "bin": "./bin/main.js",
@@ -29,6 +29,9 @@
       "types": "./bin/types/testero.d.ts",
       "default": "./bin/main.js"
     },
+    "./globals": {
+      "types": "./bin/types/ambient.d.ts"
+    },
     "./package.json": "./package.json"
   },
   "devDependencies": {