@japa/runner 1.0.0 → 1.1.0

package/build/index.d.ts

@@ -1,7 +1,7 @@
 import { TestExecutor } from '@japa/core';
 import { Test, TestContext, Group } from './src/Core';
-import { ConfigureOptions, Filters } from './src/Contracts';
-export { Test, TestContext, Group } from './src/Core';
+import { ConfigureOptions } from './src/Contracts';
+export { Test, TestContext, Group };
 /**
  * Configure the tests runner
  */
@@ -9,16 +9,24 @@ export declare function configure(options: ConfigureOptions): void;
 /**
  * Add a new test
  */
-declare function test(title: string, callback?: TestExecutor<TestContext, undefined>): Test<TestContext, undefined>;
-declare namespace test {
+export declare function test(title: string, callback?: TestExecutor<TestContext, undefined>): Test<TestContext, undefined>;
+export declare namespace test {
     var group: (title: string, callback: (group: Group<TestContext>) => void) => void;
 }
-export default test;
 /**
  * Run japa tests
  */
 export declare function run(): Promise<void>;
 /**
- * Process CLI arguments into filters
+ * Process CLI arguments into configuration options. The following
+ * command line arguments are processed.
+ *
+ * * --tests=Specify test titles
+ * * --tags=Specify test tags
+ * * --groups=Specify group titles
+ * * --ignore-tags=Specify negated tags
+ * * --files=Specify files to match and run
+ * * --force-exit=Enable/disable force exit
+ * * --timeout=Define timeout for all the tests
  */
-export declare function processCliArgs(argv: string[]): Filters;
+export declare function processCliArgs(argv: string[]): Partial<ConfigureOptions>;

package/build/index.js

@@ -11,18 +11,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processCliArgs = exports.run = exports.configure = exports.Group = exports.TestContext = exports.Test = void 0;
+exports.processCliArgs = exports.run = exports.test = exports.configure = exports.Group = exports.TestContext = exports.Test = void 0;
 const getopts_1 = __importDefault(require("getopts"));
 const path_1 = require("path");
 const fast_glob_1 = __importDefault(require("fast-glob"));
 const inclusion_1 = __importDefault(require("inclusion"));
 const hooks_1 = require("@poppinss/hooks");
+const errors_printer_1 = require("@japa/errors-printer");
 const core_1 = require("@japa/core");
 const Core_1 = require("./src/Core");
-var Core_2 = require("./src/Core");
-Object.defineProperty(exports, "Test", { enumerable: true, get: function () { return Core_2.Test; } });
-Object.defineProperty(exports, "TestContext", { enumerable: true, get: function () { return Core_2.TestContext; } });
-Object.defineProperty(exports, "Group", { enumerable: true, get: function () { return Core_2.Group; } });
+Object.defineProperty(exports, "Test", { enumerable: true, get: function () { return Core_1.Test; } });
+Object.defineProperty(exports, "TestContext", { enumerable: true, get: function () { return Core_1.TestContext; } });
+Object.defineProperty(exports, "Group", { enumerable: true, get: function () { return Core_1.Group; } });
 /**
  * Filtering layers allowed by the refiner
  */
@@ -80,10 +80,13 @@ async function endTests(runner) {
     }
 }
 /**
- * Process command line args to an array of strings
+ * Process command line argument into a string value
  */
-function processArg(flag) {
-    return (Array.isArray(flag) ? flag : flag.split(',')).map((tag) => tag.trim());
+function processAsString(argv, flagName, onMatch) {
+    const flag = argv[flagName];
+    if (flag) {
+        onMatch((Array.isArray(flag) ? flag : flag.split(',')).map((tag) => tag.trim()));
+    }
 }
 /**
  * Find if the file path matches the files filter array.
@@ -149,7 +152,7 @@ function test(title, callback) {
     }
     return testInstance;
 }
-exports.default = test;
+exports.test = test;
 /**
  * Define test group
  */
@@ -198,10 +201,7 @@ async function run() {
          */
         runnerOptions.reporters.forEach((reporter) => runner.registerReporter(reporter));
         /**
-         * Step 3: Run runner hooks.
-         *
-         * We run hooks before importing test files. It allows hooks
-         * to setup the app environment for the test files
+         * Step 3: Configure runner hooks.
          */
         runnerOptions.setup.forEach((hook) => hooks.add('setup', hook));
         runnerOptions.teardown.forEach((hook) => hooks.add('teardown', hook));
@@ -209,6 +209,10 @@ async function run() {
         teardownRunner = hooks.runner('teardown');
         /**
          * Step 3.1: Run setup hooks
+         *
+         * We run the setup hooks before importing test files. It
+         * allows hooks to setup the app environment for the
+         * test files.
          */
         await setupRunner.run(runner);
         /**
@@ -255,9 +259,11 @@ async function run() {
          */
         await runner.exec();
         /**
-         * Step 7.3: Run teardown hooks
+         * Step 7.3: Run cleanup and teardown hooks
          */
+        await setupRunner.cleanup(runner);
         await teardownRunner.run(runner);
+        await teardownRunner.cleanup(runner);
         /**
          * Step 7.4: End or wait for process to exit
          */
@@ -270,8 +276,6 @@ async function run() {
             process.exitCode = 1;
         }
         runnerOptions.forceExit && process.exit();
-        await setupRunner.cleanup(runner);
-        await teardownRunner.cleanup(runner);
     }
     catch (error) {
         if (setupRunner && setupRunner.isCleanupPending) {
@@ -280,40 +284,53 @@ async function run() {
         if (teardownRunner && teardownRunner.isCleanupPending) {
             await teardownRunner.cleanup(error, runner);
         }
+        const printer = new errors_printer_1.ErrorsPrinter();
+        await printer.printError(error);
         process.exitCode = 1;
         runnerOptions.forceExit && process.exit();
     }
 }
 exports.run = run;
 /**
- * Process CLI arguments into filters
+ * Process CLI arguments into configuration options. The following
+ * command line arguments are processed.
+ *
+ * * --tests=Specify test titles
+ * * --tags=Specify test tags
+ * * --groups=Specify group titles
+ * * --ignore-tags=Specify negated tags
+ * * --files=Specify files to match and run
+ * * --force-exit=Enable/disable force exit
+ * * --timeout=Define timeout for all the tests
  */
 function processCliArgs(argv) {
     const parsed = (0, getopts_1.default)(argv, {
-        string: ['tests', 'tags', 'groups', 'ignoreTags', 'files'],
+        string: ['tests', 'tags', 'groups', 'ignoreTags', 'files', 'timeout'],
+        boolean: ['forceExit'],
         alias: {
             ignoreTags: 'ignore-tags',
+            forceExit: 'force-exit',
         },
     });
-    const filters = {};
-    if (parsed.tags) {
-        filters.tags = processArg(parsed.tags);
-    }
-    if (parsed.ignoreTags) {
-        filters.tags = filters.tags || [];
-        processArg(parsed.ignoreTags).forEach((tag) => {
-            filters.tags.push(`!${tag}`);
-        });
-    }
-    if (parsed.groups) {
-        filters.groups = processArg(parsed.groups);
-    }
-    if (parsed.tests) {
-        filters.tests = processArg(parsed.tests);
+    const config = {
+        filters: {},
+    };
+    processAsString(parsed, 'tags', (tags) => (config.filters.tags = tags));
+    processAsString(parsed, 'ignoreTags', (tags) => {
+        tags.forEach((tag) => config.filters.tags.push(`!${tag}`));
+    });
+    processAsString(parsed, 'groups', (groups) => (config.filters.groups = groups));
+    processAsString(parsed, 'tests', (tests) => (config.filters.tests = tests));
+    processAsString(parsed, 'files', (files) => (config.filters.files = files));
+    if (parsed.timeout) {
+        const value = Number(parsed.timeout);
+        if (!isNaN(value)) {
+            config.timeout = value;
+        }
     }
-    if (parsed.files) {
-        filters.files = processArg(parsed.files);
+    if (parsed.forceExit) {
+        config.forceExit = true;
     }
-    return filters;
+    return config;
 }
 exports.processCliArgs = processCliArgs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@japa/runner",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Runner for Japa testing framework",
   "main": "build/index.js",
   "files": [
@@ -106,6 +106,7 @@
   },
   "dependencies": {
     "@japa/core": "^5.0.17-0",
+    "@japa/errors-printer": "^1.3.1",
     "@poppinss/hooks": "^6.0.1-0",
     "fast-glob": "^3.2.11",
     "getopts": "^2.3.0",