poku 3.0.0-rc.0 → 3.0.0

package/README.md

@@ -5,7 +5,7 @@
 
 Enjoying **Poku**? Give him a star to show your support 🌟
 
-[![NPM Downloads](https://img.shields.io/npm/v/poku.svg?label=&color=70a1ff&logo=npm&logoColor=white)](https://www.npmjs.com/package/poku)
+[![NPM Version](https://img.shields.io/npm/v/poku.svg?label=&color=70a1ff&logo=npm&logoColor=white)](https://www.npmjs.com/package/poku)
 [![NPM Downloads](https://img.shields.io/npm/dm/poku.svg?label=&logo=npm&logoColor=white&color=45aaf2)](https://www.npmjs.com/package/poku)
 [![Coverage](https://img.shields.io/codecov/c/github/wellwelwel/poku?label=&logo=codecov&logoColor=white&color=98cc00)](https://github.com/wellwelwel/poku/tree/main/.nycrc)<br />
 [![GitHub Workflow Status (Linux)](https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/ci_coverage-linux.yml?event=push&label=&branch=main&logo=ubuntu&logoColor=8897a9&color=dfe4ea)](https://github.com/wellwelwel/poku/actions/workflows/ci_coverage-linux.yml?query=branch%3Amain)
@@ -14,13 +14,16 @@ Enjoying **Poku**? Give him a star to show your support 🌟
 
 ---
 
-🐷 [Website](https://poku.io/)<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>📘 [Documentation](https://poku.io/docs/category/documentation)<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>🧪 [Examples](https://poku.io/docs/category/examples)<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>🧑🏻‍🎓 [Tutorials](https://poku.io/docs/category/quick-tutorials)
+🐷 [Website](https://poku.io/)<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>📘 [Documentation](https://poku.io/docs)<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>🧪 [Examples](https://poku.io/docs/category/examples)<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>🧑🏻‍🎓 [Tutorials](https://poku.io/docs/category/quick-tutorials)
 
 </div>
 
 > [!IMPORTANT]
 >
-> [**Version 3**](https://github.com/wellwelwel/poku/issues/801) is on its way! You can already try it by installing the Release Candidate with `poku@rc` 💡
+> **Poku `v3`** is here! 🎉
+>
+> - To check out what's changed, follow the [**Issue #801**](https://github.com/wellwelwel/poku/issues/801).
+> - For `v2` documentation, see the [**previous version's documentation**](https://poku.io/docs/2.x.x) and [**README**](https://github.com/wellwelwel/poku/tree/2.x.x?tab=readme-ov-file#readme).<br />
 
 ---
 
@@ -247,7 +250,7 @@ To see the detailed documentation, please visit the [**Documentation**](https://
 - [Avoiding conflicts in environments with multiple platforms installed](https://poku.io/docs/tutorials/cross-platform#recommendations).
 - [Properly running asynchronous tests on the same file](https://poku.io/docs/examples/promises).
 - [Using **Poku** without installing on **Deno** and alternatives to **JSR**](https://github.com/wellwelwel/poku/discussions/565).
-- [Migrating from version **1.x** to version **2.x**](https://github.com/wellwelwel/poku/issues/533).
+- [Migrating from version **2.x** to version **3.x** (_rc_)](https://github.com/wellwelwel/poku/issues/801).
 
 ---
 

package/lib/@types/list-files.d.ts

@@ -12,7 +12,3 @@ export type Configs = {
      */
     exclude?: RegExp | RegExp[];
 };
-export type FileResults = {
-    success: Map<string, string>;
-    fail: Map<string, string>;
-};

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

@@ -1,10 +1,16 @@
+import type { AssertionError } from "assert";
+import type { results } from '../configs/poku.js';
 import type { Configs as ListFilesConfigs } from './list-files.js';
+import type { ProcessAssertionOptions } from './assert.js';
+import type { DescribeOptions } from './describe.js';
+type CustomString = string & NonNullable<unknown>;
 export type DenoOptions = {
     allow?: string[];
     deny?: string[];
     cjs?: boolean | string[];
 };
 export type Runtime = 'node' | 'bun' | 'deno';
+export type Reporter = 'poku' | 'focus' | 'dot' | 'verbose' | 'compact' | 'classic' | CustomString;
 export type Configs = {
     /**
      * By setting `true`, **Poku** won't exit the process and will return the exit code (`0` or `1`).
@@ -44,6 +50,10 @@ export type Configs = {
      * @default (availableParallelism() || cpus().lenght) - 1
      */
     concurrency?: number;
+    /**
+     * @default "poku"
+     */
+    reporter?: Reporter;
     /**
      * You can use this option to run a **callback** or a **file** before each test file on your suite.
      *
@@ -74,9 +84,11 @@ export type Configs = {
     afterEach?: () => unknown | Promise<unknown>;
     deno?: DenoOptions;
 } & ListFilesConfigs;
-export type FinalResults = {
-    time: string;
+export type Timespan = {
     started: Date;
+    finished: Date;
+    /** Calculation from `process.hrtime()`. */
+    duration: number;
 };
 export type States = {
     isSinglePath?: boolean;
@@ -101,4 +113,59 @@ export type ConfigJSONFile = {
     exclude?: string;
 } & Omit<Configs, 'beforeEach' | 'afterEach' | 'noExit' | 'filter' | 'exclude'> & cliConfigs;
 export type ConfigFile = Omit<Configs, 'noExit'> & cliConfigs;
+type Results = {
+    code: number;
+    timespan: Timespan;
+    results: typeof results;
+};
+type Path = {
+    absolute: string;
+    relative: string;
+};
+export type ReporterPlugin = (configs?: Configs) => {
+    onRunStart: () => void;
+    onDescribeAsTitle: (title: string, options: DescribeOptions) => void;
+    onDescribeStart: (options: {
+        title?: string;
+    }) => void;
+    onDescribeEnd: (options: {
+        title?: string;
+        duration: number;
+    }) => void;
+    onItStart: (options: {
+        title?: string;
+    }) => void;
+    onItEnd: (options: {
+        title?: string;
+        duration: number;
+    }) => void;
+    onAssertionSuccess: (options: {
+        message: string;
+    }) => void;
+    onAssertionFailure: (options: {
+        assertOptions: ProcessAssertionOptions;
+        error: AssertionError;
+    }) => void;
+    onSkipFile: (options: {
+        message: string;
+    }) => void;
+    onSkipModifier: (options: {
+        message: string;
+    }) => void;
+    onTodoModifier: (options: {
+        message: string;
+    }) => void;
+    onFileStart: (options: {
+        path: Path;
+    }) => void;
+    onFileResult: (options: {
+        status: boolean;
+        path: Path;
+        duration: number;
+        output?: string;
+    }) => void;
+    onRunResult: (options: Results) => void;
+    onExit: (options: Results) => void;
+};
+export type ReporterEvents = Partial<ReturnType<ReporterPlugin>>;
 export {};

package/lib/bin/help.js

@@ -27,6 +27,10 @@ const summary = [
     ['--killPort', 'Terminate the specified ports.'],
     ['--killRange', 'Terminate the specified port ranges.'],
     ['--listFiles', 'Display all the files returned in the terminal.'],
+    [
+        '--reporter, -r',
+        'Specify the reporter: poku, dot, compact, focus, verbose, classic.',
+    ],
     ['--only', 'Enable selective execution of tests.'],
     ['--quiet, -q', 'Run tests with no logs.'],
     ['--sequential', 'Run tests files sequentially.'],
@@ -35,7 +39,7 @@ const summary = [
     ['--watchInterval', 'Set an interval for watch events.'],
 ];
 const sortedSummary = summary.sort(([a], [b]) => a.localeCompare(b));
-const largeEndPad = (() => Math.max(...summary.map(([start]) => start.length)))();
+const largeEndPad = Math.max(...summary.map(([start]) => start.length));
 const header = `
 🐷 ${(0, format_js_1.format)(' Poku — CLI Usage ').bg('brightMagenta')}
 
@@ -68,18 +72,18 @@ ${sortedSummary
     ${u('https://poku.io/docs/tutorials/cross-platform')}
 `;
 const footer = `
-${b('Documentation:')} ${u('https://poku.io')}
+${b('Documentation:')} ${u('https://poku.io/docs')}
 
 ${bullet} ${b('Poku')} is made with ${b('love')} and ${b('care')} in every detail.
 ${bullet} Give him a ${b('star')} to show your support 🌟
 `;
 const help = () => {
-    write_js_1.Write.hr();
-    write_js_1.Write.log(header.trim());
-    write_js_1.Write.hr();
-    write_js_1.Write.log(main.trim());
-    write_js_1.Write.hr();
-    write_js_1.Write.log(footer.trim());
-    write_js_1.Write.hr();
+    (0, write_js_1.hr)();
+    (0, write_js_1.log)(header.trim());
+    (0, write_js_1.hr)();
+    (0, write_js_1.log)(main.trim());
+    (0, write_js_1.hr)();
+    (0, write_js_1.log)(footer.trim());
+    (0, write_js_1.hr)();
 };
 exports.help = help;

package/lib/bin/index.js

@@ -3,62 +3,67 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const list_files_js_1 = require("../modules/helpers/list-files.js");
 const get_arg_js_1 = require("../parsers/get-arg.js");
-const files_js_1 = require("../configs/files.js");
+const poku_js_1 = require("../configs/poku.js");
 const format_js_1 = require("../services/format.js");
 const kill_js_1 = require("../modules/helpers/kill.js");
 const env_js_1 = require("../modules/helpers/env.js");
-const poku_js_1 = require("../modules/essentials/poku.js");
+const poku_js_2 = require("../modules/essentials/poku.js");
 const write_js_1 = require("../services/write.js");
 const options_js_1 = require("../parsers/options.js");
+const poku_js_3 = require("../configs/poku.js");
 (async () => {
+    
     if ((0, get_arg_js_1.hasArg)('version') || (0, get_arg_js_1.hasArg)('v', '-')) {
-        const { VERSION } = require('../configs/poku.js');
-        write_js_1.Write.log(VERSION);
+        (0, write_js_1.log)(poku_js_3.VERSION);
         return;
     }
     if ((0, get_arg_js_1.hasArg)('help') || (0, get_arg_js_1.hasArg)('h', '-')) {
-        const { help } = require('./help.js');
-        help();
+        require('./help.js').help();
         return;
     }
     const enforce = (0, get_arg_js_1.hasArg)('enforce') || (0, get_arg_js_1.hasArg)('x', '-');
     const configFile = (0, get_arg_js_1.getArg)('config') || (0, get_arg_js_1.getArg)('c', '-');
-    const defaultConfigs = await (0, options_js_1.getConfigs)(configFile);
+    poku_js_3.GLOBAL.configsFromFile = await (0, options_js_1.getConfigs)(configFile);
+    const { configsFromFile } = poku_js_3.GLOBAL;
     const dirs = (0, get_arg_js_1.getPaths)('-') ??
-        (defaultConfigs?.include
-            ? Array.prototype.concat(defaultConfigs?.include)
+        (configsFromFile?.include
+            ? Array.prototype.concat(configsFromFile?.include)
             : ['.']);
-    const filter = (0, get_arg_js_1.getArg)('filter') ?? defaultConfigs?.filter;
-    const exclude = (0, get_arg_js_1.getArg)('exclude') ?? defaultConfigs?.exclude;
+    const filter = (0, get_arg_js_1.getArg)('filter') ?? configsFromFile?.filter;
+    const exclude = (0, get_arg_js_1.getArg)('exclude') ?? configsFromFile?.exclude;
     const killPort = (0, get_arg_js_1.getArg)('killPort');
     const killRange = (0, get_arg_js_1.getArg)('killRange');
     const killPID = (0, get_arg_js_1.getArg)('killPid');
+    const reporter = (0, get_arg_js_1.getArg)('reporter') ??
+        (0, get_arg_js_1.getArg)('r', '-') ??
+        poku_js_3.GLOBAL.configsFromFile.reporter ??
+        'poku';
     
-    const denoAllow = (0, get_arg_js_1.argToArray)('denoAllow') ?? defaultConfigs?.deno?.allow;
-    const denoDeny = (0, get_arg_js_1.argToArray)('denoDeny') ?? defaultConfigs?.deno?.deny;
+    const denoAllow = (0, get_arg_js_1.argToArray)('denoAllow') ?? configsFromFile?.deno?.allow;
+    const denoDeny = (0, get_arg_js_1.argToArray)('denoDeny') ?? configsFromFile?.deno?.deny;
     const denoCJS = (0, get_arg_js_1.getArg)('denoCjs')
         ?.split(',')
         .map((a) => a.trim())
         .filter((a) => a) ||
         (0, get_arg_js_1.hasArg)('denoCjs') ||
-        defaultConfigs?.deno?.cjs;
+        configsFromFile?.deno?.cjs;
     
-    const quiet = (0, get_arg_js_1.hasArg)('quiet') || (0, get_arg_js_1.hasArg)('q', '-') || defaultConfigs?.quiet;
-    const debug = (0, get_arg_js_1.hasArg)('debug') || (0, get_arg_js_1.hasArg)('d', '-') || defaultConfigs?.debug;
-    const failFast = (0, get_arg_js_1.hasArg)('failFast') || defaultConfigs?.failFast;
+    const quiet = (0, get_arg_js_1.hasArg)('quiet') || (0, get_arg_js_1.hasArg)('q', '-') || configsFromFile?.quiet;
+    const debug = (0, get_arg_js_1.hasArg)('debug') || (0, get_arg_js_1.hasArg)('d', '-') || configsFromFile?.debug;
+    const failFast = (0, get_arg_js_1.hasArg)('failFast') || configsFromFile?.failFast;
     const watchMode = (0, get_arg_js_1.hasArg)('watch') || (0, get_arg_js_1.hasArg)('w', '-');
     const hasEnvFile = (0, get_arg_js_1.hasArg)('envFile');
     const concurrency = (() => {
         const value = Number((0, get_arg_js_1.getArg)('concurrency'));
-        return Number.isNaN(value) ? defaultConfigs?.concurrency : value;
+        return Number.isNaN(value) ? configsFromFile?.concurrency : value;
     })();
     const sequential = (0, get_arg_js_1.hasArg)('sequential');
     if (dirs.length === 1)
-        files_js_1.states.isSinglePath = true;
+        poku_js_1.states.isSinglePath = true;
     if ((0, get_arg_js_1.hasArg)('listFiles')) {
         const { listFiles } = require('../modules/helpers/list-files.js');
         const files = [];
-        write_js_1.Write.hr();
+        (0, write_js_1.hr)();
         for (const dir of dirs)
             files.push(...(await listFiles(dir, {
                 filter: typeof filter === 'string'
@@ -68,28 +73,48 @@ const options_js_1 = require("../parsers/options.js");
                     ? new RegExp((0, list_files_js_1.escapeRegExp)(exclude))
                     : exclude,
             })));
-        write_js_1.Write.log(files
+        (0, write_js_1.log)(files
             .sort()
             .map((file) => `${(0, format_js_1.format)('-').dim()} ${file}`)
             .join('\n'));
-        write_js_1.Write.hr();
-        write_js_1.Write.log(`Total test files: ${(0, format_js_1.format)(String(files.length)).bold()}`);
-        write_js_1.Write.hr();
+        (0, write_js_1.hr)();
+        (0, write_js_1.log)(`Total test files: ${(0, format_js_1.format)(String(files.length)).bold()}`);
+        (0, write_js_1.hr)();
         return;
     }
-    if (enforce) {
-        const { checkFlags } = require('./enforce.js');
-        checkFlags();
-    }
+    poku_js_3.GLOBAL.configFile = configFile;
+    poku_js_3.GLOBAL.configs = {
+        filter: typeof filter === 'string' ? new RegExp((0, list_files_js_1.escapeRegExp)(filter)) : filter,
+        exclude: typeof exclude === 'string' ? new RegExp((0, list_files_js_1.escapeRegExp)(exclude)) : exclude,
+        concurrency,
+        sequential,
+        quiet,
+        debug,
+        failFast,
+        deno: {
+            allow: denoAllow,
+            deny: denoDeny,
+            cjs: denoCJS,
+        },
+        noExit: watchMode,
+        reporter,
+        beforeEach: 'beforeEach' in configsFromFile ? configsFromFile.beforeEach : undefined,
+        afterEach: 'afterEach' in configsFromFile ? configsFromFile.afterEach : undefined,
+    };
     const tasks = [];
+    if (hasEnvFile || configsFromFile?.envFile) {
+        poku_js_3.GLOBAL.envFile = (0, get_arg_js_1.getArg)('envFile') ?? configsFromFile?.envFile ?? '.env';
+    }
+    if (enforce)
+        require('../services/enforce.js').enforce();
     
-    if (killPort || defaultConfigs?.kill?.port) {
-        const ports = killPort?.split(',').map(Number) || defaultConfigs?.kill?.port || [];
+    if (killPort || configsFromFile?.kill?.port) {
+        const ports = killPort?.split(',').map(Number) || configsFromFile?.kill?.port || [];
         tasks.push(kill_js_1.kill.port(ports));
     }
-    if (killRange || defaultConfigs?.kill?.range) {
+    if (killRange || configsFromFile?.kill?.range) {
         const ranges = killRange?.split(',') ||
-            defaultConfigs?.kill?.range?.map((range) => `${range[0]}-${range[1]}`) ||
+            configsFromFile?.kill?.range?.map((range) => `${range[0]}-${range[1]}`) ||
             [];
         for (const range of ranges) {
             const ports = range.split('-').map(Number);
@@ -98,45 +123,25 @@ const options_js_1 = require("../parsers/options.js");
             tasks.push(kill_js_1.kill.range(startsAt, endsAt));
         }
     }
-    if (killPID || defaultConfigs?.kill?.pid) {
-        const PIDs = killPID?.split(',').map(Number) || defaultConfigs?.kill?.pid || [];
+    if (killPID || configsFromFile?.kill?.pid) {
+        const PIDs = killPID?.split(',').map(Number) || configsFromFile?.kill?.pid || [];
         tasks.push(kill_js_1.kill.pid(PIDs));
     }
     
-    if (hasEnvFile || defaultConfigs?.envFile) {
-        const envFilePath = (0, get_arg_js_1.getArg)('envFile') ?? defaultConfigs?.envFile;
-        tasks.push((0, env_js_1.envFile)(envFilePath));
-    }
-    const options = {
-        filter: typeof filter === 'string' ? new RegExp((0, list_files_js_1.escapeRegExp)(filter)) : filter,
-        exclude: typeof exclude === 'string' ? new RegExp((0, list_files_js_1.escapeRegExp)(exclude)) : exclude,
-        concurrency,
-        sequential,
-        quiet,
-        debug,
-        failFast,
-        deno: {
-            allow: denoAllow,
-            deny: denoDeny,
-            cjs: denoCJS,
-        },
-        noExit: watchMode,
-        beforeEach: 'beforeEach' in defaultConfigs ? defaultConfigs.beforeEach : undefined,
-        afterEach: 'afterEach' in defaultConfigs ? defaultConfigs.afterEach : undefined,
-    };
-    if (debug || defaultConfigs?.debug) {
-        write_js_1.Write.hr();
-        write_js_1.Write.log(`${(0, format_js_1.format)(' Debug Enabled ').bg('brightBlue')}\n`);
-        write_js_1.Write.log(`${(0, format_js_1.format)('…').info().italic()} ${(0, format_js_1.format)('Paths').bold()}`);
-        console.table(dirs);
-        write_js_1.Write.log('\n');
-        write_js_1.Write.log(`${(0, format_js_1.format)('…').info().italic()} ${(0, format_js_1.format)('Options').bold()}`);
-        console.dir(options, { depth: null, colors: true });
+    poku_js_3.GLOBAL.envFile && tasks.push((0, env_js_1.envFile)(poku_js_3.GLOBAL.envFile));
+    if (debug || configsFromFile?.debug) {
+        (0, write_js_1.hr)();
+        (0, write_js_1.log)(`${(0, format_js_1.format)(' Debug Enabled ').bg('brightBlue')}\n`);
+        (0, write_js_1.log)(`${(0, format_js_1.format)('…').info().italic()} ${(0, format_js_1.format)('Options').bold()}`);
+        console.dir(poku_js_3.GLOBAL.configs, {
+            depth: Number.POSITIVE_INFINITY,
+            colors: true,
+        });
+        (0, write_js_1.log)(`\n${(0, format_js_1.format)('💡')} To list all test files, run: ${(0, format_js_1.format)('poku --listFiles').bold()}`);
     }
     await Promise.all(tasks);
-    await (0, poku_js_1.poku)(dirs, options);
-    if (watchMode) {
-        const { startWatch } = require('./watch.js');
-        await startWatch(dirs, options);
-    }
+    await (0, poku_js_2.poku)(dirs);
+    
+    if (watchMode)
+        await require('./watch.js').startWatch(dirs);
 })();

package/lib/bin/watch.js

@@ -11,10 +11,12 @@ const write_js_1 = require("../services/write.js");
 const node_process_1 = __importDefault(require("process"));
 const format_js_1 = require("../services/format.js");
 const get_arg_js_1 = require("../parsers/get-arg.js");
-const files_js_1 = require("../configs/files.js");
 const os_js_1 = require("../polyfills/os.js");
-const startWatch = async (dirs, options) => {
+const poku_js_2 = require("../configs/poku.js");
+const poku_js_3 = require("../services/reporters/poku.js");
+const startWatch = async (dirs) => {
     let isRunning = false;
+    const { configs } = poku_js_2.GLOBAL;
     const watchers = new Set();
     const executing = new Set();
     const interval = Number((0, get_arg_js_1.getArg)('watchInterval')) || 1500;
@@ -22,8 +24,7 @@ const startWatch = async (dirs, options) => {
         isRunning = value;
     };
     const resultsClear = () => {
-        files_js_1.fileResults.success.clear();
-        files_js_1.fileResults.fail.clear();
+        poku_js_3.errors.length = 0;
     };
     const listenStdin = async (input) => {
         if (isRunning || executing.size > 0)
@@ -33,13 +34,13 @@ const startWatch = async (dirs, options) => {
                 watcher.stop();
             watchers.clear();
             resultsClear();
-            await (0, poku_js_1.poku)(dirs, options);
+            await (0, poku_js_1.poku)(dirs);
         }
     };
     node_process_1.default.stdin.removeListener('data', listenStdin);
     node_process_1.default.removeListener('SIGINT', poku_js_1.onSigint);
     resultsClear();
-    const mappedTests = await (0, map_tests_js_1.mapTests)('.', dirs, options.filter, options.exclude);
+    const mappedTests = await (0, map_tests_js_1.mapTests)('.', dirs, configs.filter, configs.exclude);
     for (const mappedTest of Array.from(mappedTests.keys())) {
         const currentWatcher = (0, watch_js_1.watch)(mappedTest, async (file, event) => {
             if (event === 'change') {
@@ -53,8 +54,8 @@ const startWatch = async (dirs, options) => {
                 if (!tests)
                     return;
                 await (0, poku_js_1.poku)(Array.from(tests), {
-                    ...options,
-                    concurrency: options.concurrency ??
+                    ...configs,
+                    concurrency: configs.concurrency ??
                         Math.max(Math.floor((0, os_js_1.availableParallelism)() / 2), 1),
                 });
                 setTimeout(() => {
@@ -73,7 +74,7 @@ const startWatch = async (dirs, options) => {
                 setIsRunning(true);
                 executing.add(file);
                 resultsClear();
-                (0, poku_js_1.poku)(file, options).then(() => setTimeout(() => {
+                (0, poku_js_1.poku)(file).then(() => setTimeout(() => {
                     executing.delete(file);
                     setIsRunning(false);
                 }, interval));
@@ -81,8 +82,8 @@ const startWatch = async (dirs, options) => {
         });
         currentWatcher.then((watcher) => watchers.add(watcher));
     }
-    write_js_1.Write.hr();
-    write_js_1.Write.log(`${(0, format_js_1.format)('Watching:').bold()} ${(0, format_js_1.format)(dirs.join(', ')).underline()}`);
+    (0, write_js_1.hr)();
+    (0, write_js_1.log)(`${(0, format_js_1.format)('Watching:').bold()} ${(0, format_js_1.format)(dirs.join(', ')).underline()}`);
     node_process_1.default.stdin.setEncoding('utf8');
     node_process_1.default.stdin.on('data', listenStdin);
 };

package/lib/builders/reporter.d.ts

@@ -0,0 +1,2 @@
+import type { ReporterEvents, ReporterPlugin } from '../@types/poku.js';
+export declare const createReporter: (events: ReporterEvents) => ReporterPlugin;

package/lib/builders/reporter.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReporter = void 0;
+const poku_js_1 = require("../services/reporters/poku.js");
+const createReporter = (events) => {
+    return () => ({
+        ...poku_js_1.poku,
+        ...events,
+    });
+};
+exports.createReporter = createReporter;

package/lib/configs/poku.d.ts

@@ -1,11 +1,82 @@
+import type { Timespan, States } from '../@types/poku.js';
+import type { ConfigFile, ConfigJSONFile, Configs, Runtime } from '../@types/poku.js';
+export declare const states: States;
+export declare const timespan: Timespan;
 export declare const results: {
-    success: number;
-    fail: number;
-    skip: number;
+    passed: number;
+    failed: number;
+    skipped: number;
     todo: number;
 };
 export declare const VERSION = "";
 export declare const deepOptions: string[];
 export declare const GLOBAL: {
     cwd: string;
+    configs: Configs;
+    configFile: string | undefined;
+    configsFromFile: ConfigFile | ConfigJSONFile;
+    reporter: {
+        onRunStart: () => void;
+        onDescribeAsTitle: (title: string, options: import("../@types/describe.js").DescribeOptions) => void;
+        onDescribeStart: (options: {
+            title?: string;
+        }) => void;
+        onDescribeEnd: (options: {
+            title?: string;
+            duration: number;
+        }) => void;
+        onItStart: (options: {
+            title?: string;
+        }) => void;
+        onItEnd: (options: {
+            title?: string;
+            duration: number;
+        }) => void;
+        onAssertionSuccess: (options: {
+            message: string;
+        }) => void;
+        onAssertionFailure: (options: {
+            assertOptions: import("../@types/assert.js").ProcessAssertionOptions;
+            error: import("assert").AssertionError;
+        }) => void;
+        onSkipFile: (options: {
+            message: string;
+        }) => void;
+        onSkipModifier: (options: {
+            message: string;
+        }) => void;
+        onTodoModifier: (options: {
+            message: string;
+        }) => void;
+        onFileStart: (options: {
+            path: {
+                absolute: string;
+                relative: string;
+            };
+        }) => void;
+        onFileResult: (options: {
+            status: boolean;
+            path: {
+                absolute: string;
+                relative: string;
+            };
+            duration: number;
+            output?: string;
+        }) => void;
+        onRunResult: (options: {
+            code: number;
+            timespan: Timespan;
+            results: typeof results;
+        }) => void;
+        onExit: (options: {
+            code: number;
+            timespan: Timespan;
+            results: typeof results;
+        }) => void;
+    };
+    isPoku: boolean;
+    FILE: string | undefined;
+    envFile: string | undefined;
+    runtime: Runtime;
+    runAsOnly: boolean;
 };

package/lib/configs/poku.js

@@ -1,15 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GLOBAL = exports.deepOptions = exports.VERSION = exports.results = void 0;
+exports.GLOBAL = exports.deepOptions = exports.VERSION = exports.results = exports.timespan = exports.states = void 0;
 const node_process_1 = require("process");
+const reporter_js_1 = require("../services/reporter.js");
+const get_runtime_js_1 = require("../parsers/get-runtime.js");
+exports.states = Object.create(null);
+exports.timespan = Object.create(null);
 exports.results = {
-    success: 0,
-    fail: 0,
-    skip: 0,
+    passed: 0,
+    failed: 0,
+    skipped: 0,
     todo: 0,
 };
-exports.VERSION = '3.0.0-rc.0';
+exports.VERSION = '3.0.0';
 exports.deepOptions = [];
 exports.GLOBAL = {
     cwd: (0, node_process_1.cwd)(),
+    configs: Object.create(null),
+    configFile: undefined,
+    configsFromFile: Object.create(null),
+    reporter: reporter_js_1.reporter[node_process_1.env.POKU_REPORTER || 'poku'](),
+    isPoku: typeof node_process_1.env.POKU_FILE === 'string' && node_process_1.env.POKU_FILE.length > 0,
+    FILE: node_process_1.env.POKU_FILE,
+    envFile: undefined,
+    runtime: (node_process_1.env.POKU_RUNTIME || (0, get_runtime_js_1.getRuntime)()),
+    runAsOnly: false,
 };