poku 4.2.1 → 4.2.2-canary.24d7783d

package/README.md

@@ -220,6 +220,10 @@ deno run npm:poku
     <td><a href="https://poku.io/docs/documentation/poku/config-files">config</a></td>
     <td>⚙️ Customize your Poku options in a config file.</td>
   </tr>
+  <tr>
+    <td><a href="https://poku.io/docs/documentation/helpers/coverage">coverage</a></td>
+    <td>☔️ Enable coverage collection using a coverage plugin.</td>
+  </tr>
 </table>
 
 > _and much more_ 👇🏻

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

@@ -95,4 +95,12 @@ export type InspectCLIResult = {
     PID: number;
     kill: () => Promise<void>;
 };
+export type ScopeHook = {
+    createHolder: () => {
+        scope: unknown;
+    };
+    runScoped: (holder: {
+        scope: unknown;
+    }, fn: (params?: Record<string, unknown>) => Promise<unknown> | unknown) => Promise<void>;
+};
 export {};

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

@@ -145,3 +145,4 @@ export type ConfigJSONFile = {
     testSkipPattern?: string;
 } & Omit<Configs, 'beforeEach' | 'afterEach' | 'noExit' | 'filter' | 'exclude' | 'plugins' | 'testNamePattern' | 'testSkipPattern'> & CliConfigs;
 export type ConfigFile = Omit<Configs, 'noExit'> & CliConfigs;
+export type TestCallback = (params?: Record<string, unknown>) => unknown | Promise<unknown>;

package/lib/bin/help.js

@@ -13,6 +13,8 @@ const bullet = d('●');
 const summary = [
     ['--concurrency', 'Limit the number of tests running concurrently.'],
     ['--config, -c', 'Specify a configuration file.'],
+    ['--coverage', 'Enable coverage collection using a coverage plugin.'],
+    ['--coverageConfig', 'Path to a coverage configuration file.'],
     ['--debug, -d', 'Show detailed logs.'],
     ['--denoAllow', 'Allow permissions for Deno.'],
     ['--denoDeny', 'Deny permissions for Deno.'],

package/lib/bin/index.js

@@ -111,6 +111,44 @@ const write_js_1 = require("../services/write.js");
         afterEach: 'afterEach' in configsFromFile ? configsFromFile.afterEach : undefined,
         plugins: 'plugins' in configsFromFile ? configsFromFile.plugins : undefined,
     };
+    if ((0, get_arg_js_1.hasArg)('coverage')) {
+        const customPkg = (0, get_arg_js_1.getArg)('coverage');
+        if (customPkg && /^[./]/.test(customPkg)) {
+            (0, write_js_1.log)('Coverage plugin must be an npm package name. Local paths are not supported for security concerns.');
+            (0, node_process_1.exit)(1);
+        }
+        const coveragePackages = customPkg
+            ? [customPkg]
+            : [
+                '@pokujs/c8',
+                '@pokujs/monocart',
+                '@pokujs/istanbul',
+                '@pokujs/one-double-zero',
+            ];
+        const existingPlugins = poku_js_1.GLOBAL.configs.plugins ?? [];
+        const alreadyHasCoverage = existingPlugins.some((plugin) => plugin.name !== undefined && coveragePackages.includes(plugin.name));
+        if (!alreadyHasCoverage) {
+            let loaded = false;
+            for (const pkg of coveragePackages) {
+                try {
+                    const { coverage } = await import(pkg);
+                    poku_js_1.GLOBAL.configs.plugins = existingPlugins;
+                    poku_js_1.GLOBAL.configs.plugins.push(coverage());
+                    loaded = true;
+                    break;
+                }
+                catch { }
+            }
+            if (!loaded) {
+                (0, write_js_1.hr)();
+                (0, write_js_1.log)(customPkg
+                    ? `Coverage plugin not found: ${(0, format_js_1.format)(customPkg).bold()}`
+                    : `To use ${(0, format_js_1.format)('--coverage').bold()}, install a coverage plugin, for example:\n\n${coveragePackages.map((pkg) => `  ${(0, format_js_1.format)('npm i -D').dim()} ${(0, format_js_1.format)(pkg).underline()}`).join('\n')}`);
+                (0, write_js_1.hr)();
+                (0, node_process_1.exit)(1);
+            }
+        }
+    }
     if (typeof testNamePattern === 'string')
         node_process_1.env.POKU_TEST_NAME_PATTERN = testNamePattern;
     if (typeof testSkipPattern === 'string')

package/lib/configs/poku.js

@@ -21,7 +21,7 @@ exports.results = {
     skipped: 0,
     todo: 0,
 };
-exports.VERSION = '4.2.1';
+exports.VERSION = '4.2.2-canary.24d7783d';
 exports.deepOptions = [];
 exports.GLOBAL = {
     cwd: (0, node_process_1.cwd)(),

package/lib/modules/helpers/it/core.d.ts

@@ -1,11 +1,12 @@
+import type { TestCallback } from '../../../@types/poku.js';
 import { onlyIt, skip, todo } from '../modifiers.js';
 export declare const getTitle: (input: unknown) => string | undefined;
-export declare const getCallback: (input: unknown) => (() => unknown) | (() => Promise<unknown>) | undefined;
-export declare const itBase: (titleOrCb: string | (() => unknown | Promise<unknown>), callback?: () => unknown | Promise<unknown>) => Promise<void>;
-declare function itCore(title: string, cb: () => Promise<unknown>): Promise<void>;
-declare function itCore(title: string, cb: () => unknown): void;
-declare function itCore(cb: () => Promise<unknown>): Promise<void>;
-declare function itCore(cb: () => unknown): void;
+export declare const getCallback: (input: unknown) => TestCallback | undefined;
+export declare const itBase: (titleOrCb: string | TestCallback, callback?: TestCallback) => Promise<void>;
+declare function itCore(title: string, cb: (params?: Record<string, unknown>) => Promise<unknown>): Promise<void>;
+declare function itCore(title: string, cb: (params?: Record<string, unknown>) => unknown): void;
+declare function itCore(cb: (params?: Record<string, unknown>) => Promise<unknown>): Promise<void>;
+declare function itCore(cb: (params?: Record<string, unknown>) => unknown): void;
 export declare const it: typeof itCore & {
     todo: typeof todo;
     skip: typeof skip;

package/lib/modules/helpers/it/core.js

@@ -11,12 +11,12 @@ const indentation_js_1 = require("../../../configs/indentation.js");
 const poku_js_1 = require("../../../configs/poku.js");
 const get_arg_js_1 = require("../../../parsers/get-arg.js");
 const modifiers_js_1 = require("../modifiers.js");
+const SCOPE_HOOKS_KEY = Symbol.for('@pokujs/poku.test-scope-hooks');
 const getTitle = (input) => typeof input === 'string' ? input : undefined;
 exports.getTitle = getTitle;
-const getCallback = (input) => typeof input === 'function'
-    ? input
-    : undefined;
+const getCallback = (input) => typeof input === 'function' ? input : undefined;
 exports.getCallback = getCallback;
+const getScopeHook = () => globalThis[SCOPE_HOOKS_KEY];
 const itBase = async (titleOrCb, callback) => {
     try {
         const title = (0, exports.getTitle)(titleOrCb);
@@ -49,9 +49,16 @@ const itBase = async (titleOrCb, callback) => {
             poku_js_1.errorHoist.failed = false;
         start = node_process_1.default.hrtime();
         try {
-            const resultCb = cb();
-            if (resultCb instanceof Promise)
-                await resultCb;
+            const hooks = getScopeHook();
+            if (hooks) {
+                const holder = hooks.createHolder();
+                await hooks.runScoped(holder, (params) => cb(params));
+            }
+            else {
+                const resultCb = cb();
+                if (resultCb instanceof Promise)
+                    await resultCb;
+            }
         }
         catch (error) {
             node_process_1.default.exitCode = 1;

package/lib/modules/helpers/test.d.ts

@@ -1,8 +1,8 @@
 export declare const test: {
-    (title: string, cb: () => Promise<unknown>): Promise<void>;
-    (title: string, cb: () => unknown): void;
-    (cb: () => Promise<unknown>): Promise<void>;
-    (cb: () => unknown): void;
+    (title: string, cb: (params?: Record<string, unknown>) => Promise<unknown>): Promise<void>;
+    (title: string, cb: (params?: Record<string, unknown>) => unknown): void;
+    (cb: (params?: Record<string, unknown>) => Promise<unknown>): Promise<void>;
+    (cb: (params?: Record<string, unknown>) => unknown): void;
 } & {
     todo: typeof import("./modifiers.js").todo;
     skip: typeof import("./modifiers.js").skip;

package/lib/modules/plugins.d.ts

@@ -4,7 +4,7 @@ export { createReporter } from '../builders/reporter.js';
 export { findFileFromStack } from '../parsers/find-file-from-stack.js';
 export { onSigint } from './essentials/poku.js';
 export { reporter as reporterRegistry } from '../services/reporter.js';
-export type { ReporterPlugin, ReporterEvents, PokuPlugin, PluginContext, InspectCLIResult, } from '../@types/plugin.js';
+export type { ReporterPlugin, ReporterEvents, PokuPlugin, PluginContext, InspectCLIResult, ScopeHook, } from '../@types/plugin.js';
 /** 🐷 Auxiliary function to define a Poku plugin */
 export declare const definePlugin: (plugin: PokuPlugin) => PokuPlugin;
 /** 🐽 Auxiliary function to inspect a Poku CLI execution */

package/lib/services/enforce.js

@@ -31,6 +31,8 @@ const checkFlags = () => {
     const allowedFlags = new Set([
         '--concurrency',
         '--config',
+        '--coverage',
+        '--coverageConfig',
         '--debug',
         '--denoAllow',
         '--denoDeny',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poku",
-  "version": "4.2.1",
+  "version": "4.2.2-canary.24d7783d",
   "description": "🐷 Poku makes testing easy for Node.js, Bun, Deno, and you at the same time.",
   "main": "./lib/modules/index.js",
   "exports": {
@@ -37,7 +37,7 @@
     "test": "tsx src/bin/index.ts test/unit test/integration test/e2e",
     "test:bun": "bun src/bin/index.ts test/unit test/integration test/e2e",
     "test:deno": "deno run -A src/bin/index.ts --denoAllow=all test/unit test/integration test/e2e",
-    "test:coverage": "npm test -- -c=.c8.ts",
+    "test:coverage": "npm test -- --coverage",
     "test:docker:node": "bun test/ci.test.ts",
     "build": "bash scripts/build.sh",
     "lint": "bash scripts/lint.sh",
@@ -48,7 +48,7 @@
   "devDependencies": {
     "@biomejs/biome": "^2.4.10",
     "@ianvs/prettier-plugin-sort-imports": "^4.7.1",
-    "@pokujs/c8": "^1.0.2",
+    "@pokujs/c8": "^1.2.0",
     "@pokujs/docker": "^1.0.0",
     "@types/node": "^25.5.0",
     "concurrently": "^9.2.1",