poku 2.6.2 → 2.6.3-canary.0af5c8f

package/lib/bin/enforce.js

@@ -14,15 +14,18 @@ const checkFlags = () => {
         '--denoAllow',
         '--denoCjs',
         '--denoDeny',
+        '--describeOnly',
         '--enforce',
         '--envFile',
         '--exclude',
         '--failFast',
         '--filter',
+        '--itOnly',
         '--killPid',
         '--killPort',
         '--killRange',
         '--node',
+        '--only',
         '--parallel',
         '--platform',
         '--quiet',

package/lib/bin/help.js

@@ -0,0 +1,98 @@
+"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('●');
+const summary = [
+    ['--bun', 'Enforce tests to run through Bun.'],
+    ['--concurrency', 'Limit the number of tests running concurrently.'],
+    ['--config, -c', 'Specify a configuration file.'],
+    ['--debug, -d', 'Show detailed logs.'],
+    ['--deno', 'Enforce tests to run through Deno.'],
+    ['--denoAllow', 'Allow permissions for Deno.'],
+    ['--denoCjs', 'Support CommonJS in Deno.'],
+    ['--denoDeny', 'Deny permissions for Deno.'],
+    ['--describeOnly', 'Only `describe` tests using `.only` will be run.'],
+    ['--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."],
+    ['--itOnly', 'Only `it` and `test` tests using `.only` will be run.'],
+    ['--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.'],
+    ['--node', 'Enforce tests to run through Node.js.'],
+    ['--only', 'Only tests using `.only` will be run.'],
+    ['--parallel, -p', 'Run tests files in parallel.'],
+    ['--platform', 'Enforce tests to run through a platform.'],
+    ['--quiet, -q', 'Run tests with no logs.'],
+    ['--testOnly', 'Only `it` and `test` tests using `.only` will be run.'],
+    ['--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 largeEndPad = (() => Math.max(...summary.map(([start]) => start.length)))();
+const header = `
+🐷 ${(0, format_js_1.format)(' Poku — CLI Usage ').bg('brightMagenta')}
+
+› ${u(b('Usage:'))}
+
+  poku ${options} ${paths}
+  poku ${paths} ${options}
+
+› ${u(b('Ensuring platforms:'))}
+
+  poku ${b('--node')} ${options} ${paths}
+  poku ${b('--bun')} ${options} ${paths}
+  poku ${b('--deno')} ${options} ${paths}
+
+› ${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')} ✨
+`;
+const main = `
+🐽 ${(0, format_js_1.format)(' Poku — Options ').bg('brightMagenta')}
+
+› ${u(b('Summary:'))}
+
+${sortedSummary
+    .map(([command, description]) => `${command.padEnd(largeEndPad)}  ${d(description)}`)
+    .join('\n')}
+
+› ${u(b('Notes:'))}
+
+  ${bullet} For Glob support, see:
+    ${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')}
+`;
+const footer = `
+${b('Documentation:')} ${u('https://poku.io')}
+
+${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();
+};
+exports.help = help;

package/lib/bin/index.js

@@ -18,6 +18,11 @@ const options_js_1 = require("../parsers/options.js");
         write_js_1.Write.log(VERSION);
         return;
     }
+    if ((0, get_arg_js_1.hasArg)('help') || (0, get_arg_js_1.hasArg)('h', '-')) {
+        const { 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);

package/lib/configs/poku.d.ts

@@ -5,3 +5,4 @@ export declare const results: {
     todo: number;
 };
 export declare const VERSION = "";
+export declare const deepOptions: string[];

package/lib/configs/poku.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VERSION = exports.results = void 0;
+exports.deepOptions = exports.VERSION = exports.results = void 0;
 exports.results = {
     success: 0,
     fail: 0,
     skip: 0,
     todo: 0,
 };
-exports.VERSION = '2.6.2';
+exports.VERSION = '2.6.3-canary.0af5c8f';
+exports.deepOptions = [];

package/lib/modules/essentials/strict.js

@@ -1,9 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.strict = void 0;
-const strict_1 = __importDefault(require("assert/strict"));
 const assert_js_1 = require("../../builders/assert.js");
-exports.strict = (0, assert_js_1.createAssert)(strict_1.default);
+const get_runtime_js_1 = require("../../parsers/get-runtime.js");
+
+const nodeAssert = !get_runtime_js_1.nodeVersion || get_runtime_js_1.nodeVersion >= 16
+    ? require("assert/strict")
+    : require("assert");
+exports.strict = (0, assert_js_1.createAssert)(nodeAssert);

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

@@ -1,12 +1,14 @@
 import type { DescribeOptions } from '../../@types/describe.js';
-import { todo, skip } from './modifiers.js';
-declare function describeCore(title: string, cb: () => Promise<unknown>): Promise<void>;
-declare function describeCore(title: string, cb: () => unknown): void;
+import { todo, skip, onlyDescribe } from './modifiers.js';
+export declare function describeBase(arg1: string | (() => unknown | Promise<unknown>), arg2?: (() => unknown | Promise<unknown>) | DescribeOptions): Promise<void>;
+declare function describeCore(message: string, cb: () => Promise<unknown>): Promise<void>;
+declare function describeCore(message: string, cb: () => unknown): void;
 declare function describeCore(cb: () => Promise<unknown>): Promise<void>;
-declare function describeCore(cb: () => unknown): unknown;
-declare function describeCore(title: string, options?: DescribeOptions): void;
+declare function describeCore(cb: () => unknown): void;
+declare function describeCore(message: string, options?: DescribeOptions): void;
 export declare const describe: typeof describeCore & {
     todo: typeof todo;
     skip: typeof skip;
+    only: typeof onlyDescribe;
 };
 export {};

package/lib/modules/helpers/describe.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.describe = void 0;
+exports.describeBase = describeBase;
 const node_process_1 = require("process");
 const format_js_1 = require("../../services/format.js");
 const write_js_1 = require("../../services/write.js");
 const indentation_js_1 = require("../../configs/indentation.js");
 const modifiers_js_1 = require("./modifiers.js");
-async function describeCore(arg1, arg2) {
+const get_arg_js_1 = require("../../parsers/get-arg.js");
+async function describeBase(arg1, arg2) {
     let title;
     let cb;
     let options;
@@ -46,7 +48,18 @@ async function describeCore(arg1, arg2) {
     indentation_js_1.indentation.hasDescribe = false;
     write_js_1.Write.log(`${(0, format_js_1.format)(`● ${title}`).success().bold()} ${(0, format_js_1.format)(`› ${total}ms`).success().dim()}`);
 }
+async function describeCore(messageOrCb, cbOrOptions) {
+    if (typeof messageOrCb === 'string' && typeof cbOrOptions !== 'function')
+        return describeBase(messageOrCb, cbOrOptions);
+    if (get_arg_js_1.hasOnly || get_arg_js_1.hasDescribeOnly)
+        return;
+    if (typeof messageOrCb === 'string' && typeof cbOrOptions === 'function')
+        return describeBase(messageOrCb, cbOrOptions);
+    if (typeof messageOrCb === 'function')
+        return describeBase(messageOrCb);
+}
 exports.describe = Object.assign(describeCore, {
     todo: modifiers_js_1.todo,
     skip: modifiers_js_1.skip,
+    only: modifiers_js_1.onlyDescribe,
 });

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

@@ -1,4 +1,8 @@
-import { todo, skip } from '../modifiers.js';
+import { todo, skip, onlyIt } from '../modifiers.js';
+export declare function itBase(...args: [
+    string | (() => unknown | Promise<unknown>),
+    (() => unknown | Promise<unknown>)?
+]): Promise<void>;
 declare function itCore(message: string, cb: () => Promise<unknown>): Promise<void>;
 declare function itCore(message: string, cb: () => unknown): void;
 declare function itCore(cb: () => Promise<unknown>): Promise<void>;
@@ -6,5 +10,6 @@ declare function itCore(cb: () => unknown): void;
 export declare const it: typeof itCore & {
     todo: typeof todo;
     skip: typeof skip;
+    only: typeof onlyIt;
 };
 export {};

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

@@ -1,13 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.it = void 0;
+exports.itBase = itBase;
 const node_process_1 = require("process");
 const each_js_1 = require("../../../configs/each.js");
 const indentation_js_1 = require("../../../configs/indentation.js");
 const format_js_1 = require("../../../services/format.js");
 const write_js_1 = require("../../../services/write.js");
 const modifiers_js_1 = require("../modifiers.js");
-async function itCore(...args) {
+const get_arg_js_1 = require("../../../parsers/get-arg.js");
+async function itBase(...args) {
     try {
         let message;
         let cb;
@@ -56,7 +58,16 @@ async function itCore(...args) {
         throw error;
     }
 }
+async function itCore(messageOrCb, cb) {
+    if (get_arg_js_1.hasOnly || get_arg_js_1.hasItOnly)
+        return;
+    if (typeof messageOrCb === 'string' && cb)
+        return itBase(messageOrCb, cb);
+    if (typeof messageOrCb === 'function')
+        return itBase(messageOrCb);
+}
 exports.it = Object.assign(itCore, {
     todo: modifiers_js_1.todo,
     skip: modifiers_js_1.skip,
+    only: modifiers_js_1.onlyIt,
 });

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

@@ -1,7 +1,15 @@
 export declare function todo(message: string): void;
-export declare function todo(message: string, _cb?: () => Promise<unknown>): Promise<void>;
-export declare function todo(message: string, _cb?: () => unknown): void;
-export declare function skip(message: string, _cb: () => Promise<unknown>): Promise<void>;
-export declare function skip(message: string, _cb: () => unknown): void;
-export declare function skip(_cb: () => Promise<unknown>): Promise<void>;
-export declare function skip(_cb: () => unknown): void;
+export declare function todo(message: string, cb?: () => Promise<unknown>): Promise<void>;
+export declare function todo(message: string, cb?: () => unknown): void;
+export declare function skip(message: string, cb: () => Promise<unknown>): Promise<void>;
+export declare function skip(message: string, cb: () => unknown): void;
+export declare function skip(cb: () => Promise<unknown>): Promise<void>;
+export declare function skip(cb: () => unknown): void;
+export declare function onlyDescribe(message: string, cb: () => Promise<unknown>): Promise<void>;
+export declare function onlyDescribe(message: string, cb: () => unknown): void;
+export declare function onlyDescribe(cb: () => Promise<unknown>): Promise<void>;
+export declare function onlyDescribe(cb: () => unknown): void;
+export declare function onlyIt(message: string, cb: () => Promise<unknown>): Promise<void>;
+export declare function onlyIt(message: string, cb: () => unknown): void;
+export declare function onlyIt(cb: () => Promise<unknown>): Promise<void>;
+export declare function onlyIt(cb: () => unknown): void;

package/lib/modules/helpers/modifiers.js

@@ -2,35 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.todo = todo;
 exports.skip = skip;
+exports.onlyDescribe = onlyDescribe;
+exports.onlyIt = onlyIt;
 const write_js_1 = require("../../services/write.js");
 const indentation_js_1 = require("../../configs/indentation.js");
 const format_js_1 = require("../../services/format.js");
+const core_js_1 = require("./it/core.js");
+const describe_js_1 = require("./describe.js");
+const get_arg_js_1 = require("../../parsers/get-arg.js");
+const node_process_1 = require("process");
 async function todo(message, _cb) {
     write_js_1.Write.log(`${indentation_js_1.indentation.hasDescribe ? '  ' : ''}${(0, format_js_1.format)(`● ${message}`).cyan().bold()}`);
-    
-    if (typeof _cb === 'function') {
-        const isAsync = _cb.constructor.name === 'AsyncFunction';
-        if (isAsync)
-            return await Promise.resolve();
-        return;
-    }
-    
 }
 async function skip(messageOrCb, _cb) {
-    const message = (typeof messageOrCb === 'string' && messageOrCb) || 'Skipping';
+    const message = typeof messageOrCb === 'string' ? messageOrCb : 'Skipping';
     write_js_1.Write.log(`${indentation_js_1.indentation.hasDescribe ? '  ' : ''}${(0, format_js_1.format)(`◯ ${message}`).info().bold()}`);
-    
-    if (typeof messageOrCb === 'function') {
-        const isAsync = messageOrCb.constructor.name === 'AsyncFunction';
-        if (isAsync)
-            return await Promise.resolve();
-        return;
+}
+async function onlyDescribe(messageOrCb, cb) {
+    if (!(get_arg_js_1.hasOnly || get_arg_js_1.hasDescribeOnly)) {
+        write_js_1.Write.log((0, format_js_1.format)("Can't run `describe.only` tests without `--only` or `--describeOnly` flags").fail());
+        (0, node_process_1.exit)(1);
     }
-    if (typeof _cb === 'function') {
-        const isAsync = _cb.constructor.name === 'AsyncFunction';
-        if (isAsync)
-            return await Promise.resolve();
-        return;
+    if (typeof messageOrCb === 'string' && cb)
+        return (0, describe_js_1.describeBase)(messageOrCb, cb);
+    if (typeof messageOrCb === 'function')
+        return (0, describe_js_1.describeBase)(messageOrCb);
+}
+async function onlyIt(messageOrCb, cb) {
+    if (!(get_arg_js_1.hasOnly || get_arg_js_1.hasItOnly)) {
+        write_js_1.Write.log((0, format_js_1.format)("Can't run `it.only` and `test.only` tests without `--only`, `--itOnly` or `--testOnly` flags").fail());
+        (0, node_process_1.exit)(1);
     }
-    
+    if (typeof messageOrCb === 'string' && cb)
+        return (0, core_js_1.itBase)(messageOrCb, cb);
+    if (typeof messageOrCb === 'function')
+        return (0, core_js_1.itBase)(messageOrCb);
 }

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

@@ -6,4 +6,5 @@ export declare const test: {
 } & {
     todo: typeof import("./modifiers.js").todo;
     skip: typeof import("./modifiers.js").skip;
+    only: typeof import("./modifiers.js").onlyIt;
 };

package/lib/parsers/get-arg.d.ts

@@ -2,3 +2,6 @@ export declare const getArg: (arg: string, prefix?: string, baseArgs?: string[])
 export declare const hasArg: (arg: string, prefix?: string, baseArgs?: string[]) => boolean;
 export declare const getPaths: (prefix?: string, baseArgs?: string[]) => string[] | undefined;
 export declare const argToArray: (arg: string, prefix?: string, baseArgs?: string[]) => string[] | undefined;
+export declare const hasOnly: boolean;
+export declare const hasItOnly: boolean;
+export declare const hasDescribeOnly: boolean;

package/lib/parsers/get-arg.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.argToArray = exports.getPaths = exports.hasArg = exports.getArg = void 0;
+exports.hasDescribeOnly = exports.hasItOnly = exports.hasOnly = exports.argToArray = exports.getPaths = exports.hasArg = exports.getArg = void 0;
 const node_process_1 = require("process");
 const to_dynamic_case_js_1 = require("./to-dynamic-case.js");
 const [, , ...processArgs] = node_process_1.argv;
@@ -43,3 +43,6 @@ const argToArray = (arg, prefix = '--', baseArgs = processedArgs) => {
         .filter((a) => a);
 };
 exports.argToArray = argToArray;
+exports.hasOnly = (0, exports.hasArg)('only');
+exports.hasItOnly = (0, exports.hasArg)('itonly') || (0, exports.hasArg)('testonly');
+exports.hasDescribeOnly = (0, exports.hasArg)('describeonly');

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

@@ -11,6 +11,7 @@ const format_js_1 = require("./format.js");
 const output_js_1 = require("../parsers/output.js");
 const each_js_1 = require("./each.js");
 const write_js_1 = require("./write.js");
+const poku_js_1 = require("../configs/poku.js");
 const cwd = (0, node_process_1.cwd)();
 const runTestFile = async (filePath, configs) => {
     var _a, _b;
@@ -41,7 +42,7 @@ const runTestFile = async (filePath, configs) => {
         return false;
     return new Promise((resolve) => {
         var _a;
-        const child = (0, node_child_process_1.spawn)(runtime, runtimeArguments, {
+        const child = (0, node_child_process_1.spawn)(runtime, [...runtimeArguments, ...poku_js_1.deepOptions], {
             stdio: ['inherit', 'pipe', 'pipe'],
             shell: get_runner_js_1.isWindows,
             env: {

package/lib/services/run-tests.js

@@ -15,7 +15,14 @@ const run_test_file_js_1 = require("./run-test-file.js");
 const output_js_1 = require("../parsers/output.js");
 const poku_js_1 = require("../configs/poku.js");
 const os_js_1 = require("../polyfills/os.js");
+const get_arg_js_1 = require("../parsers/get-arg.js");
 const cwd = node_process_1.default.cwd();
+if (get_arg_js_1.hasOnly)
+    poku_js_1.deepOptions.push('--only');
+if (get_arg_js_1.hasDescribeOnly)
+    poku_js_1.deepOptions.push('--describeOnly');
+if (get_arg_js_1.hasItOnly)
+    poku_js_1.deepOptions.push('--itOnly');
 const runTests = async (dir, configs) => {
     const testDir = (0, node_path_1.join)(cwd, dir);
     const currentDir = (0, node_path_1.relative)(cwd, testDir);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poku",
-  "version": "2.6.2",
+  "version": "2.6.3-canary.0af5c8f",
   "description": "🐷 Poku makes testing easy for Node.js, Bun, Deno, and you at the same time.",
   "main": "./lib/modules/index.js",
   "license": "MIT",
@@ -64,7 +64,7 @@
     "packages-update": "^2.0.0",
     "prettier": "^3.3.3",
     "tsx": "4.19.0",
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   },
   "keywords": [
     "🐷",