@japa/runner 3.0.0-9 → 3.0.1

package/build/src/cli_parser.js

@@ -15,7 +15,7 @@ const ansi = colors.ansi();
  * will be parsed aswell, but without any normalization
  */
 const OPTIONS = {
-    string: ['tests', 'groups', 'tags', 'files', 'timeout', 'retries', 'reporter', 'failed'],
+    string: ['tests', 'groups', 'tags', 'files', 'timeout', 'retries', 'reporters', 'failed'],
     boolean: ['help', 'matchAll', 'failed'],
     alias: {
         forceExit: 'force-exit',
@@ -36,7 +36,7 @@ ${ansi.green('--files')}                     ${ansi.dim('Filter tests by the fil
 ${ansi.green('--force-exit')}                ${ansi.dim('Forcefully exit the process')}
 ${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('--reporters')}                 ${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')}
 

package/build/src/config_manager.js

@@ -105,8 +105,8 @@ export class ConfigManager {
      * --reporter flag
      */
     #getCLIReporters() {
-        if (this.#cliArgs.reporter) {
-            return this.#processAsArray(this.#cliArgs.reporter);
+        if (this.#cliArgs.reporters) {
+            return this.#processAsArray(this.#cliArgs.reporters);
         }
     }
     /**

package/build/src/types.d.ts

@@ -31,7 +31,7 @@ export type CLIArgs = {
     groups?: string | string[];
     timeout?: string;
     retries?: string;
-    reporter?: string | string[];
+    reporters?: string | string[];
     forceExit?: boolean;
     failed?: boolean;
     help?: boolean;

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@japa/runner",
   "description": "Runner for Japa testing framework",
-  "version": "3.0.0-9",
+  "version": "3.0.1",
   "engines": {
     "node": ">=18.16.0"
   },
   "main": "build/index.js",
   "type": "module",
   "files": [
-    "build"
+    "build/factories",
+    "build/modules",
+    "build/src",
+    "build/index.d.ts",
+    "build/index.js"
   ],
   "exports": {
     ".": "./build/index.js",
@@ -36,22 +40,22 @@
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
     "@adonisjs/tsconfig": "^1.1.8",
-    "@commitlint/cli": "^17.7.1",
+    "@commitlint/cli": "^17.7.2",
     "@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": "^5.0.0",
-    "@types/ms": "^0.7.31",
-    "@types/node": "^20.6.3",
+    "@types/ms": "^0.7.32",
+    "@types/node": "^20.8.3",
     "c8": "^8.0.1",
-    "chai": "^4.3.8",
+    "chai": "^4.3.10",
     "chai-subset": "^1.6.0",
     "cross-env": "^7.0.3",
     "del-cli": "^5.1.0",
-    "eslint": "^8.50.0",
+    "eslint": "^8.51.0",
     "github-label-sync": "^2.3.1",
-    "glob": "^10.3.6",
+    "glob": "^10.3.10",
     "husky": "^8.0.3",
     "np": "^8.0.4",
     "prettier": "^3.0.3",
@@ -59,10 +63,10 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@japa/core": "^8.0.0-11",
-    "@japa/errors-printer": "^3.0.0-6",
+    "@japa/core": "^8.0.1",
+    "@japa/errors-printer": "^3.0.0",
     "@poppinss/colors": "^4.1.0-4",
-    "@poppinss/hooks": "^7.1.1-5",
+    "@poppinss/hooks": "^7.1.1-6",
     "fast-glob": "^3.3.1",
     "find-cache-dir": "^5.0.0",
     "getopts": "^2.3.0",
@@ -99,11 +103,11 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "next"
+    "tag": "latest"
   },
   "np": {
     "message": "chore(release): %s",
-    "tag": "next",
+    "tag": "latest",
     "branch": "main",
     "anyBranch": false
   },

package/build/examples/dot.d.ts

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

package/build/examples/dot.js

@@ -1,11 +0,0 @@
-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

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

package/build/examples/ndjson.js

@@ -1,11 +0,0 @@
-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

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

package/build/examples/spec.js

@@ -1,11 +0,0 @@
-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/tests/base_reporter.spec.d.ts

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

package/build/tests/base_reporter.spec.js

@@ -1,111 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { test } from 'node:test';
-import chaiSubset from 'chai-subset';
-import { assert, default as chai } from 'chai';
-chai.use(chaiSubset);
-import { wrapAssertions } from '../tests_helpers/main.js';
-import { Test, Suite, Group, Runner, Refiner, Emitter, TestContext, BaseReporter, } from '../modules/core/main.js';
-test.describe('Base reporter', () => {
-    test('extend base reporter to create a custom reporter', async () => {
-        const stack = [];
-        class MyReporter extends BaseReporter {
-            async start() {
-                stack.push('reporter started');
-            }
-        }
-        const emitter = new Emitter();
-        const runner = new Runner(emitter);
-        runner.registerReporter((r, e) => new MyReporter({}).boot(r, e));
-        await runner.start();
-        await wrapAssertions(() => {
-            assert.deepEqual(stack, ['reporter started']);
-        });
-    });
-    test('invoke handlers when suite, groups and tests are executed', async () => {
-        const stack = [];
-        let summary;
-        class MyReporter extends BaseReporter {
-            async start() {
-                stack.push('reporter started');
-            }
-            async end() {
-                summary = this.runner.getSummary();
-                stack.push('reporter ended');
-            }
-            onTestStart(t) {
-                assert.equal(t.title.expanded, '2 + 2');
-                assert.equal(this.currentSuiteName, 'unit');
-                assert.equal(this.currentGroupName, 'default');
-                stack.push('test started');
-            }
-            onTestEnd(t) {
-                assert.equal(t.title.expanded, '2 + 2');
-                assert.isFalse(t.hasError);
-                stack.push('test ended');
-            }
-            onGroupStart(g) {
-                assert.equal(g.title, 'default');
-                assert.equal(this.currentSuiteName, 'unit');
-                stack.push('group started');
-            }
-            onGroupEnd(g) {
-                assert.equal(g.title, 'default');
-                assert.isFalse(g.hasError);
-                stack.push('group ended');
-            }
-            onSuiteStart(s) {
-                assert.equal(s.name, 'unit');
-                stack.push('suite started');
-            }
-            onSuiteEnd(s) {
-                assert.equal(s.name, 'unit');
-                stack.push('suite ended');
-            }
-        }
-        const emitter = new Emitter();
-        const runner = new Runner(emitter);
-        const refiner = new Refiner();
-        const suite = new Suite('unit', emitter, refiner);
-        const group = new Group('default', emitter, refiner);
-        const t = new Test('2 + 2', (_t) => new TestContext(_t), emitter, refiner, group);
-        group.add(t);
-        suite.add(group);
-        runner.add(suite);
-        runner.registerReporter((r, e) => new MyReporter({}).boot(r, e));
-        await runner.start();
-        await runner.exec();
-        await runner.end();
-        await wrapAssertions(() => {
-            assert.deepEqual(stack, [
-                'reporter started',
-                'suite started',
-                'group started',
-                'test started',
-                'test ended',
-                'group ended',
-                'suite ended',
-                'reporter ended',
-            ]);
-            assert.containSubset(summary, {
-                aggregates: {
-                    total: 1,
-                    failed: 0,
-                    passed: 0,
-                    regression: 0,
-                    skipped: 0,
-                    todo: 1,
-                },
-                hasError: false,
-                failureTree: [],
-                failedTestsTitles: [],
-            });
-        });
-    });
-});

package/build/tests/cli_parser.spec.d.ts

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

package/build/tests/cli_parser.spec.js

@@ -1,265 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { assert } from 'chai';
-import { test } from 'node:test';
-import colors from '@poppinss/colors';
-import { CliParser } from '../src/cli_parser.js';
-import { wrapAssertions } from '../tests_helpers/main.js';
-const DATASET = [
-    [
-        new CliParser().parse([]),
-        {
-            '_': [],
-            'files': '',
-            'groups': '',
-            'reporter': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['unit', 'functional']),
-        {
-            '_': ['unit', 'functional'],
-            'files': '',
-            'reporter': '',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['--timeout', '1000']),
-        {
-            '_': [],
-            'files': '',
-            'reporter': '',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '1000',
-        },
-    ],
-    [
-        new CliParser().parse(['--timeout', '1000', '--retries', '2']),
-        {
-            '_': [],
-            'files': '',
-            'reporter': '',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '2',
-            'tags': '',
-            'tests': '',
-            'timeout': '1000',
-        },
-    ],
-    [
-        new CliParser().parse(['--match-all']),
-        {
-            '_': [],
-            'files': '',
-            'reporter': '',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': true,
-            'matchAll': true,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['--force-exit']),
-        {
-            '_': [],
-            'files': '',
-            'force-exit': true,
-            'forceExit': true,
-            'reporter': '',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['--browser', 'chrome', '--browser', 'firefox']),
-        {
-            '_': [],
-            'files': '',
-            'browser': ['chrome', 'firefox'],
-            'reporter': '',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['--reporter', 'spec']),
-        {
-            '_': [],
-            'files': '',
-            'reporter': 'spec',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['--reporter', 'spec', '--reporter', 'dot']),
-        {
-            '_': [],
-            'files': '',
-            'reporter': ['spec', 'dot'],
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['--reporter', 'spec,dot']),
-        {
-            '_': [],
-            'files': '',
-            'reporter': 'spec,dot',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': false,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-    [
-        new CliParser().parse(['--failed']),
-        {
-            '_': [],
-            'files': '',
-            'reporter': '',
-            'groups': '',
-            'h': false,
-            'help': false,
-            'failed': true,
-            'match-all': false,
-            'matchAll': false,
-            'retries': '',
-            'tags': '',
-            'tests': '',
-            'timeout': '',
-        },
-    ],
-];
-test.describe('CLI parser', () => {
-    test('parse CLI arguments', async () => {
-        for (let [cliArgs, output] of DATASET) {
-            await wrapAssertions(() => {
-                assert.deepEqual(cliArgs, output);
-            });
-        }
-    });
-    if (!process.env.CI) {
-        test('display help', async () => {
-            const ansi = colors.ansi();
-            console.log(new CliParser().getHelp());
-            await wrapAssertions(() => {
-                assert.deepEqual(new CliParser().getHelp().split('\n'), [
-                    '',
-                    ansi.yellow('@japa/runner v2.3.0'),
-                    '',
-                    `${ansi.green('--tests')}                     ${ansi.dim('Filter tests by the test title')}`,
-                    `${ansi.green('--groups')}                    ${ansi.dim('Filter tests by the group title')}`,
-                    `${ansi.green('--tags')}                      ${ansi.dim('Filter tests by tags')}`,
-                    `${ansi.green('--files')}                     ${ansi.dim('Filter tests by the file name')}`,
-                    `${ansi.green('--force-exit')}                ${ansi.dim('Forcefully exit the process')}`,
-                    `${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:')}`,
-                    `${ansi.dim('node bin/test.js --tags="@github"')}`,
-                    `${ansi.dim('node bin/test.js --tags="~@github"')}`,
-                    `${ansi.dim('node bin/test.js --tags="@github,@slow,@integration" --match-all')}`,
-                    `${ansi.dim('node bin/test.js --force-exit')}`,
-                    `${ansi.dim('node bin/test.js --files="user"')}`,
-                    `${ansi.dim('node bin/test.js --files="functional/user"')}`,
-                    `${ansi.dim('node bin/test.js --files="unit/user"')}`,
-                    ``,
-                    `${ansi.yellow('Notes:')}`,
-                    `- When groups and tests filters are applied together. We will first filter the`,
-                    `  tests by group title and then apply the tests title filter.`,
-                    `- The timeout defined on test object takes precedence over the ${ansi.green('--timeout')} flag.`,
-                    `- The retries defined on test object takes precedence over the ${ansi.green('--retries')} flag.`,
-                    `- The ${ansi.green('--files')} flag checks for the file names ending with the filter substring.`,
-                    ``,
-                ]);
-            });
-        });
-    }
-});

package/build/tests/config_manager.spec.d.ts

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