@japa/runner 3.0.0-6 → 3.0.0-8

package/build/modules/core/main.js

@@ -1,121 +1,21 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Emitter, Refiner, Test as BaseTest, Suite as BaseSuite, Group as BaseGroup, Runner as BaseRunner, TestContext as BaseTestContext, } from '@japa/core';
-import { inspect } from 'node:util';
-import { AssertionError } from 'node:assert';
-import { BaseReporter } from './reporters/base.js';
-export { Emitter, Refiner, BaseReporter };
-/**
- * Test context carries context data for a given test.
- */
-export class TestContext extends BaseTestContext {
-    test;
-    constructor(test) {
-        super();
-        this.test = test;
-        this.cleanup = (cleanupCallback) => {
-            test.cleanup(cleanupCallback);
-        };
-    }
-}
-/**
- * Test class represents an individual test and exposes API to tweak
- * its runtime behavior.
- */
-export class Test extends BaseTest {
-    /**
-     * @inheritdoc
-     */
-    static executedCallbacks = [];
-    /**
-     * @inheritdoc
-     */
-    static executingCallbacks = [];
-    /**
-     * Assert the test callback throws an exception when a certain
-     * error message and optionally is an instance of a given
-     * Error class.
-     */
-    throws(message, errorConstructor) {
-        const errorInPoint = new AssertionError({});
-        const existingExecutor = this.options.executor;
-        if (!existingExecutor) {
-            throw new Error('Cannot use "test.throws" method without a test callback');
-        }
-        /**
-         * Overwriting existing callback
-         */
-        this.options.executor = async (...args) => {
-            let raisedException;
-            try {
-                await existingExecutor(...args);
-            }
-            catch (error) {
-                raisedException = error;
-            }
-            /**
-             * Notify no exception has been raised
-             */
-            if (!raisedException) {
-                errorInPoint.message = 'Expected test to throw an exception';
-                throw errorInPoint;
-            }
-            /**
-             * Constructor mis-match
-             */
-            if (errorConstructor && !(raisedException instanceof errorConstructor)) {
-                errorInPoint.message = `Expected test to throw "${inspect(errorConstructor)}"`;
-                throw errorInPoint;
-            }
-            /**
-             * Error does not have a message property
-             */
-            const exceptionMessage = raisedException.message;
-            if (!exceptionMessage || typeof exceptionMessage !== 'string') {
-                errorInPoint.message = 'Expected test to throw an exception with message property';
-                throw errorInPoint;
-            }
-            /**
-             * Message does not match
-             */
-            if (typeof message === 'string') {
-                if (exceptionMessage !== message) {
-                    errorInPoint.message = `Expected test to throw "${message}". Instead received "${raisedException.message}"`;
-                    errorInPoint.actual = raisedException.message;
-                    errorInPoint.expected = message;
-                    throw errorInPoint;
-                }
-                return;
-            }
-            if (!message.test(exceptionMessage)) {
-                errorInPoint.message = `Expected test error to match "${message}" regular expression`;
-                throw errorInPoint;
-            }
-        };
-        return this;
-    }
-}
-/**
- * TestGroup is used to bulk configure a collection of tests and
- * define lifecycle hooks for them
- */
-export class Group extends BaseGroup {
-}
-/**
- * A suite is a collection of tests created around a given
- * testing type. For example: A suite for unit tests, a
- * suite for functional tests and so on.
- */
-export class Suite extends BaseSuite {
-}
-/**
- * Runner class is used to execute the tests
- */
-export class Runner extends BaseRunner {
-}
+import {
+  BaseReporter,
+  Emitter,
+  Group,
+  Refiner,
+  Runner,
+  Suite,
+  Test,
+  TestContext
+} from "../../chunk-MCOW34SG.js";
+import "../../chunk-HN4AVHWN.js";
+export {
+  BaseReporter,
+  Emitter,
+  Group,
+  Refiner,
+  Runner,
+  Suite,
+  Test,
+  TestContext
+};

package/build/src/reporters/main.d.ts

@@ -1,13 +1,18 @@
-import type { BaseReporterOptions, NamedReporterContract } from '../types.js';
+import { B as BaseReporterOptions } from '../../main-63126780.js';
+import { NamedReporterContract } from '@japa/core/types';
+import '@japa/core';
+
 /**
  * Create an instance of the spec reporter
  */
-export declare const spec: (options?: BaseReporterOptions) => NamedReporterContract;
+declare const spec: (options?: BaseReporterOptions) => NamedReporterContract;
 /**
  * Create an instance of the dot reporter
  */
-export declare const dot: (options?: BaseReporterOptions) => NamedReporterContract;
+declare const dot: (options?: BaseReporterOptions) => NamedReporterContract;
 /**
  * Create an instance of the ndjson reporter
  */
-export declare const ndjson: (options?: BaseReporterOptions) => NamedReporterContract;
+declare const ndjson: (options?: BaseReporterOptions) => NamedReporterContract;
+
+export { dot, ndjson, spec };

package/build/src/reporters/main.js

@@ -1,38 +1,12 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DotReporter } from './dot.js';
-import { SpecReporter } from './spec.js';
-import { NdJSONReporter } from './ndjson.js';
-/**
- * Create an instance of the spec reporter
- */
-export const spec = (options) => {
-    return {
-        name: 'spec',
-        handler: (...args) => new SpecReporter(options).boot(...args),
-    };
-};
-/**
- * Create an instance of the dot reporter
- */
-export const dot = (options) => {
-    return {
-        name: 'dot',
-        handler: (...args) => new DotReporter(options).boot(...args),
-    };
-};
-/**
- * Create an instance of the ndjson reporter
- */
-export const ndjson = (options) => {
-    return {
-        name: 'ndjson',
-        handler: (...args) => new NdJSONReporter(options).boot(...args),
-    };
+import {
+  dot,
+  ndjson,
+  spec
+} from "../../chunk-7THDHQFT.js";
+import "../../chunk-MCOW34SG.js";
+import "../../chunk-HN4AVHWN.js";
+export {
+  dot,
+  ndjson,
+  spec
 };

package/build/src/types.d.ts

@@ -1,29 +1,31 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-import type { HookHandler } from '@poppinss/hooks/types';
-import type { Emitter, Refiner, Runner, Suite } from '../modules/core/main.js';
-import type { FilteringOptions, NamedReporterContract } from '../modules/core/types.js';
-export * from '../modules/core/types.js';
+import { HookHandler } from '@poppinss/hooks/types';
+import { R as Runner, S as Suite } from '../main-63126780.js';
+export { B as BaseReporterOptions } from '../main-63126780.js';
+import { FilteringOptions, NamedReporterContract } from '@japa/core/types';
+export * from '@japa/core/types';
+import { Emitter, Refiner } from '@japa/core';
+
 /**
  * Global setup hook
  */
-export type SetupHookState = [[runner: Runner], [error: Error | null, runner: Runner]];
-export type SetupHookHandler = HookHandler<SetupHookState[0], SetupHookState[1]>;
+type SetupHookState = [[runner: Runner], [error: Error | null, runner: Runner]];
+type SetupHookHandler = HookHandler<SetupHookState[0], SetupHookState[1]>;
 /**
  * Global teardown hook
  */
-export type TeardownHookState = [[runner: Runner], [error: Error | null, runner: Runner]];
-export type TeardownHookHandler = HookHandler<TeardownHookState[0], TeardownHookState[1]>;
+type TeardownHookState = [[runner: Runner], [error: Error | null, runner: Runner]];
+type TeardownHookHandler = HookHandler<TeardownHookState[0], TeardownHookState[1]>;
 /**
  * Global set of available hooks
  */
-export type HooksEvents = {
+type HooksEvents = {
     setup: SetupHookState;
     teardown: TeardownHookState;
 };
 /**
  * Parsed command-line arguments
  */
-export type CLIArgs = {
+type CLIArgs = {
     _?: string[];
     tags?: string | string[];
     files?: string | string[];
@@ -40,7 +42,7 @@ export type CLIArgs = {
 /**
  * Set of filters you can apply to run only specific tests
  */
-export type Filters = FilteringOptions & {
+type Filters = FilteringOptions & {
     files?: string[];
     suites?: string[];
 };
@@ -48,7 +50,7 @@ export type Filters = FilteringOptions & {
  * Plugin function receives an instance of the runner,
  * emitter, config and the hooks
  */
-export type PluginFn = (japa: {
+type PluginFn = (japa: {
     config: NormalizedConfig;
     cliArgs: CLIArgs;
     runner: Runner;
@@ -57,7 +59,7 @@ export type PluginFn = (japa: {
 /**
  * Base configuration options
  */
-export type BaseConfig = {
+type BaseConfig = {
     /**
      * Current working directory. It is required to search for
      * the test files
@@ -120,11 +122,11 @@ export type BaseConfig = {
  * A collection of test files defined as a glob or a callback
  * function that returns an array of URLs
  */
-export type TestFiles = string | string[] | (() => URL[] | Promise<URL[]>);
+type TestFiles = string | string[] | (() => URL[] | Promise<URL[]>);
 /**
  * A test suite to register tests under a named suite
  */
-export type TestSuite = {
+type TestSuite = {
     /**
      * A unique name for the suite
      */
@@ -151,7 +153,7 @@ export type TestSuite = {
 /**
  * BaseConfig after normalized by the config manager
  */
-export type NormalizedBaseConfig = Required<Omit<BaseConfig, 'reporters'>> & {
+type NormalizedBaseConfig = Required<Omit<BaseConfig, 'reporters'>> & {
     reporters: {
         activated: string[];
         list: NamedReporterContract[];
@@ -160,7 +162,7 @@ export type NormalizedBaseConfig = Required<Omit<BaseConfig, 'reporters'>> & {
 /**
  * Configuration options
  */
-export type Config = BaseConfig & ({
+type Config = BaseConfig & ({
     files: TestFiles;
 } | {
     suites: TestSuite[];
@@ -168,8 +170,10 @@ export type Config = BaseConfig & ({
 /**
  * Config after normalized by the config manager
  */
-export type NormalizedConfig = NormalizedBaseConfig & ({
+type NormalizedConfig = NormalizedBaseConfig & ({
     files: TestFiles;
 } | {
     suites: Required<TestSuite>[];
 });
+
+export { BaseConfig, CLIArgs, Config, Filters, HooksEvents, NormalizedBaseConfig, NormalizedConfig, PluginFn, SetupHookHandler, SetupHookState, TeardownHookHandler, TeardownHookState, TestFiles, TestSuite };

package/build/src/types.js

@@ -1,9 +1,14 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export * from '../modules/core/types.js';
+import {
+  __reExport
+} from "../chunk-HN4AVHWN.js";
+
+// src/types.ts
+var types_exports2 = {};
+
+// modules/core/types.ts
+var types_exports = {};
+__reExport(types_exports, types_star);
+import * as types_star from "@japa/core/types";
+
+// src/types.ts
+__reExport(types_exports2, types_exports);

package/package.json

@@ -1,18 +1,14 @@
 {
   "name": "@japa/runner",
   "description": "Runner for Japa testing framework",
-  "version": "3.0.0-6",
+  "version": "3.0.0-8",
   "engines": {
     "node": ">=18.16.0"
   },
   "main": "build/index.js",
   "type": "module",
   "files": [
-    "build/factories",
-    "build/modules",
-    "build/src",
-    "build/index.d.ts",
-    "build/index.js"
+    "build"
   ],
   "exports": {
     ".": "./build/index.js",
@@ -23,11 +19,11 @@
   },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "cross-env NODE_ENV=japa:runner c8 npm run quick:test",
+    "test": "cross-env NODE_DEBUG=japa:runner c8 npm run quick:test",
     "quick:test": "glob -c \"node --enable-source-maps --loader=ts-node/esm --test-reporter=spec --test\" \"tests/*.spec.ts\"",
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
-    "compile": "npm run lint && npm run clean && tsc",
+    "compile": "npm run lint && npm run clean && tsup-node",
     "build": "npm run compile",
     "release": "np",
     "prepublishOnly": "npm run build",
@@ -37,40 +33,39 @@
     "sync-labels": "github-label-sync --labels .github/labels.json japa/runner"
   },
   "devDependencies": {
-    "@adonisjs/eslint-config": "^1.1.7",
-    "@adonisjs/prettier-config": "^1.1.7",
-    "@adonisjs/require-ts": "^2.0.13",
-    "@adonisjs/tsconfig": "^1.1.7",
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
-    "@swc/core": "^1.3.68",
-    "@types/chai": "^4.3.5",
+    "@adonisjs/eslint-config": "^1.1.8",
+    "@adonisjs/prettier-config": "^1.1.8",
+    "@adonisjs/tsconfig": "^1.1.8",
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@swc/core": "1.3.82",
+    "@types/chai": "^4.3.6",
     "@types/chai-subset": "^1.3.3",
-    "@types/find-cache-dir": "^3.2.1",
+    "@types/find-cache-dir": "^5.0.0",
     "@types/ms": "^0.7.31",
-    "@types/node": "^20.4.1",
-    "c8": "^8.0.0",
-    "chai": "^4.3.7",
+    "@types/node": "^20.6.3",
+    "c8": "^8.0.1",
+    "chai": "^4.3.8",
     "chai-subset": "^1.6.0",
     "cross-env": "^7.0.3",
-    "del-cli": "^5.0.0",
-    "eslint": "^8.44.0",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.50.0",
     "github-label-sync": "^2.3.1",
-    "glob": "^10.3.2",
+    "glob": "^10.3.6",
     "husky": "^8.0.3",
-    "japa": "^4.0.0",
     "np": "^8.0.4",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.3",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "tsup": "^7.2.0",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@japa/core": "^8.0.0-9",
-    "@japa/errors-printer": "^3.0.0-4",
-    "@poppinss/cliui": "^6.1.1-2",
-    "@poppinss/hooks": "^7.1.1-3",
-    "fast-glob": "^3.3.0",
-    "find-cache-dir": "^4.0.0",
+    "@japa/core": "^8.0.0-11",
+    "@japa/errors-printer": "^3.0.0-6",
+    "@poppinss/colors": "^4.1.0-4",
+    "@poppinss/hooks": "^7.1.1-5",
+    "fast-glob": "^3.3.1",
+    "find-cache-dir": "^5.0.0",
     "getopts": "^2.3.0",
     "ms": "^2.1.3",
     "serialize-error": "^11.0.0",
@@ -125,5 +120,19 @@
       "modules/core/**",
       "src/reporters/**"
     ]
+  },
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./src/types.ts",
+      "./src/reporters/main.ts",
+      "./factories/main.ts",
+      "./modules/core/main.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": true,
+    "target": "esnext"
   }
 }

package/build/factories/runner.d.ts

@@ -1,27 +0,0 @@
-import { Config } from '../src/types.js';
-import { Suite, Emitter } from '../modules/core/main.js';
-/**
- * Runner factory exposes the API to run dummy suites, groups and tests.
- * You might want to use the factory for testing reporters and
- * plugins usage
- */
-export declare class RunnerFactory {
-    #private;
-    /**
-     * 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 dummy tests. You might use
-     */
-    run(): Promise<import("@japa/core/types").RunnerSummary>;
-}