@japa/runner 3.0.0-4 → 3.0.0-5

package/build/src/cli_parser.js

@@ -15,8 +15,8 @@ const ansi = colors.ansi();
  * will be parsed aswell, but without any normalization
  */
 const OPTIONS = {
-    string: ['tests', 'groups', 'tags', 'files', 'timeout', 'retries', 'reporter'],
-    boolean: ['help', 'matchAll'],
+    string: ['tests', 'groups', 'tags', 'files', 'timeout', 'retries', 'reporter', 'failed'],
+    boolean: ['help', 'matchAll', 'failed'],
     alias: {
         forceExit: 'force-exit',
         matchAll: 'match-all',
@@ -37,6 +37,7 @@ ${ansi.green('--force-exit')}                ${ansi.dim('Forcefully exit the pro
 ${ansi.green('--timeout')}                   ${ansi.dim('Define default timeout for all tests')}
 ${ansi.green('--retries')}                   ${ansi.dim('Define default retries for all tests')}
 ${ansi.green('--reporter')}                  ${ansi.dim('Activate one or more test reporters')}
+${ansi.green('--failed')}                    ${ansi.dim('Run tests failed during the last run')}
 ${ansi.green('-h, --help')}                  ${ansi.dim('View help')}
 
 ${ansi.yellow('Examples:')}

package/build/src/config_manager.d.ts

@@ -1,4 +1,5 @@
-import type { CLIArgs, Config } from './types.js';
+import type { CLIArgs, Config, NormalizedConfig } from './types.js';
+export declare const NOOP: () => void;
 /**
  * Config manager is used to hydrate the configuration by merging
  * the defaults, user defined config and the command line
@@ -13,5 +14,5 @@ export declare class ConfigManager {
      * Hydrates the config with user defined options and the
      * command-line flags.
      */
-    hydrate(): Required<Config>;
+    hydrate(): NormalizedConfig;
 }

package/build/src/config_manager.js

@@ -9,6 +9,7 @@
 import debug from './debug.js';
 import { dot, ndjson, spec } from './reporters/main.js';
 import { Refiner } from '../modules/core/main.js';
+export const NOOP = () => { };
 /**
  * Defaults to use for configuration
  */
@@ -128,7 +129,12 @@ export class ConfigManager {
             timeout: cliTimeout ?? this.#config.timeout ?? DEFAULTS.timeout,
             plugins: this.#config.plugins ?? DEFAULTS.plugins,
             forceExit: cliForceExit ?? this.#config.forceExit ?? DEFAULTS.forceExit,
-            reporters: this.#config.reporters ?? DEFAULTS.reporters,
+            reporters: this.#config.reporters
+                ? {
+                    activated: this.#config.reporters.activated,
+                    list: this.#config.reporters.list || DEFAULTS.reporters.list,
+                }
+                : DEFAULTS.reporters,
             configureSuite: this.#config.configureSuite ?? DEFAULTS.configureSuite,
             setup: this.#config.setup || [],
             teardown: this.#config.teardown || [],
@@ -153,7 +159,7 @@ export class ConfigManager {
                     files: suite.files,
                     timeout: cliTimeout ?? suite.timeout ?? baseConfig.timeout,
                     retries: cliRetries ?? suite.retries ?? baseConfig.retries,
-                    configure: suite.configure,
+                    configure: suite.configure || NOOP,
                 };
             }),
             ...baseConfig,

package/build/src/hooks.d.ts

@@ -1,5 +1,5 @@
 import { Runner } from '../modules/core/main.js';
-import type { Config } from './types.js';
+import type { NormalizedConfig } from './types.js';
 /**
  * Exposes API for working with global hooks
  */
@@ -8,7 +8,7 @@ export declare class GlobalHooks {
     /**
      * Apply hooks from the config
      */
-    apply(config: Required<Config>): void;
+    apply(config: NormalizedConfig): void;
     /**
      * Perform setup
      */

package/build/src/planner.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="@types/node" resolution-mode="require"/>
-import type { Config, TestSuite } from './types.js';
+import type { NormalizedConfig, TestSuite } from './types.js';
 /**
  * The tests planner is used to plan the tests by doing all
  * the heavy lifting of executing plugins, registering
@@ -7,7 +7,7 @@ import type { Config, TestSuite } from './types.js';
  */
 export declare class Planner {
     #private;
-    constructor(config: Required<Config>);
+    constructor(config: NormalizedConfig);
     /**
      * Creates a plan for running the tests
      */
@@ -20,6 +20,6 @@ export declare class Planner {
             layer: "tags" | "tests" | "groups";
             filters: string[];
         }[];
-        config: Required<Config>;
+        config: NormalizedConfig;
     }>;
 }

package/build/src/plugins/retry.d.ts

@@ -15,6 +15,6 @@ export declare function cacheFailedTests(tests: string[]): Promise<void>;
  */
 export declare function clearCache(): Promise<void>;
 /**
- * Exposes the API to run failing tests using the "retry" CLI flag.
+ * Exposes the API to run failing tests using the "failed" CLI flag.
  */
 export declare const retryPlugin: PluginFn;

package/build/src/plugins/retry.js

@@ -45,7 +45,7 @@ export async function clearCache() {
     await unlink(SUMMARY_FILE);
 }
 /**
- * Exposes the API to run failing tests using the "retry" CLI flag.
+ * Exposes the API to run failing tests using the "failed" CLI flag.
  */
 export const retryPlugin = async function retry({ config, cliArgs }) {
     if (!SUMMARY_FILE) {
@@ -55,7 +55,7 @@ export const retryPlugin = async function retry({ config, cliArgs }) {
         const summary = runner.getSummary();
         await cacheFailedTests(summary.failedTestsTitles);
     });
-    if (cliArgs.retry) {
+    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 '));

package/build/src/types.d.ts

@@ -33,6 +33,7 @@ export type CLIArgs = {
     retries?: string;
     reporter?: string | string[];
     forceExit?: boolean;
+    failed?: boolean;
     help?: boolean;
     matchAll?: boolean;
 } & Record<string, string | string[] | boolean>;
@@ -48,7 +49,7 @@ export type Filters = FilteringOptions & {
  * emitter, config and the hooks
  */
 export type PluginFn = (japa: {
-    config: Required<Config>;
+    config: NormalizedConfig;
     cliArgs: CLIArgs;
     runner: Runner;
     emitter: Emitter;
@@ -86,7 +87,7 @@ export type BaseConfig = {
      */
     reporters?: {
         activated: string[];
-        list: NamedReporterContract[];
+        list?: NamedReporterContract[];
     };
     /**
      * A collection of registered plugins
@@ -147,6 +148,15 @@ export type TestSuite = {
      */
     retries?: number;
 };
+/**
+ * BaseConfig after normalized by the config manager
+ */
+export type NormalizedBaseConfig = Required<Omit<BaseConfig, 'reporters'>> & {
+    reporters: {
+        activated: string[];
+        list: NamedReporterContract[];
+    };
+};
 /**
  * Configuration options
  */
@@ -155,3 +165,11 @@ export type Config = BaseConfig & ({
 } | {
     suites: TestSuite[];
 });
+/**
+ * Config after normalized by the config manager
+ */
+export type NormalizedConfig = NormalizedBaseConfig & ({
+    files: TestFiles;
+} | {
+    suites: Required<TestSuite>[];
+});

package/build/src/validator.d.ts

@@ -1,4 +1,4 @@
-import { Config } from './types.js';
+import { NormalizedConfig } from './types.js';
 /**
  * Validator encapsulates the validations to perform before running
  * the tests
@@ -7,7 +7,7 @@ declare class Validator {
     /**
      * Ensures the japa is configured. Otherwise raises an exception
      */
-    ensureIsConfigured(config: Required<Config> | undefined): void;
+    ensureIsConfigured(config: NormalizedConfig | undefined): void;
     /**
      * Ensures the japa is in planning phase
      */
@@ -15,16 +15,16 @@ declare class Validator {
     /**
      * Ensures the suites filter uses a subset of the user configured suites.
      */
-    validateSuitesFilter(config: Required<Config>): void;
+    validateSuitesFilter(config: NormalizedConfig): void;
     /**
      * Ensure there are unique suites
      */
-    validateSuitesForUniqueness(config: Required<Config>): void;
+    validateSuitesForUniqueness(config: NormalizedConfig): void;
     /**
      * Ensure the activated reporters are in the list of defined
      * reporters
      */
-    validateActivatedReporters(config: Required<Config>): void;
+    validateActivatedReporters(config: NormalizedConfig): void;
 }
 declare const _default: Validator;
 export default _default;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@japa/runner",
   "description": "Runner for Japa testing framework",
-  "version": "3.0.0-4",
+  "version": "3.0.0-5",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -48,7 +48,7 @@
     "@types/chai-subset": "^1.3.3",
     "@types/find-cache-dir": "^3.2.1",
     "@types/ms": "^0.7.31",
-    "@types/node": "^20.3.3",
+    "@types/node": "^20.4.1",
     "c8": "^8.0.0",
     "chai": "^4.3.7",
     "chai-subset": "^1.6.0",
@@ -56,7 +56,7 @@
     "del-cli": "^5.0.0",
     "eslint": "^8.44.0",
     "github-label-sync": "^2.3.1",
-    "glob": "^10.3.1",
+    "glob": "^10.3.2",
     "husky": "^8.0.3",
     "japa": "^4.0.0",
     "np": "^8.0.4",
@@ -65,7 +65,7 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@japa/core": "^8.0.0-8",
+    "@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",