poku 1.7.0 → 1.8.1

package/README.md

@@ -167,6 +167,25 @@ deno run npm:poku
 
 ---
 
+## Available Methods
+
+### Essentials
+
+- `poku` (_test runner_)
+- `assert` and `assertPromise` (_test assertion_)
+
+### Helpers
+
+- `beforeEach` and `afterEach`
+- `test`
+- `describe` and `log`
+- `listFiles`
+- `exit`
+
+[**See the complete documentation**](https://poku.io/docs).
+
+---
+
 ## Overview
 
 ### `poku`

package/lib/configs/each.d.ts

@@ -5,6 +5,8 @@ export type Control = {
 };
 export type EachConfigs = {
     status: boolean;
+    assert?: boolean;
+    test?: boolean;
     cb?: () => unknown | Promise<unknown>;
 };
 export declare const each: {

package/lib/configs/each.js

@@ -5,9 +5,13 @@ exports.each = {
     before: {
         status: true,
         cb: undefined,
+        assert: true,
+        test: true,
     },
     after: {
         status: true,
         cb: undefined,
+        assert: true,
+        test: true,
     },
 };

package/lib/helpers/parseAsssetion.js

@@ -26,7 +26,7 @@ const parseAssertion = (cb, options) => __awaiter(void 0, void 0, void 0, functi
     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 {
-        if (typeof each_js_1.each.before.cb === 'function') {
+        if (typeof each_js_1.each.before.cb === 'function' && each_js_1.each.before.assert) {
             const beforeResult = each_js_1.each.before.cb();
             if (beforeResult instanceof Promise)
                 yield beforeResult;
@@ -34,7 +34,7 @@ const parseAssertion = (cb, options) => __awaiter(void 0, void 0, void 0, functi
         const cbResult = cb();
         if (cbResult instanceof Promise)
             yield cbResult;
-        if (typeof each_js_1.each.after.cb === 'function') {
+        if (typeof each_js_1.each.after.cb === 'function' && each_js_1.each.after.assert) {
             const afterResult = each_js_1.each.after.cb();
             if (afterResult instanceof Promise)
                 yield afterResult;

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export { describe, log } from './modules/describe.js';
 export { assertPromise } from './modules/assert-promise.js';
 export { beforeEach, afterEach } from './modules/each.js';
 export { publicListFiles as listFiles } from './modules/list-files.js';
+export { test } from './modules/test.js';
 export type { Code } from './@types/code.ts';
 export type { Configs } from './@types/poku.ts';
 export type { Configs as ListFilesConfigs } from './@types/list-files.ts';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.listFiles = exports.afterEach = exports.beforeEach = exports.assertPromise = exports.log = exports.describe = exports.assert = exports.exit = exports.poku = void 0;
+exports.test = exports.listFiles = exports.afterEach = exports.beforeEach = exports.assertPromise = exports.log = exports.describe = exports.assert = exports.exit = exports.poku = void 0;
 var poku_js_1 = require("./modules/poku.js");
 Object.defineProperty(exports, "poku", { enumerable: true, get: function () { return poku_js_1.poku; } });
 var exit_js_1 = require("./modules/exit.js");
@@ -17,3 +17,5 @@ Object.defineProperty(exports, "beforeEach", { enumerable: true, get: function (
 Object.defineProperty(exports, "afterEach", { enumerable: true, get: function () { return each_js_1.afterEach; } });
 var list_files_js_1 = require("./modules/list-files.js");
 Object.defineProperty(exports, "listFiles", { enumerable: true, get: function () { return list_files_js_1.publicListFiles; } });
+var test_js_1 = require("./modules/test.js");
+Object.defineProperty(exports, "test", { enumerable: true, get: function () { return test_js_1.test; } });

package/lib/modules/each.d.ts

@@ -1,6 +1,8 @@
 import { Control } from '../configs/each.js';
 type EachOptions = {
     immediate?: boolean;
+    test?: boolean;
+    assert?: boolean;
 };
 /**
  * - ✅ Handling **global** and **external** services (_preparing a database, for example_)
@@ -45,5 +47,5 @@ export declare const beforeEach: (callback: () => unknown, options?: EachOptions
  * after.reset();
  * ```
  */
-export declare const afterEach: (callback: () => unknown) => Control;
+export declare const afterEach: (callback: () => unknown, options: Omit<EachOptions, 'immediate'>) => Control;
 export {};

package/lib/modules/each.js

@@ -24,6 +24,9 @@ const each_js_1 = require("../configs/each.js");
  * ```
  */
 const beforeEach = (callback, options) => {
+    each_js_1.each.before.test = typeof (options === null || options === void 0 ? void 0 : options.test) === 'boolean' ? options.test : true;
+    each_js_1.each.before.assert =
+        typeof (options === null || options === void 0 ? void 0 : options.assert) === 'boolean' ? options.assert : true;
     (options === null || options === void 0 ? void 0 : options.immediate) && callback();
     each_js_1.each.before.cb = () => {
         if (each_js_1.each.before.status)
@@ -62,7 +65,10 @@ exports.beforeEach = beforeEach;
  * after.reset();
  * ```
  */
-const afterEach = (callback) => {
+const afterEach = (callback, options) => {
+    each_js_1.each.after.test = typeof (options === null || options === void 0 ? void 0 : options.test) === 'boolean' ? options.test : true;
+    each_js_1.each.after.assert =
+        typeof (options === null || options === void 0 ? void 0 : options.assert) === 'boolean' ? options.assert : true;
     each_js_1.each.after.cb = () => {
         if (each_js_1.each.after.status)
             callback();

package/lib/modules/list-files.js

@@ -12,7 +12,7 @@ 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
+        .replace(/[<>|^?*]+/g, ''); // removing unusual path characters
     // Preventing absolute path access
     return ensureTarget ? sanitizedPath.replace(/^[/\\]/, './') : sanitizedPath;
 };

package/lib/modules/test.d.ts

@@ -0,0 +1,2 @@
+export declare function test(cb: () => Promise<unknown>): Promise<void>;
+export declare function test(cb: () => unknown): void;

package/lib/modules/test.js

@@ -0,0 +1,31 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.test = void 0;
+const each_js_1 = require("../configs/each.js");
+function test(cb) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (typeof each_js_1.each.before.cb === 'function' && each_js_1.each.before.test) {
+            const beforeResult = each_js_1.each.before.cb();
+            if (beforeResult instanceof Promise)
+                yield beforeResult;
+        }
+        const resultCb = cb();
+        if (resultCb instanceof Promise)
+            yield resultCb;
+        if (typeof each_js_1.each.after.cb === 'function' && each_js_1.each.after.test) {
+            const afterResult = each_js_1.each.after.cb();
+            if (afterResult instanceof Promise)
+                yield afterResult;
+        }
+    });
+}
+exports.test = test;

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

@@ -29,8 +29,13 @@ exports.fileResults = {
 };
 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();
-    const runtimeArguments = runtimeOptions.length > 1 ? [...runtimeOptions, filePath] : [filePath];
+    const originalRuntime = runtimeOptions.shift();
+    let runtime = originalRuntime;
+    let runtimeArguments = runtimeOptions.length > 1 ? [...runtimeOptions, filePath] : [filePath];
+    if (node_process_1.default.platform === 'win32' && originalRuntime === 'tsx') {
+        runtime = 'npx.cmd';
+        runtimeArguments = ['tsx', ...runtimeArguments];
+    }
     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);

package/package.json

@@ -1,29 +1,29 @@
 {
   "name": "poku",
-  "version": "1.7.0",
+  "version": "1.8.1",
   "description": "🐷 Poku makes testing easy for Node.js, Bun & Deno at the same time.",
   "main": "./lib/index.js",
   "scripts": {
-    "test": "npx tsx --tsconfig ./tsconfig.test.json ./test/run.test.ts",
+    "test": "tsx --tsconfig ./tsconfig.test.json ./test/run.test.ts",
     "pretest:c8": "npm run build",
     "test:c8": "docker compose -f test/docker/docker-compose.c8.yml up",
-    "test:ci:c8": "npx c8 --include 'src/**' --exclude 'src/@types/**' --reporter=text --reporter=lcov npx tsx test/run.test.ts",
+    "test:ci:c8": "c8 --include 'src/**' --exclude 'src/@types/**' --reporter=text --reporter=lcov tsx test/run.test.ts",
     "test:ci": "tsx ./test/ci.test.ts",
     "test:node": "FILTER='node-' npm run test:ci",
     "test:deno": "FILTER='deno-' npm run test:ci",
     "test:bun": "FILTER='bun-' npm run test:ci",
-    "prebuild": "rm -rf ./lib ./ci",
     "predocker:deno": "docker compose -f ./test/docker/playground/deno/docker-compose.yml down",
     "docker:deno": "docker compose -f ./test/docker/playground/deno/docker-compose.yml up --build",
-    "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 .",
-    "update": "npx npu; npm i; npm run lint:fix; npm audit"
+    "prebuild": "rm -rf ./lib ./ci",
+    "build": "tsc && tsc -p tsconfig.test.json",
+    "postbuild": "tsx ./tools/compatibility/node.ts && chmod +x lib/bin/index.js && npm audit",
+    "eslint:checker": "eslint . --ext .js,.ts",
+    "eslint:fix": "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": "prettier --check .",
+    "prettier:fix": "prettier --write .github/workflows/*.yml .",
+    "update": "npu && npm i && npm run lint:fix && npm audit"
   },
   "license": "MIT",
   "repository": {