poku 1.4.0 → 1.5.1

package/README.md

@@ -4,15 +4,14 @@
 [bun-version-image]: https://img.shields.io/badge/Bun->=0.5.3-f471b5
 [deno-version-url]: https://github.com/denoland/deno
 [deno-version-image]: https://img.shields.io/badge/Deno->=1.30.0-70ffaf
-[npm-image]: https://img.shields.io/npm/v/poku.svg?color=3dc1d3
-[npm-url]: https://npmjs.org/package/poku
 [typescript-url]: https://github.com/microsoft/TypeScript
+[typescript-version-image]: https://img.shields.io/badge/TypeScript->=5.0.2-3077c6
 [ci-url]: https://github.com/wellwelwel/poku/actions/workflows/ci.yml?query=branch%3Amain
 [ci-image]: https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/ci.yml?event=push&style=flat&label=CI&branch=main
 [ql-url]: https://github.com/wellwelwel/poku/actions/workflows/codeql.yml?query=branch%3Amain
 [ql-image]: https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/codeql.yml?event=push&style=flat&label=Code%20QL&branch=main
 [license-url]: https://github.com/wellwelwel/poku/blob/main/LICENSE
-[license-image]: https://img.shields.io/npm/l/poku.svg?maxAge=2592000&color=9c88ff
+[license-image]: https://img.shields.io/npm/l/poku.svg?maxAge=2592000&color=9c88ff&label=License
 
 # Poku
 
@@ -20,72 +19,71 @@
 
 **Poku** is your test runner pet for [**Node.js**][node-version-url], [**Bun**][bun-version-url] and [**Deno**][deno-version-url] combining **flexibility**, **parallel** and **sequential** runs, **human-friendly assertion errors** and **high isolation level**.
 
+> By creating **Poku**, my aim is to show that testing can be simpler.
+
 [![Node.js Version][node-version-image]][node-version-url]
 [![Bun Version][bun-version-image]][bun-version-url]
 [![Deno Version][deno-version-image]][deno-version-url]
-[![NPM Version][npm-image]][npm-url]
-[![License][license-image]][license-url]
+[![TypeScript Version][typescript-version-image]][typescript-url]
 [![GitHub Workflow Status (with event)][ci-image]][ci-url]
 [![GitHub Workflow Status (with event)][ql-image]][ql-url]
+[![License][license-image]][license-url]
 
-Enjoying Poku? Consider giving him a star ⭐️
+Enjoying **Poku**? Consider giving him a star ⭐️
 
 ---
 
-🐷 [**Documentation Website**](https://poku.dev)
+🐷 [**Documentation Website**](https://poku.dev) • 🔬 [**Compare Poku with the Most Popular Test Runners**](https://poku.dev/docs/comparing)
 
 ---
 
 ## Why Poku?
 
-> **Poku** starts from the premise where tests come to help, not overcomplicate: runs test files in an individual process per file, shows progress and exits 🧙🏻
+Don't worry about `describe`, `it`, `beforeEach` and everything else 🚀 <br/>
+After all, you don't need to learn what you already know ([**see why**](https://poku.dev/docs/examples/beforeEach)) ✨
 
 - Supports **ESM** and **CJS**
 - Designed to be highly intuitive
-- No need to compile [**TypeScript**][typescript-url] \*
 - Compatible with **Coverage** tools
-- Allows both **in-code** and **CLI** usage
 - [**Node.js**][node-version-url], [**Bun**][bun-version-url] and [**Deno**][deno-version-url] compatibility
 - Zero configurations, except you want
-- No constraints or rules, code in your own signature style
+- Allows both **API (_in-code_)** and **CLI** usage
+- Poku adapts to your test, not the other way around
+- You can use **Poku**'s `assert` with every test runner you want
 - [**And much more!**](https://poku.dev)
 
 ---
 
-- <img src="https://img.shields.io/bundlephobia/min/poku?label=Final%20Size">
-- **Zero** external dependencies
+- [![Install Size](https://packagephobia.com/badge?p=poku)](https://packagephobia.com/result?p=poku)
+- **Zero** external dependencies 🌱
 
 ---
 
 ## Documentation
 
-- See detailed specifications and usage in [**Documentation**](https://poku.dev/docs/category/documentation) section for queries, advanced concepts and much more.
+- See detailed usage in [**Documentation**](https://poku.dev/docs/category/documentation) section for **Poku**'s **CLI**, **API (_in-code_)** and **assert**, advanced concepts and much more.
 
 ---
 
 ## Overview
 
-| Sequential                                                   | Parallel                                                   |
-| ------------------------------------------------------------ | ---------------------------------------------------------- |
-| `npx poku test/unit,test/integration`                        | `npx poku --parallel test/unit,test/integration`           |
-| <img src=".github/assets/readme/sequential.png" width="360"> | <img src=".github/assets/readme/parallel.png" width="360"> |
+### `poku`
 
-- By default, **Poku** searches for all _`.test.`_ files, but you can customize it using the option [`filter`](https://github.com/wellwelwel/poku#filter-rexexp).
-- The same idea for [**Bun**][bun-version-url] and [**Deno**][deno-version-url] (see bellow).
+| Sequential                                         | Concurrent                                       |
+| -------------------------------------------------- | ------------------------------------------------ |
+| <img src=".github/assets/readme/sequential.png" /> | <img src=".github/assets/readme/parallel.png" /> |
 
----
+> [**See the complete `poku` documentation**](https://poku.dev/docs/category/poku).
 
-**Poku** also includes the `assert` method, keeping everything as it is, but providing human readability:
+---
 
-```ts
-import { assert } from 'poku'; // Node and Bun
-import { assert } from 'npm:poku'; // Deno
+### `assert`
 
-assert(true);
-assert.deepStrictEqual(1, '1', 'My optional custom message');
-```
+| Using `poku`                                        | Using `node`                                        |
+| --------------------------------------------------- | --------------------------------------------------- |
+| <img src=".github/assets/readme/assert-poku.png" /> | <img src=".github/assets/readme/assert-node.png" /> |
 
-> <img src=".github/assets/readme/assert.png" width="468" />
+> [**See the complete assert's documentation**](https://poku.dev/docs/documentation/assert).
 
 ---
 
@@ -93,86 +91,68 @@ assert.deepStrictEqual(1, '1', 'My optional custom message');
 
 ### **Node.js**
 
-> <img src=".github/assets/readme/node-js.svg" width="24" />
-
 ```bash
-npm install --save-dev poku
+npm i -D poku
 ```
 
 ### TypeScript (Node.js)
 
-> <img src=".github/assets/readme/node-js.svg" width="24" />
-> <img src=".github/assets/readme/plus.svg" width="24" />
-> <img src=".github/assets/readme/typescript.svg" width="24" />
-
 ```bash
-npm install --save-dev poku tsx
+npm i -D poku tsx
 ```
 
 ### Bun
 
-> <img src=".github/assets/readme/bun.svg" width="24" />
-> <img src=".github/assets/readme/plus.svg" width="24" />
-> <img src=".github/assets/readme/typescript.svg" width="24" />
-
 ```bash
-bun add --dev poku
+bun add -d poku
 ```
 
 ### **Deno**
 
-> <img src=".github/assets/readme/deno.svg" width="24" />
-> <img src=".github/assets/readme/plus.svg" width="24" />
-> <img src=".github/assets/readme/typescript.svg" width="24" />
-
 ```ts
 import { poku } from 'npm:poku';
 ```
 
-- **Poku** requires these permissions by default: `--allow-read`, `--allow-env` and `--allow-run`.
-
 ---
 
 ## Quick Start
 
-### In-code
+### CLI
 
 > <img src=".github/assets/readme/node-js.svg" width="24" />
-> <img src=".github/assets/readme/plus.svg" width="24" />
-> <img src=".github/assets/readme/bun.svg" width="24" />
-
-```ts
-import { poku } from 'poku';
 
-await poku(['targetDirA', 'targetDirB']);
+```bash
+npx poku targetDir
 ```
 
-> <img src=".github/assets/readme/deno.svg" width="24" />
-
-```ts
-import { poku } from 'npm:poku';
+> <img src=".github/assets/readme/bun.svg" width="24" />
 
-await poku(['targetDirA', 'targetDirB']);
+```bash
+bun poku targetDir
 ```
 
-### CLI
-
-> <img src=".github/assets/readme/node-js.svg" width="24" />
+> <img src=".github/assets/readme/deno.svg" width="24" />
 
 ```bash
-npx poku targetDirA,targetDirB
+deno run npm:poku targetDir
 ```
 
-> <img src=".github/assets/readme/bun.svg" width="24" />
+### API (_In-code_)
 
-```bash
-bun poku targetDirA,targetDirB
+#### Node.js, TypeScript (Node.js) and Bun
+
+```ts
+import { poku } from 'poku';
+
+await poku(['targetDir']);
 ```
 
-> <img src=".github/assets/readme/deno.svg" width="24" />
+#### Deno
 
-```bash
-deno run npm:poku targetDirA,targetDirB
+```ts
+import { poku } from 'npm:poku';
+
+await poku(['targetDir']);
 ```
 
 ---
@@ -189,4 +169,22 @@ I'm continuously working to improve **Poku**. If you've got something interestin
 
 ## Acknowledgements
 
-- [**Contributors**](https://github.com/wellwelwel/poku/graphs/contributors)
+- [**Contributors**](https://github.com/wellwelwel/poku/graphs/contributors).
+
+---
+
+## Contributing
+
+Please check the [**CONTRIBUTING.md**](./CONTRIBUTING.md) for instructions 🚀
+
+---
+
+## License
+
+Poku is under the [**MIT** License](./LICENSE).
+
+---
+
+## Security Policy
+
+Please check the [**SECURITY.md**](./SECURITY.md) and the section [**Is Poku Safe?**](https://poku.dev/docs/security) from Documentation.

package/lib/@types/poku.d.ts

@@ -9,14 +9,19 @@ export type Configs = {
      */
     noExit?: boolean;
     /**
+     * @deprecated
      * Customize `stdout` options.
      */
     log?: {
         /**
+         * @deprecated
+         *
          * @default false
          */
         success?: boolean;
         /**
+         * @deprecated
+         *
          * @default true
          */
         fail?: boolean;
@@ -26,6 +31,12 @@ export type Configs = {
      *
      * @default false
      */
+    debug?: boolean;
+    /**
+     * This option overwrites the `debug` settings.
+     *
+     * @default false
+     */
     quiet?: boolean;
     /**
      * Determines the mode of test execution.

package/lib/bin/index.js

@@ -6,6 +6,7 @@ const list_files_js_1 = require("../modules/list-files.js");
 const get_arg_js_1 = require("../helpers/get-arg.js");
 const index_js_1 = require("../index.js");
 const get_runtime_js_1 = require("../helpers/get-runtime.js");
+const format_js_1 = require("../helpers/format.js");
 const dirs = ((0, get_arg_js_1.hasArg)('include')
     ? (_a = (0, get_arg_js_1.getArg)('include')) === null || _a === void 0 ? void 0 : _a.split(',')
     : (_b = (0, get_arg_js_1.getLastParam)()) === null || _b === void 0 ? void 0 : _b.split(',')) || [];
@@ -14,14 +15,14 @@ const filter = (0, get_arg_js_1.getArg)('filter');
 const exclude = (0, get_arg_js_1.getArg)('exclude');
 const parallel = (0, get_arg_js_1.hasArg)('parallel');
 const quiet = (0, get_arg_js_1.hasArg)('quiet');
-const logSuccess = (0, get_arg_js_1.hasArg)('log-success');
+const debug = (0, get_arg_js_1.hasArg)('debug');
+if ((0, get_arg_js_1.hasArg)('log-success'))
+    console.log(`The flag ${format_js_1.format.bold('--log-success')} is deprecated. Use ${format_js_1.format.bold('--debug')} instead.`);
 (0, index_js_1.poku)(dirs, {
     platform: (0, get_runtime_js_1.platformIsValid)(platform) ? platform : undefined,
     filter: filter ? new RegExp((0, list_files_js_1.escapeRegExp)(filter)) : undefined,
     exclude: exclude ? new RegExp((0, list_files_js_1.escapeRegExp)(exclude)) : undefined,
     parallel,
     quiet,
-    log: {
-        success: logSuccess,
-    },
+    debug,
 });

package/lib/helpers/format.d.ts

@@ -6,4 +6,6 @@ export declare const format: {
     info: (value: string) => string;
     success: (value: string) => string;
     fail: (value: string) => string;
+    bg: (bg: number, text: string) => string;
 };
+export declare const getLargestStringLength: (arr: string[]) => number;

package/lib/helpers/format.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.format = void 0;
+exports.getLargestStringLength = exports.format = void 0;
 const pad_js_1 = require("./pad.js");
 exports.format = {
     counter: (current, total, pad = '0') => {
@@ -10,7 +10,14 @@ exports.format = {
     dim: (value) => `\x1b[2m${value}\x1b[0m`,
     bold: (value) => `\x1b[1m${value}\x1b[0m`,
     underline: (value) => `\x1b[4m${value}\x1b[0m`,
-    info: (value) => `\x1b[36m${value}\x1b[0m`,
+    info: (value) => `\x1b[94m${value}\x1b[0m`,
     success: (value) => `\x1b[32m${value}\x1b[0m`,
-    fail: (value) => `\x1b[31m${value}\x1b[0m`,
+    fail: (value) => `\x1b[91m${value}\x1b[0m`,
+    bg: (bg, text) => {
+        const padding = ' '.repeat(1);
+        const paddedText = `${padding}${text}${padding}`;
+        return `\x1b[${bg}m\x1b[1m${paddedText}\x1b[0m`;
+    },
 };
+const getLargestStringLength = (arr) => arr.reduce((max, current) => Math.max(max, current.length), 0);
+exports.getLargestStringLength = getLargestStringLength;

package/lib/helpers/hr.js

@@ -7,8 +7,7 @@ exports.hr = void 0;
 const node_os_1 = require("os");
 const node_process_1 = __importDefault(require("process"));
 const hr = () => {
-    const columns = node_process_1.default.stdout.columns;
-    const line = '_'.repeat(columns - 10 || 30);
-    console.log(`\x1b[2m${line}\x1b[0m${node_os_1.EOL}`);
+    const line = '⎯'.repeat(node_process_1.default.stdout.columns - 10);
+    console.log(`${node_os_1.EOL}\x1b[2m\x1b[90m${line}\x1b[0m${node_os_1.EOL}`);
 };
 exports.hr = hr;

package/lib/helpers/logs.d.ts

@@ -1,4 +1,3 @@
 import { Configs } from '../@types/poku.js';
 export declare const isQuiet: (configs?: Configs) => boolean;
-export declare const showSuccesses: (configs?: Configs) => boolean;
-export declare const showFailures: (configs?: Configs) => boolean;
+export declare const isDebug: (configs?: Configs) => boolean;

package/lib/helpers/logs.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.showFailures = exports.showSuccesses = exports.isQuiet = void 0;
+exports.isDebug = exports.isQuiet = void 0;
 const isQuiet = (configs) => typeof (configs === null || configs === void 0 ? void 0 : configs.quiet) === 'boolean' && Boolean(configs === null || configs === void 0 ? void 0 : configs.quiet);
 exports.isQuiet = isQuiet;
-const showSuccesses = (configs) => { var _a; return Boolean((_a = configs === null || configs === void 0 ? void 0 : configs.log) === null || _a === void 0 ? void 0 : _a.success); };
-exports.showSuccesses = showSuccesses;
-const showFailures = (configs) => { var _a, _b; return typeof ((_a = configs === null || configs === void 0 ? void 0 : configs.log) === null || _a === void 0 ? void 0 : _a.fail) === 'undefined' || Boolean((_b = configs === null || configs === void 0 ? void 0 : configs.log) === null || _b === void 0 ? void 0 : _b.fail); };
-exports.showFailures = showFailures;
+const isDebug = (configs) => Boolean(configs === null || configs === void 0 ? void 0 : configs.debug);
+exports.isDebug = isDebug;

package/lib/helpers/parseAsssetion.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseAssertion = void 0;
 const node_process_1 = __importDefault(require("process"));
+const node_path_1 = __importDefault(require("path"));
 const node_assert_1 = __importDefault(require("assert"));
 const node_os_1 = require("os");
 const format_js_1 = require("./format.js");
@@ -25,35 +26,50 @@ const findFile = (error) => {
     }
     return file;
 };
+const formatFail = (str) => format_js_1.format.bold(format_js_1.format.fail(`✘ ${str}`));
 const parseAssertion = (cb, options) => {
+    var _a, _b;
+    const isPoku = typeof ((_a = node_process_1.default.env) === null || _a === void 0 ? void 0 : _a.FILE) === 'string' && ((_b = node_process_1.default.env) === null || _b === void 0 ? void 0 : _b.FILE.length) > 0;
+    const FILE = node_process_1.default.env.FILE;
     try {
         cb();
+        if (typeof options.message === 'string') {
+            const message = isPoku
+                ? `${format_js_1.format.bold(format_js_1.format.success(`✔ ${options.message}`))} ${format_js_1.format.dim(format_js_1.format.success(`› ${FILE}`))}`
+                : format_js_1.format.bold(format_js_1.format.success(`✔ ${options.message}`));
+            console.log(message);
+        }
     }
     catch (error) {
         if (error instanceof node_assert_1.default.AssertionError) {
             const { code, actual, expected, operator } = error;
-            const file = findFile(error);
-            (0, hr_js_1.hr)();
+            const absoultePath = findFile(error);
+            const file = node_path_1.default.relative(node_path_1.default.resolve(node_process_1.default.cwd()), absoultePath);
+            let message = '';
             if (typeof options.message === 'string')
-                console.log(format_js_1.format.bold(options.message), node_os_1.EOL);
+                message = options.message;
             else if (options.message instanceof Error)
-                console.log(format_js_1.format.bold(options.message.message), node_os_1.EOL);
+                message = options.message.message;
             else if (typeof options.defaultMessage === 'string')
-                console.log(options.defaultMessage, node_os_1.EOL);
-            console.log(format_js_1.format.dim('Code:    '), format_js_1.format.bold(format_js_1.format.fail(code)));
-            file && console.log(format_js_1.format.dim('File:    '), file);
-            console.log(format_js_1.format.dim('Operator:'), operator);
-            (0, hr_js_1.hr)();
+                message = options.defaultMessage;
+            const finalMessage = (message === null || message === void 0 ? void 0 : message.trim().length) > 0
+                ? `${formatFail(message)}`
+                : `${formatFail('No Message')}`;
+            console.log(isPoku
+                ? `${finalMessage} ${format_js_1.format.dim(format_js_1.format.fail(`› ${FILE}`))}`
+                : finalMessage);
+            file && console.log(`${format_js_1.format.dim('      File')} ${file}`);
+            console.log(`${format_js_1.format.dim('      Code')} ${code}`);
+            console.log(`${format_js_1.format.dim('  Operator')} ${operator}${node_os_1.EOL}`);
             if (!(options === null || options === void 0 ? void 0 : options.hideDiff)) {
-                console.log(format_js_1.format.dim(`${(options === null || options === void 0 ? void 0 : options.actual) || 'Actual'}:`));
+                console.log(format_js_1.format.dim(`  ${(options === null || options === void 0 ? void 0 : options.actual) || 'Actual'}:`));
                 console.log(format_js_1.format.bold(typeof actual === 'function' || actual instanceof RegExp
-                    ? String(actual)
-                    : format_js_1.format.fail(JSON.stringify(actual))));
-                console.log(`${node_os_1.EOL}${format_js_1.format.dim(`${(options === null || options === void 0 ? void 0 : options.expected) || 'Expected'}:`)}`);
-                console.log(format_js_1.format.bold(typeof expected === 'function' || expected instanceof RegExp
-                    ? String(expected)
-                    : format_js_1.format.success(JSON.stringify(expected))));
-                (0, hr_js_1.hr)();
+                    ? `  ${String(actual)}`
+                    : `  ${format_js_1.format.fail(JSON.stringify(actual))}`));
+                console.log(`${node_os_1.EOL}  ${format_js_1.format.dim(`${(options === null || options === void 0 ? void 0 : options.expected) || 'Expected'}:`)}`);
+                console.log(format_js_1.format.bold(`${typeof expected === 'function' || expected instanceof RegExp
+                    ? `  ${String(expected)}`
+                    : `  ${format_js_1.format.success(JSON.stringify(expected))}`}`));
             }
             if (options.throw) {
                 console.log(error);

package/lib/helpers/remove-repeats.d.ts

@@ -0,0 +1 @@
+export declare const removeConsecutiveRepeats: (arr: string[], specificItem: RegExp) => string[];

package/lib/helpers/remove-repeats.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeConsecutiveRepeats = void 0;
+const removeConsecutiveRepeats = (arr, specificItem) => {
+    const result = [];
+    let consecutiveCount = 0;
+    for (let i = 0; i < arr.length; i++) {
+        if (specificItem.test(arr[i])) {
+            consecutiveCount++;
+            if (consecutiveCount <= 2) {
+                result.push(arr[i]);
+            }
+        }
+        else {
+            consecutiveCount = 0;
+            result.push(arr[i]);
+        }
+        // Check if the next item is different or we're at the end of the array
+        if (i + 1 === arr.length || !specificItem.test(arr[i + 1])) {
+            // If more than two consecutive, remove them from the result
+            if (consecutiveCount > 2) {
+                result.splice(-consecutiveCount);
+            }
+            consecutiveCount = 0; // Reset the counter for the next group
+        }
+    }
+    return result;
+};
+exports.removeConsecutiveRepeats = removeConsecutiveRepeats;

package/lib/modules/assert.js

@@ -35,7 +35,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.assert = void 0;
 const nodeAssert = __importStar(require("assert"));
 const parseAsssetion_js_1 = require("../helpers/parseAsssetion.js");
-const format_js_1 = require("../helpers/format.js");
 const ok = (value, message) => (0, parseAsssetion_js_1.parseAssertion)(() => nodeAssert.ok(value), { message });
 const equal = (actual, expected, message) => (0, parseAsssetion_js_1.parseAssertion)(() => nodeAssert.equal(actual, expected), { message });
 const deepEqual = (actual, expected, message) => (0, parseAsssetion_js_1.parseAssertion)(() => nodeAssert.deepEqual(actual, expected), { message });
@@ -47,7 +46,7 @@ const doesNotMatch = (value, regExp, message) => (0, parseAsssetion_js_1.parseAs
     message,
     actual: 'Value',
     expected: 'RegExp',
-    defaultMessage: format_js_1.format.bold('Value should not match regExp'),
+    defaultMessage: 'Value should not match regExp',
 });
 function doesNotReject(block, errorOrMessage, message) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -62,7 +61,7 @@ function doesNotReject(block, errorOrMessage, message) {
                     throw error;
                 }, {
                     message,
-                    defaultMessage: format_js_1.format.bold('Got unwanted rejection'),
+                    defaultMessage: 'Got unwanted rejection',
                     hideDiff: true,
                     throw: true,
                 });
@@ -77,7 +76,7 @@ function doesNotReject(block, errorOrMessage, message) {
                     throw error_1;
                 }, {
                     message: typeof errorOrMessage === 'string' ? errorOrMessage : undefined,
-                    defaultMessage: format_js_1.format.bold('Got unwanted rejection'),
+                    defaultMessage: 'Got unwanted rejection',
                     hideDiff: true,
                     throw: true,
                 });
@@ -97,7 +96,7 @@ function doesNotThrow(block, errorOrMessage, message) {
                 throw error;
             }, {
                 message: message,
-                defaultMessage: format_js_1.format.bold('Expected function not to throw'),
+                defaultMessage: 'Expected function not to throw',
                 hideDiff: true,
                 throw: true,
             });
@@ -113,7 +112,7 @@ function doesNotThrow(block, errorOrMessage, message) {
                 throw error;
             }, {
                 message: msg,
-                defaultMessage: format_js_1.format.bold('Expected function not to throw'),
+                defaultMessage: 'Expected function not to throw',
                 hideDiff: true,
                 throw: true,
             });
@@ -132,7 +131,7 @@ function throws(block, errorOrMessage, message) {
                 throw error;
             }, {
                 message: message,
-                defaultMessage: format_js_1.format.bold('Expected function to throw'),
+                defaultMessage: 'Expected function to throw',
                 hideDiff: true,
             });
         }
@@ -147,7 +146,7 @@ function throws(block, errorOrMessage, message) {
                 throw error;
             }, {
                 message: msg,
-                defaultMessage: format_js_1.format.bold('Expected function to throw'),
+                defaultMessage: 'Expected function to throw',
                 hideDiff: true,
             });
         }
@@ -167,7 +166,7 @@ const match = (value, regExp, message) => (0, parseAsssetion_js_1.parseAssertion
     message,
     actual: 'Value',
     expected: 'RegExp',
-    defaultMessage: format_js_1.format.bold('Value should match regExp'),
+    defaultMessage: 'Value should match regExp',
 });
 const ifError = (value) => {
     try {
@@ -177,7 +176,7 @@ const ifError = (value) => {
         (0, parseAsssetion_js_1.parseAssertion)(() => {
             throw error;
         }, {
-            defaultMessage: format_js_1.format.bold('Expected no error, but received an error'),
+            defaultMessage: 'Expected no error, but received an error',
             hideDiff: true,
             throw: true,
         });
@@ -192,7 +191,7 @@ const fail = (message) => {
             throw error;
         }, {
             message,
-            defaultMessage: format_js_1.format.bold('Test failed intentionally'),
+            defaultMessage: 'Test failed intentionally',
             hideDiff: true,
         });
     }
@@ -210,7 +209,7 @@ function rejects(block, errorOrMessage, message) {
                     throw error;
                 }, {
                     message,
-                    defaultMessage: format_js_1.format.bold('Expected promise to be rejected with specified error'),
+                    defaultMessage: 'Expected promise to be rejected with specified error',
                     hideDiff: true,
                 });
             }
@@ -225,7 +224,7 @@ function rejects(block, errorOrMessage, message) {
                     throw error_1;
                 }, {
                     message: msg,
-                    defaultMessage: format_js_1.format.bold('Expected promise to be rejected'),
+                    defaultMessage: 'Expected promise to be rejected',
                     hideDiff: true,
                 });
             }

package/lib/modules/exit.js

@@ -5,23 +5,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.exit = void 0;
 const node_process_1 = __importDefault(require("process"));
-const node_os_1 = require("os");
 const hr_js_1 = require("../helpers/hr.js");
+const run_tests_js_1 = require("../services/run-tests.js");
+const format_js_1 = require("../helpers/format.js");
 const exit = (code, quiet) => {
+    const isPoku = run_tests_js_1.results.success > 0 || run_tests_js_1.results.fail > 0;
     !quiet &&
         node_process_1.default.on('exit', (code) => {
-            console.log(`Exited with code`, code, node_os_1.EOL);
+            isPoku &&
+                console.log(format_js_1.format.bg(42, `PASS › ${run_tests_js_1.results.success}`), format_js_1.format.bg(run_tests_js_1.results.fail === 0 ? 100 : 41, `FAIL › ${run_tests_js_1.results.fail}`));
+            isPoku && (0, hr_js_1.hr)();
+            console.log(`${format_js_1.format.dim('Exited with code')} ${format_js_1.format.bold(format_js_1.format === null || format_js_1.format === void 0 ? void 0 : format_js_1.format[code === 0 ? 'success' : 'fail'](String(code)))}`);
         });
-    !quiet && (0, hr_js_1.hr)();
-    if (code !== 0) {
-        !quiet && console.log('Some tests failed.');
+    isPoku && !quiet && (0, hr_js_1.hr)();
+    if (code !== 0)
         node_process_1.default.exit(1);
-    }
-    !quiet && console.log('All tests passed.');
     node_process_1.default.exit(0);
 };
 exports.exit = exit;
-node_process_1.default.stdout.on('resize', hr_js_1.hr);
 node_process_1.default.on('unhandledRejection', (reason) => {
     console.log('unhandledRejection', reason);
     node_process_1.default.exit(1);

package/lib/modules/list-files.d.ts

@@ -1,4 +1,5 @@
 import type { Configs } from '../@types/list-files.js';
+export declare const sanitizePath: (input: string, ensureTarget?: boolean) => string;
 export declare const escapeRegExp: (string: string) => string;
 export declare const listFiles: (dirPath: string, files?: string[], configs?: Configs) => string[];
 export declare const publicListFiles: (targetDir: string, configs?: Configs) => string[];

package/lib/modules/list-files.js

@@ -4,18 +4,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.publicListFiles = exports.listFiles = exports.escapeRegExp = void 0;
+exports.publicListFiles = exports.listFiles = exports.escapeRegExp = exports.sanitizePath = void 0;
 const node_process_1 = __importDefault(require("process"));
 const node_fs_1 = __importDefault(require("fs"));
 const node_path_1 = __importDefault(require("path"));
+const sanitizePath = (input, ensureTarget) => {
+    const sanitizedPath = input
+        .replace(/[/\\]+/g, node_path_1.default.sep) // adapting slashes according to OS
+        .replace(/(\.\.(\/|\\|$))+/g, '') // ensure the current path level
+        .replace(/[<>:|^?*]+/g, ''); // removing unusual path characters
+    // Preventing absolute path access
+    return ensureTarget ? sanitizedPath.replace(/^[/\\]/, './') : sanitizedPath;
+};
+exports.sanitizePath = sanitizePath;
 const escapeRegExp = (string) => string.replace(/[.*{}[\]\\]/g, '\\$&');
 exports.escapeRegExp = escapeRegExp;
 const envFilter = ((_a = node_process_1.default.env.FILTER) === null || _a === void 0 ? void 0 : _a.trim())
     ? new RegExp((0, exports.escapeRegExp)(node_process_1.default.env.FILTER), 'i')
     : null;
 const listFiles = (dirPath, files = [], configs) => {
-    const currentFiles = node_fs_1.default.readdirSync(dirPath);
-    const defaultRegExp = /\.test\./i;
+    const currentFiles = node_fs_1.default.readdirSync((0, exports.sanitizePath)(dirPath));
+    const defaultRegExp = /\.(test|spec)\./i;
     const filter = (envFilter
         ? envFilter
         : (configs === null || configs === void 0 ? void 0 : configs.filter) instanceof RegExp
@@ -27,7 +36,9 @@ const listFiles = (dirPath, files = [], configs) => {
             : [configs.exclude]
         : undefined;
     for (const file of currentFiles) {
-        const fullPath = node_path_1.default.join(dirPath, file);
+        const fullPath = (0, exports.sanitizePath)(node_path_1.default.join(dirPath, file));
+        if (/node_modules/.test(fullPath))
+            continue;
         if (exclude && exclude.some((regex) => regex.test(fullPath)))
             continue;
         if (node_fs_1.default.statSync(fullPath).isDirectory())
@@ -38,5 +49,5 @@ const listFiles = (dirPath, files = [], configs) => {
     return files;
 };
 exports.listFiles = listFiles;
-const publicListFiles = (targetDir, configs) => (0, exports.listFiles)(targetDir, [], configs);
+const publicListFiles = (targetDir, configs) => (0, exports.listFiles)((0, exports.sanitizePath)(targetDir), [], configs);
 exports.publicListFiles = publicListFiles;

package/lib/modules/poku.js

@@ -10,17 +10,38 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.poku = void 0;
+const node_os_1 = require("os");
 const force_array_js_1 = require("../helpers/force-array.js");
 const run_tests_js_1 = require("../services/run-tests.js");
 const exit_js_1 = require("./exit.js");
+const format_js_1 = require("../helpers/format.js");
+const logs_js_1 = require("../helpers/logs.js");
+const hr_js_1 = require("../helpers/hr.js");
+const run_test_file_js_1 = require("../services/run-test-file.js");
+const indentation_js_1 = require("../helpers/indentation.js");
 function poku(targetDirs, configs) {
     return __awaiter(this, void 0, void 0, function* () {
         let code = 0;
-        const dirs = (0, force_array_js_1.forceArray)(targetDirs);
+        const prepareDirs = (0, force_array_js_1.forceArray)(targetDirs);
+        const dirs = prepareDirs.length > 0 ? prepareDirs : ['./'];
+        const showLogs = !(0, logs_js_1.isQuiet)(configs);
         if (configs === null || configs === void 0 ? void 0 : configs.parallel) {
-            const results = yield Promise.all(dirs.map((dir) => (0, run_tests_js_1.runTestsParallel)(dir, configs)));
-            if (results.some((result) => !result))
+            if (showLogs) {
+                (0, hr_js_1.hr)();
+                console.log(`${format_js_1.format.bold('Running the Test Suite in Parallel')}${node_os_1.EOL}`);
+            }
+            const concurrency = yield Promise.all(dirs.map((dir) => (0, run_tests_js_1.runTestsParallel)(dir, configs)));
+            if (concurrency.some((result) => !result))
                 code = 1;
+            showLogs && (0, hr_js_1.hr)();
+            if (showLogs && run_test_file_js_1.fileResults.success.length > 0)
+                console.log(run_test_file_js_1.fileResults.success
+                    .map((current) => `${indentation_js_1.indentation.test}${format_js_1.format.success('✔')} ${format_js_1.format.dim(current)}`)
+                    .join(node_os_1.EOL));
+            if (showLogs && run_test_file_js_1.fileResults.fail.length > 0)
+                console.log(run_test_file_js_1.fileResults.fail
+                    .map((current) => `${indentation_js_1.indentation.test}${format_js_1.format.fail('✘')} ${current}`)
+                    .join(node_os_1.EOL));
             if (configs === null || configs === void 0 ? void 0 : configs.noExit)
                 return code;
             (0, exit_js_1.exit)(code, configs === null || configs === void 0 ? void 0 : configs.quiet);

package/lib/services/run-test-file.d.ts

@@ -1,2 +1,8 @@
 import { Configs } from '../@types/poku.js';
+type FileResults = {
+    success: string[];
+    fail: string[];
+};
+export declare const fileResults: FileResults;
 export declare const runTestFile: (filePath: string, configs?: Configs) => Promise<boolean>;
+export {};

package/lib/services/run-test-file.js

@@ -3,44 +3,83 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runTestFile = void 0;
+exports.runTestFile = exports.fileResults = void 0;
 const node_process_1 = __importDefault(require("process"));
-const node_child_process_1 = require("child_process");
+const node_os_1 = require("os");
 const node_path_1 = __importDefault(require("path"));
+const node_child_process_1 = require("child_process");
 const runner_js_1 = require("../helpers/runner.js");
 const indentation_js_1 = require("../helpers/indentation.js");
 const format_js_1 = require("../helpers/format.js");
 const logs_js_1 = require("../helpers/logs.js");
+const remove_repeats_js_1 = require("../helpers/remove-repeats.js");
+exports.fileResults = {
+    success: [],
+    fail: [],
+};
 const runTestFile = (filePath, configs) => new Promise((resolve) => {
-    let output = '';
-    const showLogs = !(0, logs_js_1.isQuiet)(configs);
-    const showSuccess = (0, logs_js_1.showSuccesses)(configs);
-    const showFailure = (0, logs_js_1.showFailures)(configs);
-    const log = () => console.log(output === null || output === void 0 ? void 0 : output.trim());
-    const fileRelative = node_path_1.default.relative(node_process_1.default.cwd(), filePath);
-    showLogs &&
-        console.log(`${indentation_js_1.indentation.test}${format_js_1.format.info('→')} ${fileRelative}`);
     const runtimeOptions = (0, runner_js_1.runner)(filePath, configs);
     const runtime = runtimeOptions.shift();
     const runtimeArguments = runtimeOptions.length > 1 ? [...runtimeOptions, filePath] : [filePath];
+    const fileRelative = node_path_1.default.relative(node_process_1.default.cwd(), filePath);
+    const showLogs = !(0, logs_js_1.isQuiet)(configs);
+    const showSuccess = (0, logs_js_1.isDebug)(configs);
+    const pad = (configs === null || configs === void 0 ? void 0 : configs.parallel) ? '  ' : '    ';
+    let output = '';
+    const log = () => {
+        const outputs = (0, remove_repeats_js_1.removeConsecutiveRepeats)(showSuccess
+            ? output.split(/(\r\n|\r|\n)/)
+            : output.split(/(\r\n|\r|\n)/).filter((current) => {
+                if (current.includes('Exited with code'))
+                    return false;
+                return (/u001b\[0m|(\r\n|\r|\n)/i.test(JSON.stringify(current)) ||
+                    current === '');
+            }), /(\r\n|\r|\n)|^$/);
+        // Remove last EOL
+        outputs.length > 1 && outputs.pop();
+        if (!showSuccess &&
+            /error:/i.test(output) &&
+            !/error:/i.test(outputs.join()))
+            Object.assign(outputs, [
+                ...outputs,
+                format_js_1.format.bold(format_js_1.format.fail(`✘ External Error ${format_js_1.format.dim(`› ${fileRelative}`)}`)),
+                format_js_1.format.dim('  For detailed diagnostics:'),
+                `${format_js_1.format.dim(`    CLI ›`)} rerun with the ${format_js_1.format.bold('--debug')} flag enabled.`,
+                `${format_js_1.format.dim(`    API ›`)} set the config option ${format_js_1.format.bold('debug')} to true.`,
+                `${format_js_1.format.dim('    RUN ›')} ${format_js_1.format.bold(`${runtime === 'tsx' ? 'npx tsx' : runtime}${runtimeArguments.slice(0, -1).join(' ')} ${fileRelative}`)}`,
+            ]);
+        const mappedOutputs = outputs.map((current) => `${pad}${current}`);
+        if (outputs.length === 1 && outputs[0] === '')
+            return;
+        console.log(showSuccess ? mappedOutputs.join('') : mappedOutputs.join(node_os_1.EOL));
+    };
+    const stdOut = (data) => {
+        output += String(data);
+    };
+    if (!(configs === null || configs === void 0 ? void 0 : configs.parallel)) {
+        showLogs &&
+            console.log(`${indentation_js_1.indentation.test}${format_js_1.format.info(format_js_1.format.dim('●'))} ${format_js_1.format.dim(fileRelative)}`);
+    }
     const child = (0, node_child_process_1.spawn)(runtime, runtimeArguments, {
         stdio: ['inherit', 'pipe', 'pipe'],
-        env: node_process_1.default.env,
-    });
-    child.stdout.on('data', (data) => {
-        output += data.toString();
-    });
-    child.stderr.on('data', (data) => {
-        output += data.toString();
+        shell: false,
+        env: Object.assign(Object.assign({}, node_process_1.default.env), { FILE: (configs === null || configs === void 0 ? void 0 : configs.parallel) ? fileRelative : '' }),
     });
+    child.stdout.on('data', stdOut);
+    child.stderr.on('data', stdOut);
     child.on('close', (code) => {
-        if (showLogs &&
-            ((code === 0 && showSuccess) || (code !== 0 && showFailure)))
+        if (showLogs)
             log();
-        resolve(code === 0);
+        const result = code === 0;
+        if (result)
+            exports.fileResults.success.push(fileRelative);
+        else
+            exports.fileResults.fail.push(fileRelative);
+        resolve(result);
     });
     child.on('error', (err) => {
         console.log(`Failed to start test: ${filePath}`, err);
+        exports.fileResults.fail.push(fileRelative);
         resolve(false);
     });
 });

package/lib/services/run-tests.d.ts

@@ -1,3 +1,7 @@
 import { Configs } from '../@types/poku.js';
+export declare const results: {
+    success: number;
+    fail: number;
+};
 export declare const runTests: (dir: string, configs?: Configs) => Promise<boolean>;
 export declare const runTestsParallel: (dir: string, configs?: Configs) => Promise<boolean>;

package/lib/services/run-tests.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runTestsParallel = exports.runTests = void 0;
+exports.runTestsParallel = exports.runTests = exports.results = void 0;
 const node_process_1 = __importDefault(require("process"));
 const node_os_1 = require("os");
 const node_path_1 = __importDefault(require("path"));
@@ -23,9 +23,13 @@ const hr_js_1 = require("../helpers/hr.js");
 const format_js_1 = require("../helpers/format.js");
 const run_test_file_js_1 = require("./run-test-file.js");
 const logs_js_1 = require("../helpers/logs.js");
+exports.results = {
+    success: 0,
+    fail: 0,
+};
 const runTests = (dir, configs) => __awaiter(void 0, void 0, void 0, function* () {
     const cwd = node_process_1.default.cwd();
-    const testDir = node_path_1.default.join(cwd, dir);
+    const testDir = node_path_1.default.join(cwd, (0, list_files_js_1.sanitizePath)(dir));
     const currentDir = node_path_1.default.relative(cwd, testDir);
     const files = (0, list_files_js_1.listFiles)(testDir, undefined, configs);
     const totalTests = files.length;
@@ -33,7 +37,7 @@ const runTests = (dir, configs) => __awaiter(void 0, void 0, void 0, function* (
     let passed = true;
     if (showLogs) {
         (0, hr_js_1.hr)();
-        console.log(`${format_js_1.format.bold('Directory:')} ${format_js_1.format.underline(currentDir)}${node_os_1.EOL}`);
+        console.log(`${format_js_1.format.bold('Directory:')} ${format_js_1.format.underline(`./${currentDir}`)}${node_os_1.EOL}`);
     }
     for (let i = 0; i < files.length; i++) {
         const filePath = files[i];
@@ -43,13 +47,16 @@ const runTests = (dir, configs) => __awaiter(void 0, void 0, void 0, function* (
         const counter = format_js_1.format.counter(testNumber, totalTests);
         const command = `${(0, runner_js_1.runner)(fileRelative, configs).join(' ')} ${fileRelative}`;
         const nextLine = i + 1 !== files.length ? node_os_1.EOL : '';
-        const log = `${counter}/${totalTests} ${command}${nextLine}`;
+        const log = `${counter}/${totalTests} ${command}`;
         if (testPassed) {
+            ++exports.results.success;
             showLogs &&
-                console.log(`${indentation_js_1.indentation.test}${format_js_1.format.success('✔')} ${log}`);
+                console.log(`${indentation_js_1.indentation.test}${format_js_1.format.success('✔')} ${log}`, nextLine);
         }
         else {
-            showLogs && console.log(`${indentation_js_1.indentation.test}${format_js_1.format.fail('✖')} ${log}`);
+            ++exports.results.fail;
+            showLogs &&
+                console.log(`${indentation_js_1.indentation.test}${format_js_1.format.fail('✘')} ${log}`, nextLine);
             passed = false;
         }
     }
@@ -60,23 +67,16 @@ const runTestsParallel = (dir, configs) => __awaiter(void 0, void 0, void 0, fun
     const cwd = node_process_1.default.cwd();
     const testDir = node_path_1.default.join(cwd, dir);
     const files = (0, list_files_js_1.listFiles)(testDir, undefined, configs);
-    const showLogs = !(0, logs_js_1.isQuiet)(configs);
     const promises = files.map((filePath) => __awaiter(void 0, void 0, void 0, function* () {
-        const fileRelative = node_path_1.default.relative(cwd, filePath);
         const testPassed = yield (0, run_test_file_js_1.runTestFile)(filePath, configs);
-        const command = `${(0, runner_js_1.runner)(fileRelative).join(' ')} ${fileRelative}`;
-        if (testPassed) {
-            showLogs &&
-                console.log(`${indentation_js_1.indentation.test}${format_js_1.format.success('✔')} ${command}`);
-        }
-        else {
-            showLogs &&
-                console.log(`${indentation_js_1.indentation.test}${format_js_1.format.fail('✖')} ${command}`);
+        if (!testPassed) {
+            ++exports.results.fail;
             return false;
         }
+        ++exports.results.success;
         return true;
     }));
-    const results = yield Promise.all(promises);
-    return results.every((result) => result);
+    const concurrency = yield Promise.all(promises);
+    return concurrency.every((result) => result);
 });
 exports.runTestsParallel = runTestsParallel;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "poku",
-  "version": "1.4.0",
-  "description": "🐷 Poku is your test runner pet for Node.js, Bun and Deno, combining flexibility, parallel and sequential runs, human-friendly assertion errors and high isolation level",
+  "version": "1.5.1",
+  "description": "🐷 Poku brings human-friendly testing and assertion to Node.js, Bun & Deno at the same time.",
   "main": "./lib/index.js",
   "scripts": {
     "test": "npx tsx --tsconfig ./tsconfig.test.json ./test/run.test.ts",
@@ -9,14 +9,16 @@
     "test:node": "FILTER='node-' npm run test:ci",
     "test:deno": "FILTER='deno-' npm run test:ci",
     "test:bun": "FILTER='bun-' npm run test:ci",
-    "update": "npx npu;",
     "prebuild": "rm -rf ./lib ./ci",
     "build": "npx tsc; npx tsc -p tsconfig.test.json",
     "postbuild": "npx tsx ./tools/compatibility/node.ts; chmod +x lib/bin/index.js; npm audit",
     "eslint:checker": "npx eslint . --ext .js,.ts",
     "eslint:fix": "npx eslint . --fix --config ./.eslintrc.json",
+    "lint:checker": "npm run eslint:checker; npm run prettier:checker",
+    "lint:fix": "npm run eslint:fix; npm run prettier:fix",
     "prettier:checker": "npx prettier --check .",
-    "prettier:fix": "npx prettier --write .github/workflows/*.yml ."
+    "prettier:fix": "npx prettier --write .github/workflows/*.yml .",
+    "update": "npx npu; npm i; npm run lint:fix; npm audit"
   },
   "license": "MIT",
   "repository": {
@@ -78,17 +80,18 @@
   "engines": {
     "node": ">=6.0.0",
     "bun": ">=0.5.3",
-    "deno": ">=1.17.0"
+    "deno": ">=1.17.0",
+    "typescript": ">=5.0.2"
   },
   "files": [
     "lib"
   ],
   "type": "commonjs",
   "devDependencies": {
-    "@types/node": "^20.11.19",
-    "@typescript-eslint/eslint-plugin": "^7.0.1",
-    "@typescript-eslint/parser": "^7.0.1",
-    "eslint": "^8.56.0",
+    "@types/node": "^20.11.21",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",