poku 4.3.1 → 4.3.2-canary.1dfeb8fc

package/README.md

@@ -209,20 +209,20 @@ deno run npm:poku
 
 <table>
   <tr>
-    <td width="280"><a href="https://poku.io/docs/documentation/poku/options/watch">watch</a></td>
-    <td width="770">🍿 Watch for changes and re-run related test files.</td>
+    <td><a href="https://poku.io/docs/documentation/helpers/coverage">coverage</a></td>
+    <td>☔️ Enable coverage collection using a coverage plugin.</td>
   </tr>
   <tr>
-    <td><a href="https://poku.io/docs/documentation/poku/options/debug">debug</a></td>
-    <td>🕵🏻 Shows all logs.</td>
+    <td><a href="https://poku.io/docs/documentation/poku/config-files">config</a></td>
+    <td>⚙️ Customize your <b>Poku</b> options in a config file.</td>
   </tr>
   <tr>
-    <td><a href="https://poku.io/docs/documentation/poku/config-files">config</a></td>
-    <td>⚙️ Customize your Poku options in a config file.</td>
+    <td width="280"><a href="https://poku.io/docs/documentation/poku/options/watch">watch</a></td>
+    <td width="770">🍿 Watch for changes and re-run related test files.</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>
+    <td><a href="https://poku.io/docs/documentation/poku/options/debug">debug</a></td>
+    <td>🕵🏻 Shows all logs.</td>
   </tr>
 </table>
 
@@ -248,9 +248,9 @@ To see the detailed documentation, please visit the [**Documentation**](https://
 - [Properly running asynchronous tests on the same file](https://poku.io/docs/examples/promises).
 - [Using **Poku** without installing it on **Deno**](https://github.com/wellwelwel/poku/discussions/565).
 - Migrating:
-  - [From version **3.x.x** to version **4.x.x**](https://github.com/wellwelwel/poku/issues/1006).
-  - [From version **2.x.x** to version **3.x.x**](https://github.com/wellwelwel/poku/issues/801).
-  - [From version **1.x.x** to version **2.x.x**](https://github.com/wellwelwel/poku/issues/533).
+  - [**3.x.x** → **4.x.x**](https://github.com/wellwelwel/poku/issues/1006)
+  - [**2.x.x** → **3.x.x**](https://github.com/wellwelwel/poku/issues/801)
+  - [**1.x.x** → **2.x.x**](https://github.com/wellwelwel/poku/issues/533)
 
 ---
 
@@ -260,11 +260,10 @@ To see the detailed documentation, please visit the [**Documentation**](https://
 
 **Poku** is [continuously tested](https://github.com/wellwelwel/poku/blob/main/.github/workflows/ci_benchmark.yml) to ensure the following average expectations for basic usage:
 
-- ~**4.6x** faster than [**Jest**](https://github.com/jestjs/jest) (v30.3.0)
-- ~**3.5x** faster than [**Vitest**](https://github.com/vitest-dev/vitest) (v4.1.2)
+- ~**5.3x** faster than [**Jest**](https://github.com/jestjs/jest) (v30.4.2)
+- ~**4.5x** faster than [**Vitest**](https://github.com/vitest-dev/vitest) (v4.1.6)
 
-> - You can see how the tests are run and compared in the [benchmark](https://github.com/wellwelwel/poku/tree/main/benchmark) directory.
-> - [Comparing **Poku** and native test runners _(discussion)_](https://github.com/wellwelwel/poku/discussions/740).
+> - You can see how the tests are run and compared in the [**benchmark**](https://github.com/wellwelwel/poku/tree/main/benchmark) directory.
 
 ---
 
@@ -272,9 +271,11 @@ To see the detailed documentation, please visit the [**Documentation**](https://
 
 [![Install Size](https://packagephobia.com/badge?p=poku)](https://pkg-size.dev/poku)
 
-- [~**206x** lighter than **Vitest**](https://pkg-size.dev/vitest@3.2.4)
-- [~**165x** lighter than **Jest**](https://pkg-size.dev/jest@30.0.5)
-- [~**52x** lighter than **Mocha**](https://pkg-size.dev/mocha@11.7.1)
+- [~**150x** lighter than **Jest**](https://pkg-size.dev/jest@30.4.2)
+- [~**125x** lighter than **Vitest**](https://pkg-size.dev/vitest@4.1.6)
+- [~**85x** lighter than **AVA**](https://pkg-size.dev/ava@8.0.0)
+- [~**48x** lighter than **Mocha**](https://pkg-size.dev/mocha@11.7.5)
+- [~**2.9x** lighter than **uvu**](https://pkg-size.dev/uvu@0.5.6)
 
 > **Poku** size ensures _cost-saving_ **CI** for services that charge for storage and usage.
 
@@ -315,7 +316,7 @@ Really thanks to everyone who has supported and keeps supporting my work.
 ## License
 
 **Poku** is under the [**MIT License**](https://github.com/wellwelwel/poku/blob/main/LICENSE).<br />
-Copyright © 2024-present [Weslley Araújo](https://github.com/wellwelwel) and **Poku** [contributors](https://github.com/wellwelwel/poku/graphs/contributors).
+Copyright © 2024-present [**Weslley Araújo**](https://github.com/wellwelwel) and **Poku** [**contributors**](https://github.com/wellwelwel/poku/graphs/contributors).
 
 [node-version-url]: https://github.com/nodejs/node
 [bun-version-url]: https://github.com/oven-sh/bun

package/lib/bin/enforce.js

@@ -0,0 +1,149 @@
+import {stat}from'node:fs/promises';import {exit,argv}from'node:process';import {hr,log$1 as log,format,GLOBAL,getArg,reporter,hasArg}from'../modules/_shared.js';import'node:path';import'node:os';import'node:child_process';import'node:assert';import'node:assert/strict';import'node:net';import'node:url';const errors = [];
+const pathExists = async (arg, path) => {
+  try {
+    await stat(path);
+  } catch {
+    errors.push(`--${arg}: ./${path} doesn't exists.`);
+  }
+};
+const checkUselessValue = (arg) => {
+  const prefix = arg.length === 1 ? "-" : "--";
+  if (typeof getArg(arg, prefix) !== "undefined")
+    errors.push(`${prefix}${arg}: this flag shouldn't receive a value.`);
+};
+const checkRequiredValue = (arg) => {
+  const prefix = arg.length === 1 ? "-" : "--";
+  if (hasArg(arg, prefix) && typeof getArg(arg, prefix) === "undefined")
+    errors.push(`${prefix}${arg}: this flag require a value.`);
+};
+const checkFlags = () => {
+  const allowedFlags = /* @__PURE__ */ new Set([
+    "--concurrency",
+    "--config",
+    "--coverage",
+    "--coverageConfig",
+    "--debug",
+    "--denoAllow",
+    "--denoDeny",
+    "--enforce",
+    "--envFile",
+    "--exclude",
+    "--failFast",
+    "--filter",
+    "--isolation",
+    "--killPid",
+    "--killPort",
+    "--killRange",
+    "--only",
+    "--quiet",
+    "--reporter",
+    "--sequential",
+    "--testNamePattern",
+    "--testSkipPattern",
+    "--timeout",
+    "--watch",
+    "--watchInterval",
+    "-c",
+    "-d",
+    "-q",
+    "-r",
+    "-t",
+    "-w",
+    "-x"
+  ]);
+  const args = argv.slice(2);
+  for (const arg of args) {
+    const flag = arg.split("=")[0];
+    if (!allowedFlags.has(flag) && flag.startsWith("-"))
+      errors.push(`${flag}: unrecognized flag.`);
+  }
+};
+const checkValues = async () => {
+  for (const flag of [
+    "debug",
+    "enforce",
+    "failFast",
+    "only",
+    "quiet",
+    "sequential",
+    "watch",
+    "d",
+    "x",
+    "q",
+    "w"
+  ])
+    checkUselessValue(flag);
+  for (const flag of [
+    "concurrency",
+    "config",
+    "isolation",
+    "killPid",
+    "killPort",
+    "reporter",
+    "testNamePattern",
+    "testSkipPattern",
+    "timeout",
+    "watchInterval",
+    "c",
+    "r",
+    "t"
+  ])
+    checkRequiredValue(flag);
+  if (GLOBAL.configFile) await pathExists("config", GLOBAL.configFile);
+  if (GLOBAL.envFile) await pathExists("envFile", GLOBAL.envFile);
+  if (getArg("concurrency") && typeof GLOBAL.configs.concurrency === "undefined")
+    errors.push("--concurrency: expects for a valid integer.");
+  if (getArg("timeout") && typeof GLOBAL.configs.timeout === "undefined")
+    errors.push("--timeout: expects for a valid integer.");
+  const isolationValue = getArg("isolation");
+  if (isolationValue && isolationValue !== "none" && isolationValue !== "process")
+    errors.push(
+      `--isolation: "${isolationValue}" is not valid. Available: none, process.`
+    );
+  const reporterValue = getArg("reporter") ?? getArg("r", "-");
+  if (reporterValue && !(reporterValue in reporter))
+    errors.push(
+      `--reporter: "${reporterValue}" is not a valid reporter. Available: ${Object.keys(reporter).join(", ")}.`
+    );
+};
+const checkConfigFile = () => {
+  const allowedProps = /* @__PURE__ */ new Set([
+    "$schema",
+    "include",
+    "sequential",
+    "debug",
+    "filter",
+    "exclude",
+    "failFast",
+    "envFile",
+    "exclude",
+    "failFast",
+    "concurrency",
+    "quiet",
+    "timeout",
+    "envFile",
+    "kill",
+    "isolation",
+    "platform",
+    "deno",
+    "testNamePattern",
+    "testSkipPattern"
+  ]);
+  for (const prop in GLOBAL.configsFromFile) {
+    if (!allowedProps.has(prop))
+      errors.push(`${prop}: unrecognized property in the config file.`);
+  }
+};
+const enforce = async () => {
+  checkFlags();
+  checkConfigFile();
+  await checkValues();
+  if (errors.length > 0) {
+    hr();
+    log(`${format("Ensure Enabled").bold()}
+`);
+    log(errors.map((flag) => format(flag).fail()).join("\n"));
+    hr();
+    exit(1);
+  }
+};export{enforce};

package/lib/bin/help.js

@@ -1,94 +1,88 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.help = void 0;
-const format_js_1 = require("../services/format.js");
-const write_js_1 = require("../services/write.js");
-const b = (text) => `${(0, format_js_1.format)(text).bold()}`;
-const i = (text) => `${(0, format_js_1.format)(text).italic()}`;
-const u = (text) => `${(0, format_js_1.format)(text).underline()}`;
-const d = (text) => `${(0, format_js_1.format)(text).dim()}`;
-const options = i('[--options]');
-const paths = i('[paths]');
-const bullet = d('●');
+import {hr,log$1 as log,format}from'../modules/_shared.js';import'node:path';import'node:process';import'node:os';import'node:child_process';import'node:assert';import'node:assert/strict';import'node:fs/promises';import'node:net';import'node:url';const b = (text) => `${format(text).bold()}`;
+const i = (text) => `${format(text).italic()}`;
+const u = (text) => `${format(text).underline()}`;
+const d = (text) => `${format(text).dim()}`;
+const options = i("[--options]");
+const paths = i("[paths]");
+const bullet = d("\u25CF");
 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.'],
-    ['--enforce, -x', 'Validate options before running tests.'],
-    ['--envFile', 'Read and set an environment file.'],
-    ['--exclude', 'Exclude by path using Regex to match files.'],
-    ['--failFast', 'Stop tests at the first failure.'],
-    ['--filter', 'Filter by path using Regex to match files.'],
-    ['--help, -h', "Show Poku's CLI basic usage."],
-    ['--killPid', 'Terminate the specified processes.'],
-    ['--killPort', 'Terminate the specified ports.'],
-    ['--killRange', 'Terminate the specified port ranges.'],
-    ['--listFiles', 'Display all the files returned in the terminal.'],
-    ['--isolation', 'Set test isolation mode (none, process). Default: process.'],
-    [
-        '--reporter, -r',
-        'Specify the reporter: poku, dot, compact, focus, classic.',
-    ],
-    ['--only', 'Enable selective execution of tests.'],
-    ['--quiet, -q', 'Run tests with no logs.'],
-    ['--sequential', 'Run tests files sequentially.'],
-    ['--testNamePattern, -t', 'Run only tests matching the given regex.'],
-    ['--testSkipPattern', 'Skip tests matching the given regex.'],
-    ['--timeout', 'Set the maximum time (ms) for each test file.'],
-    ['--version, -v', "Show Poku's installed version."],
-    ['--watch, -w', 'Watch for test events.'],
-    ['--watchInterval', 'Set an interval for watch events.'],
+  ["--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."],
+  ["--enforce, -x", "Validate options before running tests."],
+  ["--envFile", "Read and set an environment file."],
+  ["--exclude", "Exclude by path using Regex to match files."],
+  ["--failFast", "Stop tests at the first failure."],
+  ["--filter", "Filter by path using Regex to match files."],
+  ["--help, -h", "Show Poku's CLI basic usage."],
+  ["--killPid", "Terminate the specified processes."],
+  ["--killPort", "Terminate the specified ports."],
+  ["--killRange", "Terminate the specified port ranges."],
+  ["--listFiles", "Display all the files returned in the terminal."],
+  ["--isolation", "Set test isolation mode (none, process). Default: process."],
+  [
+    "--reporter, -r",
+    "Specify the reporter: poku, dot, compact, focus, classic."
+  ],
+  ["--only", "Enable selective execution of tests."],
+  ["--quiet, -q", "Run tests with no logs."],
+  ["--sequential", "Run tests files sequentially."],
+  ["--testNamePattern, -t", "Run only tests matching the given regex."],
+  ["--testSkipPattern", "Skip tests matching the given regex."],
+  ["--timeout", "Set the maximum time (ms) for each test file."],
+  ["--version, -v", "Show Poku's installed version."],
+  ["--watch, -w", "Watch for test events."],
+  ["--watchInterval", "Set an interval for watch events."]
 ];
-const sortedSummary = summary.sort(([a], [b]) => a.localeCompare(b));
+const sortedSummary = summary.sort(([a], [b2]) => a.localeCompare(b2));
 const largeEndPad = Math.max(...summary.map(([start]) => start.length));
 const header = `
-🐷 ${(0, format_js_1.format)(' Poku — CLI Usage ').bg('brightMagenta')}
+\u{1F437} ${format(" Poku \u2014 CLI Usage ").bg("brightMagenta")}
 
-› ${u(b('Usage:'))}
+\u203A ${u(b("Usage:"))}
 
   poku ${options} ${paths}
   poku ${paths} ${options}
 
-› ${u(b('Tips:'))}
+\u203A ${u(b("Tips:"))}
 
-  ${bullet} All CLI options use camel case pattern (e.g.: ${b('--failFast')}).
-  ${bullet} Use ${b('=')} to set an option value (e.g.: ${b('--concurrency=4')}).
-  ${bullet} If you're seeing this, ${u('feel special')} ✨
+  ${bullet} All CLI options use camel case pattern (e.g.: ${b("--failFast")}).
+  ${bullet} Use ${b("=")} to set an option value (e.g.: ${b("--concurrency=4")}).
+  ${bullet} If you're seeing this, ${u("feel special")} \u2728
 `;
 const main = `
-🐽 ${(0, format_js_1.format)(' Poku — Options ').bg('brightMagenta')}
+\u{1F43D} ${format(" Poku \u2014 Options ").bg("brightMagenta")}
 
-› ${u(b('Summary:'))}
+\u203A ${u(b("Summary:"))}
 
-${sortedSummary
-    .map(([command, description]) => `${command.padEnd(largeEndPad)}  ${d(description)}`)
-    .join('\n')}
+${sortedSummary.map(
+  ([command, description]) => `${command.padEnd(largeEndPad)}  ${d(description)}`
+).join("\n")}
 
-› ${u(b('Notes:'))}
+\u203A ${u(b("Notes:"))}
 
   ${bullet} For Glob support, see:
-    ${u('https://poku.io/docs/documentation/poku/include-files#by-extending-glob-patterns-from-shell')}
+    ${u("https://poku.io/docs/documentation/poku/include-files#by-extending-glob-patterns-from-shell")}
 
   ${bullet} Avoid conflicts for environments with multiple platforms:
-    ${u('https://poku.io/docs/tutorials/cross-platform')}
+    ${u("https://poku.io/docs/tutorials/cross-platform")}
 `;
 const footer = `
-${b('Documentation:')} ${u('https://poku.io/docs')}
+${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 🌟
+${bullet} ${b("Poku")} is made with ${b("love")} and ${b("care")} in every detail.
+${bullet} Give him a ${b("star")} to show your support \u{1F31F}
 `;
 const help = () => {
-    (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;
+  hr();
+  log(header.trim());
+  hr();
+  log(main.trim());
+  hr();
+  log(footer.trim());
+  hr();
+};export{help};