@japa/runner 2.4.0 → 2.5.1

package/build/index.js

@@ -27,6 +27,7 @@ Object.defineProperty(exports, "TestContext", { enumerable: true, get: function
 Object.defineProperty(exports, "Group", { enumerable: true, get: function () { return main_1.Group; } });
 Object.defineProperty(exports, "Suite", { enumerable: true, get: function () { return main_1.Suite; } });
 Object.defineProperty(exports, "Runner", { enumerable: true, get: function () { return main_1.Runner; } });
+const debug_1 = __importDefault(require("./src/debug"));
 /**
  * Filtering layers allowed by the refiner
  */
@@ -156,12 +157,15 @@ async function importFiles(files) {
  */
 async function endTests(runner) {
     if (runnerOptions.forceExit) {
+        (0, debug_1.default)('force exiting tests after executing them');
         await runner.end();
     }
     else {
+        (0, debug_1.default)('executed tests and waiting for "process.beforeExit" event');
         return new Promise((resolve) => {
             async function beforeExit() {
                 process.removeListener('beforeExit', beforeExit);
+                (0, debug_1.default)('received "process.beforeExit" event, ending tests');
                 await runner.end();
                 resolve();
             }
@@ -196,6 +200,7 @@ Examples:
  */
 function configure(options) {
     const defaultOptions = {
+        cliArgs: {},
         cwd: process.cwd(),
         files: [],
         suites: [],
@@ -238,6 +243,7 @@ function processCliArgs(argv) {
     });
     const config = {
         filters: {},
+        cliArgs: parsed,
     };
     processAsString(parsed, 'tags', (tags) => (config.filters.tags = tags));
     processAsString(parsed, 'ignoreTags', (tags) => {
@@ -297,13 +303,17 @@ async function run() {
          * running plugins only
          */
         for (let plugin of runnerOptions.plugins) {
+            (0, debug_1.default)('running plugin "%s"', plugin.name || 'anonymous');
             await plugin(runnerOptions, runner, { Test: main_1.Test, TestContext: main_1.TestContext, Group: main_1.Group });
         }
         validateSuitesFilter();
         /**
          * Step 2: Notify runner about reporters
          */
-        runnerOptions.reporters.forEach((reporter) => runner.registerReporter(reporter));
+        runnerOptions.reporters.forEach((reporter) => {
+            (0, debug_1.default)('registering reporter "%s"', reporter.name || 'anonymous');
+            runner.registerReporter(reporter);
+        });
         /**
          * Step 3: Configure runner hooks.
          */
@@ -324,6 +334,7 @@ async function run() {
          * as part of the default suite
          */
         if ('files' in runnerOptions && runnerOptions.files.length) {
+            (0, debug_1.default)('collecting files for %O globs', runnerOptions.files);
             /**
              * Create a default suite for files with no suite
              */
@@ -351,6 +362,7 @@ async function run() {
                     else {
                         globalTimeout = runnerOptions.timeout;
                     }
+                    (0, debug_1.default)('collecting "%s" suite files for %O globs', suite.name, suite.files);
                     const files = await collectFiles(suite.files);
                     /**
                      * Only register the suite and import files when the suite

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

@@ -1,4 +1,9 @@
 import { DataSetNode, Test as BaseTest, Group as BaseGroup, Suite as BaseSuite, Runner as BaseRunner, TestHooksCleanupHandler, TestContext as BaseTestContext } from '@japa/core';
+/**
+ * Runner specific test context. Here we extend the test context to register
+ * cleanup methods with the test and register hooks to get notified when
+ * a new instance of test context is created.
+ */
 export declare class TestContext extends BaseTestContext {
     test: Test;
     /**
@@ -18,15 +23,27 @@ export declare class TestContext extends BaseTestContext {
     cleanup: (handler: TestHooksCleanupHandler<this>) => void;
     constructor(test: Test);
 }
+/**
+ * Runner specific Test with a fixed TestContext static type.
+ */
 export declare class Test<TestData extends DataSetNode = undefined> extends BaseTest<TestContext, TestData> {
     static disposeCallbacks: never[];
 }
+/**
+ * Runner specific Group with a fixed TestContext static type.
+ */
 export declare class Group extends BaseGroup<TestContext> {
 }
+/**
+ * Runner specific Suite with a fixed TestContext static type.
+ */
 export declare class Suite extends BaseSuite<TestContext> {
     onGroup(callback: (group: Group) => void): this;
     onTest(callback: (test: Test<any>) => void): this;
 }
+/**
+ * Runner specific tests Runner with a fixed TestContext static type.
+ */
 export declare class Runner extends BaseRunner<TestContext> {
     onSuite(callback: (suite: Suite) => void): this;
 }

package/build/src/core/main.js

@@ -7,15 +7,25 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Runner = exports.Suite = exports.Group = exports.Test = exports.TestContext = void 0;
 const core_1 = require("@japa/core");
+const debug_1 = __importDefault(require("../debug"));
+/**
+ * Runner specific test context. Here we extend the test context to register
+ * cleanup methods with the test and register hooks to get notified when
+ * a new instance of test context is created.
+ */
 class TestContext extends core_1.TestContext {
     /**
      * Register a function to get notified when an instance of test
      * context is created. The callback must be synchronous
      */
     static created(callback) {
+        (0, debug_1.default)('registering test context created hook "%s"', callback);
         this.createdCallbacks.push(callback);
         return this;
     }
@@ -38,13 +48,22 @@ exports.TestContext = TestContext;
  * is created
  */
 TestContext.createdCallbacks = [];
+/**
+ * Runner specific Test with a fixed TestContext static type.
+ */
 class Test extends core_1.Test {
 }
 exports.Test = Test;
 Test.disposeCallbacks = [];
+/**
+ * Runner specific Group with a fixed TestContext static type.
+ */
 class Group extends core_1.Group {
 }
 exports.Group = Group;
+/**
+ * Runner specific Suite with a fixed TestContext static type.
+ */
 class Suite extends core_1.Suite {
     onGroup(callback) {
         super.onGroup(callback);
@@ -56,6 +75,9 @@ class Suite extends core_1.Suite {
     }
 }
 exports.Suite = Suite;
+/**
+ * Runner specific tests Runner with a fixed TestContext static type.
+ */
 class Runner extends core_1.Runner {
     onSuite(callback) {
         super.onSuite(callback);

package/build/src/debug.d.ts

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

package/build/src/debug.js

@@ -0,0 +1,12 @@
+"use strict";
+/*
+ * @japa/runner
+ *
+ * (c) Japa.dev
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("util");
+exports.default = (0, util_1.debuglog)('japa:runner');

package/build/src/types.d.ts

@@ -34,6 +34,7 @@ export type RunnerHooks = {
  * Base configuration options
  */
 export type BaseConfig = {
+    cliArgs?: Record<string, any>;
     cwd?: string;
     timeout?: number;
     plugins?: PluginFn[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@japa/runner",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "description": "Runner for Japa testing framework",
   "main": "build/index.js",
   "files": [
@@ -14,7 +14,7 @@
   "scripts": {
     "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "node .bin/test.js",
+    "test": "cross-env NODE_DEBUG=japa:runner node .bin/test.js",
     "clean": "del-cli build",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
@@ -36,8 +36,9 @@
   "devDependencies": {
     "@adonisjs/mrm-preset": "^5.0.3",
     "@adonisjs/require-ts": "^2.0.13",
-    "@types/node": "^18.11.19",
+    "@types/node": "^18.14.0",
     "commitizen": "^4.3.0",
+    "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "del-cli": "^5.0.0",
     "eslint": "^8.33.0",
@@ -105,7 +106,7 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@japa/core": "^7.3.1",
+    "@japa/core": "^7.3.2",
     "@japa/errors-printer": "^2.1.0",
     "@poppinss/cliui": "^3.0.5",
     "@poppinss/hooks": "^6.0.2-0",