poku 1.9.3 → 1.10.0

package/README.md

@@ -111,8 +111,8 @@ bun add -d poku
 </td>
 <td width="400">
 
-```ts
-import { poku } from 'npm:poku';
+```bash
+deno add npm:poku
 ```
 
 </td>
@@ -124,7 +124,7 @@ import { poku } from 'npm:poku';
 <table>
 <tr>
 <td>
-<em><code>test/file.test.js</code></em>
+<em><code>test/file.test.mjs</code></em>
 </td>
 </tr>
 <tr>
@@ -140,7 +140,8 @@ assert(true, 'Poku will describe it 🐷');
 </tr>
 </table>
 
-> Note that these examples use [**ESM**](https://poku.io/docs/examples/cjs-esm), but you can use [**CJS**](https://poku.io/docs/examples/cjs-esm) as well.
+- Change from `.mjs` to `.js` by defining `"type": "module"` in your _package.json_.
+- Note that these examples use [**ESM**](https://poku.io/docs/examples/cjs-esm), but you can use [**CJS**](https://poku.io/docs/examples/cjs-esm) as well.
 
 ### Run it 🚀
 

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

@@ -50,6 +50,12 @@ export type Configs = {
      * @default 'node'
      */
     platform?: 'node' | 'bun' | 'deno';
+    /**
+     * Stops the tests at the first failure.
+     *
+     * @default false
+     */
+    failFast?: boolean;
     /**
      * You can use this option to run a **callback** or a **file** before each test file on your suite.
      *

package/lib/bin/index.js

@@ -2,12 +2,12 @@
 "use strict";
 var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
+/* c8 ignore start */
 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");
-/* c8 ignore start */
 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(',')) || [];
@@ -17,9 +17,9 @@ 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 debug = (0, get_arg_js_1.hasArg)('debug');
+const failFast = (0, get_arg_js_1.hasArg)('fail-fast');
 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.`);
-/* c8 ignore end */
 (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,
@@ -27,4 +27,6 @@ if ((0, get_arg_js_1.hasArg)('log-success'))
     parallel,
     quiet,
     debug,
+    failFast,
 });
+/* c8 ignore stop */

package/lib/helpers/find-file.js

@@ -26,4 +26,4 @@ const findFile = (error) => {
     return file;
 };
 exports.findFile = findFile;
-/* c8 ignore end */
+/* c8 ignore stop */

package/lib/helpers/pad.js

@@ -15,4 +15,4 @@ const padStart = (str, targetLength, padString) => {
     return fullPadString + str;
 };
 exports.padStart = padStart;
-/* c8 ignore end */
+/* c8 ignore stop */

package/lib/modules/assert-promise.js

@@ -178,12 +178,11 @@ function doesNotReject(block, errorOrMessage, message) {
         });
     });
 }
+/* c8 ignore start */
 const match = (value, regExp, message) => __awaiter(void 0, void 0, void 0, function* () {
-    /* c8 ignore start */
     if (typeof get_runtime_js_1.nodeVersion === 'number' && get_runtime_js_1.nodeVersion < 12) {
         throw new Error('match is available from Node.js 12 or higher');
     }
-    /* c8 ignore stop */
     yield (0, parseAsssetion_js_1.parseAssertion)(() => nodeAssert === null || nodeAssert === void 0 ? void 0 : nodeAssert.match(value, regExp), {
         message,
         actual: 'Value',
@@ -191,12 +190,12 @@ const match = (value, regExp, message) => __awaiter(void 0, void 0, void 0, func
         defaultMessage: 'Value should match regExp',
     });
 });
+/* c8 ignore stop */
+/* c8 ignore start */
 const doesNotMatch = (value, regExp, message) => __awaiter(void 0, void 0, void 0, function* () {
-    /* c8 ignore start */
     if (typeof get_runtime_js_1.nodeVersion === 'number' && get_runtime_js_1.nodeVersion < 12) {
         throw new Error('doesNotMatch is available from Node.js 12 or higher');
     }
-    /* c8 ignore stop */
     yield (0, parseAsssetion_js_1.parseAssertion)(() => nodeAssert.doesNotMatch(value, regExp), {
         message,
         actual: 'Value',
@@ -204,6 +203,7 @@ const doesNotMatch = (value, regExp, message) => __awaiter(void 0, void 0, void
         defaultMessage: 'Value should not match regExp',
     });
 });
+/* c8 ignore stop */
 exports.assertPromise = Object.assign((value, message) => ok(value, message), {
     ok,
     equal,

package/lib/modules/assert.js

@@ -168,12 +168,11 @@ function doesNotReject(block, errorOrMessage, message) {
         });
     });
 }
+/* c8 ignore start */
 const match = (value, regExp, message) => {
-    /* c8 ignore start */
     if (typeof get_runtime_js_1.nodeVersion === 'number' && get_runtime_js_1.nodeVersion < 12) {
         throw new Error('match is available from Node.js 12 or higher');
     }
-    /* c8 ignore stop */
     (0, parseAsssetion_js_1.parseAssertion)(() => nodeAssert === null || nodeAssert === void 0 ? void 0 : nodeAssert.match(value, regExp), {
         message,
         actual: 'Value',
@@ -181,12 +180,12 @@ const match = (value, regExp, message) => {
         defaultMessage: 'Value should match regExp',
     });
 };
+/* c8 ignore stop */
+/* c8 ignore start */
 const doesNotMatch = (value, regExp, message) => {
-    /* c8 ignore start */
     if (typeof get_runtime_js_1.nodeVersion === 'number' && get_runtime_js_1.nodeVersion < 12) {
         throw new Error('doesNotMatch is available from Node.js 12 or higher');
     }
-    /* c8 ignore stop */
     (0, parseAsssetion_js_1.parseAssertion)(() => nodeAssert.doesNotMatch(value, regExp), {
         message,
         actual: 'Value',
@@ -194,6 +193,7 @@ const doesNotMatch = (value, regExp, message) => {
         defaultMessage: 'Value should not match regExp',
     });
 };
+/* c8 ignore stop */
 exports.assert = Object.assign((value, message) => ok(value, message), {
     ok,
     equal,

package/lib/modules/create-service.js

@@ -27,15 +27,18 @@ const killWindowsProcess = (PID) => (0, node_child_process_1.spawn)('taskkill',
 node_process_1.default.once('SIGINT', () => {
     secureEnds();
 });
-/* c8 ignore end */
+/* c8 ignore stop */
 const backgroundProcess = (runtime, args, file, options) => new Promise((resolve, reject) => {
     let isResolved = false;
     const service = (0, node_child_process_1.spawn)(runtime, args, {
         stdio: ['inherit', 'pipe', 'pipe'],
-        shell: false,
+        /* c8 ignore next */
+        shell: runner_js_1.isWindows,
         cwd: (options === null || options === void 0 ? void 0 : options.cwd) ? (0, list_files_js_1.sanitizePath)(node_path_1.default.normalize(options.cwd)) : undefined,
         env: node_process_1.default.env,
+        /* c8 ignore next */
         detached: !runner_js_1.isWindows,
+        /* c8 ignore next */
         windowsHide: runner_js_1.isWindows,
         timeout: options === null || options === void 0 ? void 0 : options.timeout,
     });
@@ -56,7 +59,7 @@ const backgroundProcess = (runtime, args, file, options) => new Promise((resolve
         return;
     };
     runningProcesses[PID] = end;
-    /* c8 ignore end */
+    /* c8 ignore stop */
     service.stdout.on('data', (data) => {
         if (!isResolved && typeof (options === null || options === void 0 ? void 0 : options.startAfter) !== 'number') {
             const stringData = JSON.stringify(String(data));
@@ -142,7 +145,7 @@ const startScript = (script, options) => __awaiter(void 0, void 0, void 0, funct
     /* c8 ignore start */
     if (['bun', 'deno'].includes(runner))
         throw new Error(`${format_js_1.format.bold('startScript')} currently doesn't works for Bun and Deno.${node_os_1.EOL}See: https://github.com/wellwelwel/poku/issues/143`);
-    /* c8 ignore end */
+    /* c8 ignore stop */
     return yield backgroundProcess(runtime, runtimeArgs, script, Object.assign(Object.assign({}, options), { isScript: true, runner }));
 });
 exports.startScript = startScript;

package/lib/modules/exit.js

@@ -1,4 +1,5 @@
 "use strict";
+/* c8 ignore start */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -12,15 +13,14 @@ 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) => {
-            isPoku &&
+            if (isPoku) {
+                (0, hr_js_1.hr)();
                 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)();
+                (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)))}`);
         });
-    isPoku && !quiet && (0, hr_js_1.hr)();
-    if (code !== 0)
-        node_process_1.default.exit(1);
-    node_process_1.default.exit(0);
+    node_process_1.default.exit(code === 0 ? 0 : 1);
 };
 exports.exit = exit;
 node_process_1.default.on('unhandledRejection', (reason) => {
@@ -31,3 +31,4 @@ node_process_1.default.on('uncaughtException', (err) => {
     console.log('uncaughtException', err);
     node_process_1.default.exit(1);
 });
+/* c8 ignore stop */

package/lib/modules/poku.js

@@ -29,33 +29,47 @@ function poku(targetPaths, configs) {
         const prepareDirs = (0, force_array_js_1.forceArray)(targetPaths);
         const dirs = prepareDirs.length > 0 ? prepareDirs : ['./'];
         const showLogs = !(0, logs_js_1.isQuiet)(configs);
-        if (configs === null || configs === void 0 ? void 0 : configs.parallel) {
-            if (showLogs) {
-                (0, hr_js_1.hr)();
-                console.log(`${format_js_1.format.bold('Running the Test Suite in Parallel')}${node_os_1.EOL}`);
+        // Sequential
+        if (!(configs === null || configs === void 0 ? void 0 : configs.parallel)) {
+            for (const dir of dirs) {
+                const result = yield (0, run_tests_js_1.runTests)(dir, configs);
+                if (!result) {
+                    code = 1;
+                    if (configs === null || configs === void 0 ? void 0 : configs.failFast)
+                        break;
+                }
             }
-            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);
             return;
         }
-        for (const dir of dirs) {
-            const result = yield (0, run_tests_js_1.runTests)(dir, configs);
-            if (!result)
+        // Parallel
+        if (showLogs) {
+            (0, hr_js_1.hr)();
+            console.log(`${format_js_1.format.bold('Running the Test Suite in Parallel')}${node_os_1.EOL}`);
+        }
+        try {
+            const promises = dirs.map((dir) => __awaiter(this, void 0, void 0, function* () {
+                const result = yield (0, run_tests_js_1.runTestsParallel)(dir, configs);
+                if (!result && (configs === null || configs === void 0 ? void 0 : configs.failFast))
+                    throw '';
+                return result;
+            }));
+            const concurrency = yield Promise.all(promises);
+            if (concurrency.some((result) => !result))
                 code = 1;
         }
+        catch (_a) { }
+        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.js

@@ -23,10 +23,13 @@ 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");
 const each_js_1 = require("./each.js");
+/* c8 ignore stop */
+/* c8 ignore start */
 exports.fileResults = {
     success: [],
     fail: [],
 };
+/* c8 ignore stop */
 const runTestFile = (filePath, configs) => new Promise((resolve) => __awaiter(void 0, void 0, void 0, function* () {
     const runtimeOptions = (0, runner_js_1.runner)(filePath, configs);
     const runtime = runtimeOptions.shift();
@@ -75,7 +78,8 @@ const runTestFile = (filePath, configs) => new Promise((resolve) => __awaiter(vo
     // Export spawn helper is not an option
     const child = (0, node_child_process_1.spawn)(runtime, runtimeArguments, {
         stdio: ['inherit', 'pipe', 'pipe'],
-        shell: false,
+        /* c8 ignore next */
+        shell: runner_js_1.isWindows,
         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);

package/lib/services/run-tests.js

@@ -59,6 +59,11 @@ const runTests = (dir, configs) => __awaiter(void 0, void 0, void 0, function* (
             showLogs &&
                 console.log(`${indentation_js_1.indentation.test}${format_js_1.format.fail('✘')} ${log}`, nextLine);
             passed = false;
+            if (configs === null || configs === void 0 ? void 0 : configs.failFast) {
+                (0, hr_js_1.hr)();
+                console.log(`  ${format_js_1.format.fail('ℹ')} ${format_js_1.format.bold('fail-fast')} is enabled`);
+                break;
+            }
         }
     }
     return passed;
@@ -68,16 +73,27 @@ 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.isFile)(dir) ? [dir] : (0, list_files_js_1.listFiles)(testDir, undefined, configs);
-    const promises = files.map((filePath) => __awaiter(void 0, void 0, void 0, function* () {
-        const testPassed = yield (0, run_test_file_js_1.runTestFile)(filePath, configs);
-        if (!testPassed) {
-            ++exports.results.fail;
-            return false;
-        }
-        ++exports.results.success;
-        return true;
-    }));
-    const concurrency = yield Promise.all(promises);
-    return concurrency.every((result) => result);
+    try {
+        const promises = files.map((filePath) => __awaiter(void 0, void 0, void 0, function* () {
+            if ((configs === null || configs === void 0 ? void 0 : configs.failFast) && exports.results.fail > 0)
+                return;
+            const testPassed = yield (0, run_test_file_js_1.runTestFile)(filePath, configs);
+            if (!testPassed) {
+                ++exports.results.fail;
+                if (configs === null || configs === void 0 ? void 0 : configs.failFast)
+                    throw `  ${format_js_1.format.fail('ℹ')} ${format_js_1.format.bold('fail-fast')} is enabled`;
+                return false;
+            }
+            ++exports.results.success;
+            return true;
+        }));
+        const concurrency = yield Promise.all(promises);
+        return concurrency.every((result) => result);
+    }
+    catch (error) {
+        (0, hr_js_1.hr)();
+        console.log(error);
+        return false;
+    }
 });
 exports.runTestsParallel = runTestsParallel;

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "poku",
-  "version": "1.9.3",
+  "version": "1.10.0",
   "description": "🐷 Poku makes testing easy for Node.js, Bun & Deno at the same time.",
   "main": "./lib/index.js",
   "scripts": {
-    "test": "npx poku --parallel --debug test/unit,test/integration,test/e2e",
-    "pretest:c8": "npm run build",
+    "test": "tsx src/bin/index.ts --parallel --debug --include=\"test/unit,test/integration,test/e2e\"",
     "test:c8": "c8 npm run test",
     "test:ci": "tsx ./test/ci.test.ts",
     "test:node": "FILTER='node-' npm run test:ci",
@@ -23,7 +22,7 @@
     "lint:fix": "npm run eslint:fix && npm run prettier:fix",
     "prettier:checker": "prettier --check .",
     "prettier:fix": "prettier --write .github/workflows/*.yml .",
-    "update": "npu && npm i && npm run lint:fix && npm audit"
+    "update": "npu --minor && npm i && npm run lint:fix && npm audit"
   },
   "license": "MIT",
   "repository": {
@@ -103,9 +102,9 @@
   ],
   "type": "commonjs",
   "devDependencies": {
-    "@types/node": "^20.11.27",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
-    "@typescript-eslint/parser": "^7.2.0",
+    "@types/node": "^20.12.11",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
     "c8": "^9.1.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
@@ -116,6 +115,6 @@
     "prettier": "^3.2.5",
     "shx": "^0.3.4",
     "tsx": "4.2.1",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.5"
   }
 }