@japa/runner 3.0.0-7 → 3.0.0-9

package/build/examples/dot.d.ts

@@ -0,0 +1 @@
+export {};

package/build/examples/dot.js

@@ -0,0 +1,11 @@
+import { dot } from '../src/reporters/main.js';
+import { createDiverseTests, runner } from '../factories/main.js';
+await runner()
+    .configure({
+    files: [],
+    reporters: {
+        list: [dot()],
+        activated: ['dot'],
+    },
+})
+    .runSuites(createDiverseTests);

package/build/examples/ndjson.d.ts

@@ -0,0 +1 @@
+export {};

package/build/examples/ndjson.js

@@ -0,0 +1,11 @@
+import { ndjson } from '../src/reporters/main.js';
+import { createDiverseTests, runner } from '../factories/main.js';
+await runner()
+    .configure({
+    files: [],
+    reporters: {
+        list: [ndjson()],
+        activated: ['ndjson'],
+    },
+})
+    .runSuites(createDiverseTests);

package/build/examples/spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/examples/spec.js

@@ -0,0 +1,11 @@
+import { spec } from '../src/reporters/main.js';
+import { createDiverseTests, runner } from '../factories/main.js';
+await runner()
+    .configure({
+    files: [],
+    reporters: {
+        list: [spec()],
+        activated: ['spec'],
+    },
+})
+    .runSuites(createDiverseTests);

package/build/factories/create_diverse_tests.d.ts

@@ -0,0 +1,6 @@
+import { Suite, Emitter, Refiner } from '../modules/core/main.js';
+/**
+ * Returns an array of suites with dummy tests reproducting
+ * different test behavior
+ */
+export declare function createDiverseTests(emitter: Emitter, refiner: Refiner, file?: string): Suite[];

package/build/factories/create_diverse_tests.js

@@ -0,0 +1,106 @@
+import assert from 'node:assert';
+import { Suite } from '../modules/core/main.js';
+import { createTest, createTestGroup } from '../src/create_test.js';
+/**
+ * Creates a unit tests suite with bunch of dummy tests
+ * reproducing different tests behavior
+ */
+function createUnitTestsSuite(emitter, refiner, file) {
+    const suite = new Suite('unit', emitter, refiner);
+    const group = createTestGroup('Maths#add', emitter, refiner, {
+        suite,
+        file,
+    });
+    createTest('A top level test inside a suite', emitter, refiner, {
+        suite,
+        file,
+    }).run(() => { });
+    createTest('add two numbers', emitter, refiner, { group, file }).run(() => {
+        assert.equal(2 + 2, 4);
+    });
+    createTest('add three numbers', emitter, refiner, {
+        group,
+        file,
+    }).run(() => {
+        assert.equal(2 + 2 + 2, 6);
+    });
+    createTest('add group of numbers', emitter, refiner, { group, file });
+    createTest('use math.js lib', emitter, refiner, { group, file }).skip(true, 'Library work pending');
+    createTest('add multiple numbers', emitter, refiner, {
+        file,
+        group,
+    }).run(() => {
+        assert.equal(2 + 2 + 2 + 2, 6);
+    });
+    createTest('add floating numbers', emitter, refiner, { group, file })
+        .run(() => {
+        assert.equal(2 + 2.2 + 2.1, 6);
+    })
+        .fails('Have to add support for floating numbers');
+    createTest('A test with an error that is not an AssertionError', emitter, refiner, {
+        group,
+        file,
+    }).run(() => {
+        throw new Error('This is an error');
+    });
+    return suite;
+}
+/**
+ * Creates a unit functional suite with bunch of dummy tests
+ * reproducing different tests behavior
+ */
+function createFunctionalTestsSuite(emitter, refiner, file) {
+    const suite = new Suite('functional', emitter, refiner);
+    const group = createTestGroup('Users/store', emitter, refiner, {
+        suite,
+        file: file,
+    });
+    createTest('Validate user data', emitter, refiner, {
+        group,
+        file: file,
+    }).run(() => { });
+    createTest('Disallow duplicate emails', emitter, refiner, {
+        group,
+        file: file,
+    }).run(() => { });
+    createTest('Disallow duplicate emails across tenants', emitter, refiner, {
+        group,
+        file: file,
+    }).run(() => {
+        const users = ['', ''];
+        assert.equal(users.length, 1);
+    });
+    createTest('Normalize email before persisting it', emitter, refiner, {
+        group,
+        file: file,
+    }).skip(true, 'Have to build a normalizer');
+    createTest('Send email verification mail', emitter, refiner, {
+        group,
+        file: file,
+    });
+    const usersListGroup = createTestGroup('Users/list', emitter, refiner, {
+        suite,
+        file: file,
+    });
+    usersListGroup.setup(() => {
+        throw new Error('Unable to cleanup database');
+    });
+    createTest('A test that will never because the group hooks fails', emitter, refiner, {
+        group: usersListGroup,
+    });
+    createTest('A top level test inside functional suite', emitter, refiner, {
+        suite,
+        file: file,
+    }).run(() => { });
+    return suite;
+}
+/**
+ * Returns an array of suites with dummy tests reproducting
+ * different test behavior
+ */
+export function createDiverseTests(emitter, refiner, file) {
+    return [
+        createUnitTestsSuite(emitter, refiner, file),
+        createFunctionalTestsSuite(emitter, refiner, file),
+    ];
+}

package/build/factories/main.d.ts

@@ -1,5 +1,8 @@
+import { ReporterContract } from '../src/types.js';
 import { RunnerFactory } from './runner.js';
 /**
  * Create an instance of the runner factory
  */
 export declare const runner: () => RunnerFactory;
+export { createDiverseTests } from './create_diverse_tests.js';
+export declare const syncReporter: ReporterContract;

package/build/factories/main.js

@@ -11,3 +11,15 @@ import { RunnerFactory } from './runner.js';
  * Create an instance of the runner factory
  */
 export const runner = () => new RunnerFactory();
+export { createDiverseTests } from './create_diverse_tests.js';
+export const syncReporter = {
+    name: 'sync',
+    handler(r, emitter) {
+        emitter.on('runner:end', function () {
+            const summary = r.getSummary();
+            if (summary.hasError) {
+                throw summary.failureTree[0].children[0].errors[0].error;
+            }
+        });
+    },
+};

package/build/factories/runner.d.ts

@@ -1,5 +1,5 @@
-import { Config } from '../src/types.js';
-import { Suite, Emitter } from '../modules/core/main.js';
+import { Suite, Emitter, TestContext, Refiner } from '../modules/core/main.js';
+import type { Config, TestExecutor, RunnerSummary } from '../src/types.js';
 /**
  * Runner factory exposes the API to run dummy suites, groups and tests.
  * You might want to use the factory for testing reporters and
@@ -11,17 +11,16 @@ export declare class RunnerFactory {
      * Configure runner
      */
     configure(config: Config, argv?: string[]): this;
-    /**
-     * Register custom suites to execute instead
-     * of the dummy one's
-     */
-    withSuites(suites: Suite[]): this;
     /**
      * Define a custom emitter instance to use
      */
     useEmitter(emitter: Emitter): this;
+    /**
+     * Run a test using the runner
+     */
+    runTest(title: string, callback: TestExecutor<TestContext, undefined>): Promise<RunnerSummary>;
     /**
      * Run dummy tests. You might use
      */
-    run(): Promise<import("@japa/core/types").RunnerSummary>;
+    runSuites(suites: (emitter: Emitter, refiner: Refiner, file?: string) => Suite[]): Promise<RunnerSummary>;
 }

package/build/factories/runner.js

@@ -6,13 +6,12 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import assert from 'node:assert';
 import { fileURLToPath } from 'node:url';
 import { Planner } from '../src/planner.js';
 import { GlobalHooks } from '../src/hooks.js';
 import { CliParser } from '../src/cli_parser.js';
+import { createTest } from '../src/create_test.js';
 import { ConfigManager } from '../src/config_manager.js';
-import { createTest, createTestGroup } from '../src/create_test.js';
 import { Suite, Runner, Emitter } from '../modules/core/main.js';
 /**
  * Runner factory exposes the API to run dummy suites, groups and tests.
@@ -23,118 +22,10 @@ export class RunnerFactory {
     #emitter = new Emitter();
     #config;
     #cliArgs;
-    #suites;
     #file = fileURLToPath(import.meta.url);
     get #refiner() {
         return this.#config.refiner;
     }
-    /**
-     * Creating unit and functional suites
-     */
-    #createSuites() {
-        return [
-            new Suite('unit', this.#emitter, this.#refiner),
-            new Suite('functional', this.#emitter, this.#refiner),
-        ];
-    }
-    /**
-     * Creates a variety of tests for Maths.add method
-     */
-    #createAdditionTests(group) {
-        createTest('add two numbers', this.#emitter, this.#refiner, { group, file: this.#file }).run(() => {
-            assert.equal(2 + 2, 4);
-        });
-        createTest('add three numbers', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => {
-            assert.equal(2 + 2 + 2, 6);
-        });
-        createTest('add group of numbers', this.#emitter, this.#refiner, { group, file: this.#file });
-        createTest('use math.js lib', this.#emitter, this.#refiner, { group, file: this.#file }).skip(true, 'Library work pending');
-        createTest('add multiple numbers', this.#emitter, this.#refiner, {
-            file: this.#file,
-            group,
-        }).run(() => {
-            assert.equal(2 + 2 + 2 + 2, 6);
-        });
-        createTest('add floating numbers', this.#emitter, this.#refiner, { group, file: this.#file })
-            .run(() => {
-            assert.equal(2 + 2.2 + 2.1, 6);
-        })
-            .fails('Have to add support for floating numbers');
-        createTest('A test with an error that is not an AssertionError', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => {
-            throw new Error('This is an error');
-        });
-    }
-    /**
-     * Creates a variety of dummy tests for creating
-     * a new user
-     */
-    #createUserStoreTests(group) {
-        createTest('Validate user data', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => { });
-        createTest('Disallow duplicate emails', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => { });
-        createTest('Disallow duplicate emails across tenants', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => {
-            const users = ['', ''];
-            assert.equal(users.length, 1);
-        });
-        createTest('Normalize email before persisting it', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).skip(true, 'Have to build a normalizer');
-        createTest('Send email verification mail', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        });
-    }
-    /**
-     * Creates tests for the unit tests suite
-     */
-    #createUnitTests(suite) {
-        const additionGroup = createTestGroup('Maths#add', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        });
-        this.#createAdditionTests(additionGroup);
-        createTest('A top level test inside a suite', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        }).run(() => { });
-    }
-    /**
-     * Creates tests for the functional tests suite
-     */
-    #createFunctionalTests(suite) {
-        const usersStoreGroup = createTestGroup('Users/store', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        });
-        this.#createUserStoreTests(usersStoreGroup);
-        const usersListGroup = createTestGroup('Users/list', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        });
-        usersListGroup.setup(() => {
-            throw new Error('Unable to cleanup database');
-        });
-        createTest('A test that will never because the group hooks fails', this.#emitter, this.#refiner, { group: usersListGroup });
-        createTest('A top level test inside functional suite', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        }).run(() => { });
-    }
     /**
      * Registers plugins
      */
@@ -156,14 +47,6 @@ export class RunnerFactory {
         this.#config = new ConfigManager(config, this.#cliArgs).hydrate();
         return this;
     }
-    /**
-     * Register custom suites to execute instead
-     * of the dummy one's
-     */
-    withSuites(suites) {
-        this.#suites = suites;
-        return this;
-    }
     /**
      * Define a custom emitter instance to use
      */
@@ -171,10 +54,23 @@ export class RunnerFactory {
         this.#emitter = emitter;
         return this;
     }
+    /**
+     * Run a test using the runner
+     */
+    async runTest(title, callback) {
+        return this.runSuites((emitter, refiner, file) => {
+            const defaultSuite = new Suite('default', emitter, refiner);
+            createTest(title, emitter, refiner, {
+                suite: defaultSuite,
+                file: file,
+            }).run(callback);
+            return [defaultSuite];
+        });
+    }
     /**
      * Run dummy tests. You might use
      */
-    async run() {
+    async runSuites(suites) {
         const runner = new Runner(this.#emitter);
         await this.#registerPlugins(runner);
         const { config, reporters, refinerFilters } = await new Planner(this.#config).plan();
@@ -186,16 +82,7 @@ export class RunnerFactory {
         refinerFilters.forEach((filter) => {
             config.refiner.add(filter.layer, filter.filters);
         });
-        if (this.#suites) {
-            this.#suites.forEach((suite) => runner.add(suite));
-        }
-        else {
-            const [unit, functional] = this.#createSuites();
-            this.#createUnitTests(unit);
-            runner.add(unit);
-            this.#createFunctionalTests(functional);
-            runner.add(functional);
-        }
+        suites(this.#emitter, this.#refiner, this.#file).forEach((suite) => runner.add(suite));
         await globalHooks.setup(runner);
         await runner.start();
         await runner.exec();

package/build/modules/core/main.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" resolution-mode="require"/>
 import { Emitter, Refiner, Test as BaseTest, Suite as BaseSuite, Group as BaseGroup, Runner as BaseRunner, TestContext as BaseTestContext } from '@japa/core';
 import { BaseReporter } from './reporters/base.js';
 import type { DataSetNode, TestHooksCleanupHandler } from './types.js';

package/build/src/config_manager.js

@@ -7,8 +7,8 @@
  * file that was distributed with this source code.
  */
 import debug from './debug.js';
-import { dot, ndjson, spec } from './reporters/main.js';
 import { Refiner } from '../modules/core/main.js';
+import { dot, ndjson, spec } from './reporters/main.js';
 export const NOOP = () => { };
 /**
  * Defaults to use for configuration

package/build/src/debug.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="@types/node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 declare const _default: import("util").DebugLogger;
 export default _default;

package/build/src/files_manager.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@types/node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import type { TestFiles } from './types.js';
 /**
  * Files manager exposes the API to collect, filter and import test

package/build/src/helpers.d.ts

@@ -1,22 +1,15 @@
-declare const _default: {
-    colors: import("@poppinss/colors/types").Colors;
-    logger: import("@poppinss/cliui").Logger;
-    table: (tableOptions?: Partial<import("@poppinss/cliui/types").TableOptions> | undefined) => import("@poppinss/cliui").Table;
-    tasks: (tasksOptions?: Partial<import("@poppinss/cliui/types").TaskManagerOptions> | undefined) => import("@poppinss/cliui").TaskManager;
-    icons: {
-        tick: string;
-        cross: string;
-        bullet: string;
-        nodejs: string;
-        pointer: string;
-        info: string;
-        warning: string;
-        squareSmallFilled: string;
-    };
-    sticker: () => import("@poppinss/cliui").Instructions;
-    instructions: () => import("@poppinss/cliui").Instructions;
-    switchMode(modeToUse: "raw" | "silent" | "normal"): void;
-    useRenderer(rendererToUse: import("@poppinss/cliui/types").RendererContract): void;
-    useColors(colorsToUse: import("@poppinss/colors/types").Colors): void;
+import { Colors } from '@poppinss/colors/types';
+export declare const colors: Colors;
+/**
+ * A collection of platform specific icons
+ */
+export declare const icons: {
+    tick: string;
+    cross: string;
+    bullet: string;
+    nodejs: string;
+    pointer: string;
+    info: string;
+    warning: string;
+    squareSmallFilled: string;
 };
-export default _default;

package/build/src/helpers.js

@@ -6,5 +6,29 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { cliui } from '@poppinss/cliui';
-export default cliui();
+import useColors from '@poppinss/colors';
+export const colors = useColors.ansi();
+/**
+ * A collection of platform specific icons
+ */
+export const icons = process.platform === 'win32' && !process.env.WT_SESSION
+    ? {
+        tick: '√',
+        cross: '×',
+        bullet: '*',
+        nodejs: '♦',
+        pointer: '>',
+        info: 'i',
+        warning: '‼',
+        squareSmallFilled: '[█]',
+    }
+    : {
+        tick: '✔',
+        cross: '✖',
+        bullet: '●',
+        nodejs: '⬢',
+        pointer: '❯',
+        info: 'ℹ',
+        warning: '⚠',
+        squareSmallFilled: '◼',
+    };

package/build/src/planner.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-import type { NormalizedConfig, TestSuite } from './types.js';
+/// <reference types="node" resolution-mode="require"/>
+import type { NamedReporterContract, NormalizedConfig, TestSuite } from './types.js';
 /**
  * The tests planner is used to plan the tests by doing all
  * the heavy lifting of executing plugins, registering
@@ -12,7 +12,7 @@ export declare class Planner {
      * Creates a plan for running the tests
      */
     plan(): Promise<{
-        reporters: import("@japa/core/types").NamedReporterContract[];
+        reporters: NamedReporterContract[];
         suites: (TestSuite & {
             filesURLs: URL[];
         })[];

package/build/src/plugins/retry.js

@@ -9,7 +9,7 @@
 import { join } from 'node:path';
 import findCacheDirectory from 'find-cache-dir';
 import { mkdir, readFile, unlink, writeFile } from 'node:fs/promises';
-import cliui from '../helpers.js';
+import { colors } from '../helpers.js';
 /**
  * Paths to the cache directory and the summary file
  */
@@ -58,7 +58,7 @@ export const retryPlugin = async function retry({ config, cliArgs }) {
     if (cliArgs.failed) {
         const { tests } = await getFailedTests();
         if (!tests || !tests.length) {
-            console.log(cliui.colors.bgYellow().black(' No failing tests found. Running all the tests '));
+            console.log(colors.bgYellow().black(' No failing tests found. Running all the tests '));
             return;
         }
         config.filters.tests = tests;

package/build/src/reporters/dot.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import cliui from '../helpers.js';
+import { colors, icons } from '../helpers.js';
 import { BaseReporter } from '../../modules/core/reporters/base.js';
 /**
  * Minimal reporter that prints each test as an icon.
@@ -18,16 +18,16 @@ export class DotReporter extends BaseReporter {
     onTestEnd(payload) {
         let output = '';
         if (payload.isTodo) {
-            output = cliui.colors.cyan('-');
+            output = colors.cyan(icons.info);
         }
         else if (payload.hasError || payload.isFailing) {
-            output = cliui.colors.red('×');
+            output = payload.hasError ? colors.magenta(icons.squareSmallFilled) : colors.red(icons.cross);
         }
         else if (payload.isSkipped) {
-            output = cliui.colors.yellow('-');
+            output = colors.yellow(icons.bullet);
         }
         else {
-            output = cliui.colors.green('•');
+            output = colors.green(icons.tick);
         }
         process.stdout.write(`${output}`);
     }

package/build/src/reporters/ndjson.js

@@ -7,8 +7,8 @@
  * file that was distributed with this source code.
  */
 import { relative } from 'node:path';
-import { BaseReporter } from '../../modules/core/main.js';
 import { serializeError } from 'serialize-error';
+import { BaseReporter } from '../../modules/core/main.js';
 /**
  * Prints tests progress as JSON. Each event is emitted
  * independently