poku 1.3.0 → 1.4.0

package/README.md

@@ -6,6 +6,7 @@
 [deno-version-image]: https://img.shields.io/badge/Deno->=1.30.0-70ffaf
 [npm-image]: https://img.shields.io/npm/v/poku.svg?color=3dc1d3
 [npm-url]: https://npmjs.org/package/poku
+[typescript-url]: https://github.com/microsoft/TypeScript
 [ci-url]: https://github.com/wellwelwel/poku/actions/workflows/ci.yml?query=branch%3Amain
 [ci-image]: https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/ci.yml?event=push&style=flat&label=CI&branch=main
 [ql-url]: https://github.com/wellwelwel/poku/actions/workflows/codeql.yml?query=branch%3Amain
@@ -17,7 +18,7 @@
 
 <img align="right" width="128" height="128" alt="Logo" src=".github/assets/readme/poku.svg">
 
-A flexible and easy-to-use **Test Runner** for [Node.js][node-version-url], [Bun][bun-version-url] and [Deno][deno-version-url] that allows you to run **parallel** and **sequential** tests, plus **high isolation level per test file**.
+**Poku** is your test runner pet for [**Node.js**][node-version-url], [**Bun**][bun-version-url] and [**Deno**][deno-version-url] combining **flexibility**, **parallel** and **sequential** runs, **human-friendly assertion errors** and **high isolation level**.
 
 [![Node.js Version][node-version-image]][node-version-url]
 [![Bun Version][bun-version-image]][bun-version-url]
@@ -27,6 +28,12 @@ A flexible and easy-to-use **Test Runner** for [Node.js][node-version-url], [Bun
 [![GitHub Workflow Status (with event)][ci-image]][ci-url]
 [![GitHub Workflow Status (with event)][ql-image]][ql-url]
 
+Enjoying Poku? Consider giving him a star ⭐️
+
+---
+
+🐷 [**Documentation Website**](https://poku.dev)
+
 ---
 
 ## Why Poku?
@@ -35,23 +42,29 @@ A flexible and easy-to-use **Test Runner** for [Node.js][node-version-url], [Bun
 
 - Supports **ESM** and **CJS**
 - Designed to be highly intuitive
-- No need to compile **TypeScript**
+- No need to compile [**TypeScript**][typescript-url] \*
 - Compatible with **Coverage** tools
 - Allows both **in-code** and **CLI** usage
 - [**Node.js**][node-version-url], [**Bun**][bun-version-url] and [**Deno**][deno-version-url] compatibility
 - Zero configurations, except you want
 - No constraints or rules, code in your own signature style
+- [**And much more!**](https://poku.dev)
 
 ---
 
 - <img src="https://img.shields.io/bundlephobia/min/poku?label=Final%20Size">
 - **Zero** external dependencies
-- **Poku** dive to the deepest depths to find tests in the specified directories
-- **Compatibility:** **Poku** is tested across all **Node 6+**, **Bun 0.5.3+** and **Deno 1.30+** versions
-- **Poku** uses itself to test its own tests using `process.exit` at several depths on the same process node
 
 ---
 
+## Documentation
+
+- See detailed specifications and usage in [**Documentation**](https://poku.dev/docs/category/documentation) section for queries, advanced concepts and much more.
+
+---
+
+## Overview
+
 | Sequential                                                   | Parallel                                                   |
 | ------------------------------------------------------------ | ---------------------------------------------------------- |
 | `npx poku test/unit,test/integration`                        | `npx poku --parallel test/unit,test/integration`           |
@@ -120,7 +133,7 @@ import { poku } from 'npm:poku';
 
 ---
 
-## Basic Usage
+## Quick Start
 
 ### In-code
 
@@ -164,362 +177,7 @@ deno run npm:poku targetDirA,targetDirB
 
 ---
 
-## Documentation
-
-> Website in Progress 🧑🏻‍🔧
->
-> Initially, the documentation is based on **Node.js** usage, but you can use all the options normally for both **Bun** and **Deno**.
-
-### `poku(targetDirs: string | string[])`
-
-#### Include directories
-
-- **in-code**
-
-```ts
-poku('targetDir');
-```
-
-```ts
-poku(['targetDirA', 'targetDirB']);
-```
-
-- **CLI**
-
-By setting the directories as the last argument:
-
-> _Since **1.3.0**_
-
-```bash
-npx poku targetDir
-```
-
-```bash
-npx poku targetDirA,targetDirB
-```
-
-By using `--include` option:
-
-> _Since **1.0.0**_
-
-```bash
-npx poku --include='targetDir'
-```
-
-```bash
-npx poku --include='targetDirA,targetDirB'
-```
-
----
-
-### `poku(targetDirs: string | string[], configs?: Configs)`
-
-#### `parallel: boolean`
-
-Determines the mode of test execution across **sequential** or **parallel** modes.
-
-- **in-code**
-
-```ts
-/**
- * @default
- *
- * Sequential mode
- */
-
-poku(['...'], {
-  parallel: false,
-});
-```
-
-```ts
-/**
- * Parallel mode
- */
-
-poku(['...'], {
-  parallel: true,
-});
-```
-
-- **CLI**
-
-> _Since **1.2.0**_
-
-```bash
-# Parallel mode
-
-npx poku --parallel ./test
-```
-
----
-
-#### `platform: "node" | "bun" | "deno"`
-
-> _Since **1.2.0**_
-
-By default, **Poku** tries to identify the platform automatically, but you can set it manually:
-
-- **in-code**
-
-```ts
-/**
- * Force Node.js (or tsx for TypeScript)
- *
- * @default 'node'
- */
-
-poku('...', {
-  platform: 'node',
-});
-```
-
-```ts
-/**
- * Force Bun
- */
-
-poku('...', {
-  platform: 'bun',
-});
-```
-
-```ts
-/**
- * Force Deno
- */
-
-poku('...', {
-  platform: 'deno',
-});
-```
-
-- **CLI**
-
-```bash
-# Normal
-
-npx      poku      --platform=node  ./test
-bun      poku      --platform=bun   ./test
-deno run npm:poku  --platform=deno  ./test
-```
-
-```bash
-# Custom
-# When you're developing using a platform, but maintain compatibility with others
-
-npx      poku      --platform=bun   ./test
-bun      poku      --platform=deno  ./test
-deno run npm:poku  --platform=node  ./test
-
-# ...
-```
-
----
-
-#### `filter: RegExp`
-
-By default, **Poku** searches for _`.test.`_ files, but you can customize it using the `filter` option.
-
-> Filter by path using **Regex** to match only the files that should be performed.
-
-- **in-code**
-
-```ts
-/**
- * @default
- *
- * Testing all `*.test.*` files.
- */
-
-poku(['...'], {
-  filter: /\.test\./,
-});
-```
-
-```ts
-/**
- * Testing all `ts`, `js`, `mts` and `mjs` files
- */
-
-poku(['...'], {
-  filter: /\.(m)?(j|t)s$/,
-  // filter: /\.(js|ts|mjs|mts)$/,
-});
-```
-
-- **CLI**
-
-```bash
-# Testing only a specific file
-
-npx poku --filter='some-file' ./test
-```
-
-```bash
-# Testing only a specific file
-
-npx poku --filter='some-file|other-file' ./test
-```
-
-```bash
-# Testing only paths that contains "unit"
-
-npx poku --filter='unit' ./test
-```
-
-- **Environment Variable**
-
-> By using `FILTER` from **Environment Variable**, it will overwrite the `filter` option.
-
-```bash
-# Testing only a specific file
-
-FILTER='some-file' npx poku ./test
-```
-
-```bash
-# Testing only a specific file
-
-FILTER='some-file|other-file' npx poku ./test
-```
-
-```bash
-# Testing only paths that contains "unit"
-
-FILTER='unit' npx poku ./test
-```
-
----
-
-#### `exclude: RegExp | RegExp[]`
-
-> Exclude by path using Regex to match only the files that should be performed.
->
-> _Since **1.2.0**_
-
-- **in-code**:
-
-```ts
-/**
- * Excluding  directories from tests
- */
-
-poku(['...'], {
-  exclude: /\/(helpers|tools)\//,
-});
-```
-
-```ts
-/**
- * Excluding  directories from tests
- */
-
-poku(['...'], {
-  exclude: [/\/helpers\//, /\/tools\//],
-});
-```
-
-```ts
-/**
- * Excluding specific files from tests
- */
-
-poku(['...'], {
-  exclude: /(index|common).test.ts/,
-});
-```
-
-```ts
-/**
- * Excluding specific files from tests
- */
-
-poku(['...'], {
-  exclude: [/index.test.ts/, /common.test.ts/],
-});
-```
-
-```ts
-/**
- * Excluding directories and files from tests
- */
-
-poku(['...'], {
-  exclude: /\/(helpers|tools)\/|(index|common).test.ts/,
-});
-```
-
-```ts
-/**
- * Excluding directories and files from tests
- */
-
-poku(['...'], {
-  exclude: [/\/helpers\//, /\/tools\//, /index.test.ts/, /common.test.ts/],
-});
-```
-
-- **CLI**
-
-```bash
-# Excluding directories and files from tests
-
-npx poku --exclude='some-file-or-dir' ./test
-```
-
-```bash
-# Excluding directories and files from tests
-
-npx poku --exclude='some-file-or-dir|other-file-or-dir' ./test
-```
-
----
-
-### Assert
-
-> _Since **1.3.0**_
->
-> [**Node.js**][node-version-url], [**Bun**][bun-version-url] and [**Deno**][deno-version-url] compatible.
-
-**Poku** includes the `assert` method, keeping everything as it is, but providing human readability.
-
-**Available methods:**
-
-- `assert(value[, message])`
-- `assert.deepEqual(actual, expected[, message])`
-- `assert.deepStrictEqual(actual, expected[, message])`
-- `assert.doesNotMatch(string, regexp[, message])`
-- `assert.doesNotReject(asyncFn[, error][, message])`
-- `assert.doesNotThrow(fn[, error][, message])`
-- `assert.equal(actual, expected[, message])`
-- `assert.fail([message])`
-- `assert.ifError(value)`
-- `assert.match(string, regexp[, message])`
-- `assert.notDeepEqual(actual, expected[, message])`
-- `assert.notDeepStrictEqual(actual, expected[, message])`
-- `assert.notEqual(actual, expected[, message])`
-- `assert.notStrictEqual(actual, expected[, message])`
-- `assert.ok(value[, message])`
-- `assert.rejects(asyncFn[, error][, message])`
-- `assert.strictEqual(actual, expected[, message])`
-- `assert.throws(fn[, error][, message])`
-
-You can follow the [**assert documentation**](https://nodejs.org/api/assert.html) from **Node.js**'s documentation.
-
----
-
-### `listFiles(targetDir: string, configs?: ListFilesConfigs)`
-
-> _Since **1.2.0**_
-
-Returns all files in a directory, independent of their depth.
-
-```ts
-listFiles('some-dir');
-```
-
-- You can use the `filter` and `exclude` options, as well as they are for **`poku`** method.
+To see the detailed documentation, please visit the [**Documentation**](https://poku.dev/docs/category/documentation) section in the [**Poku**'s website](https://poku.dev).
 
 ---
 

package/lib/bin/index.js

@@ -11,11 +11,17 @@ const dirs = ((0, get_arg_js_1.hasArg)('include')
     : (_b = (0, get_arg_js_1.getLastParam)()) === null || _b === void 0 ? void 0 : _b.split(',')) || [];
 const platform = (0, get_arg_js_1.getArg)('platform');
 const filter = (0, get_arg_js_1.getArg)('filter');
-const parallel = (0, get_arg_js_1.hasArg)('parallel');
 const exclude = (0, get_arg_js_1.getArg)('exclude');
+const parallel = (0, get_arg_js_1.hasArg)('parallel');
+const quiet = (0, get_arg_js_1.hasArg)('quiet');
+const logSuccess = (0, get_arg_js_1.hasArg)('log-success');
 (0, index_js_1.poku)(dirs, {
     platform: (0, get_runtime_js_1.platformIsValid)(platform) ? platform : undefined,
     filter: filter ? new RegExp((0, list_files_js_1.escapeRegExp)(filter)) : undefined,
     exclude: exclude ? new RegExp((0, list_files_js_1.escapeRegExp)(exclude)) : undefined,
     parallel,
+    quiet,
+    log: {
+        success: logSuccess,
+    },
 });

package/lib/modules/poku.d.ts

@@ -1,6 +1,6 @@
 import { Code } from '../@types/code.js';
 import { Configs } from '../@types/poku.js';
-export declare function poku(targetDirs: string | string[], configs?: Configs): Promise<void>;
 export declare function poku(targetDirs: string | string[], configs: Configs & {
     noExit: true;
 }): Promise<Code>;
+export declare function poku(targetDirs: string | string[], configs?: Configs): Promise<void>;

package/lib/modules/poku.js

@@ -19,9 +19,8 @@ function poku(targetDirs, configs) {
         const dirs = (0, force_array_js_1.forceArray)(targetDirs);
         if (configs === null || configs === void 0 ? void 0 : configs.parallel) {
             const results = yield Promise.all(dirs.map((dir) => (0, run_tests_js_1.runTestsParallel)(dir, configs)));
-            if (results.some((result) => !result)) {
+            if (results.some((result) => !result))
                 code = 1;
-            }
             if (configs === null || configs === void 0 ? void 0 : configs.noExit)
                 return code;
             (0, exit_js_1.exit)(code, configs === null || configs === void 0 ? void 0 : configs.quiet);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "poku",
-  "version": "1.3.0",
-  "description": "🐷 Poku is a flexible and easy-to-use Test Runner for Node.js, Bun and Deno that allows you to run parallel and sequential tests, plus high isolation level per test file",
+  "version": "1.4.0",
+  "description": "🐷 Poku is your test runner pet for Node.js, Bun and Deno, combining flexibility, parallel and sequential runs, human-friendly assertion errors and high isolation level",
   "main": "./lib/index.js",
   "scripts": {
     "test": "npx tsx --tsconfig ./tsconfig.test.json ./test/run.test.ts",
@@ -23,6 +23,7 @@
     "type": "git",
     "url": "git+https://github.com/wellwelwel/poku.git"
   },
+  "homepage": "https://poku.dev",
   "bin": {
     "poku": "./lib/bin/index.js"
   },
@@ -59,6 +60,7 @@
     "tap",
     "tape",
     "karma",
+    "urun",
     "filter",
     "exclude",
     "list",
@@ -66,7 +68,8 @@
     "list-files",
     "tsx",
     "fast",
-    "easy"
+    "easy",
+    "poku"
   ],
   "author": "https://github.com/wellwelwel",
   "bugs": {