poku 0.1.0 → 1.0.0

package/README.md

@@ -1,19 +1,41 @@
+[npm-image]: https://img.shields.io/npm/v/poku.svg?color=f78fb3
+[npm-url]: https://npmjs.org/package/poku
+[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&color=badc58
+[license-url]: https://github.com/wellwelwel/poku/blob/main/LICENSE
+[license-image]: https://img.shields.io/npm/l/poku.svg?maxAge=2592000&color=3dc1d3
+[node-version-image]: https://img.shields.io/node/v/poku.svg?color=ffb142
+[node-version-url]: https://nodejs.org/en/download
+
 # Poku
 
 <img align="right" width="128" height="128" alt="Logo" src=".github/assets/readme/poku.svg">
 
-🖇️ A flexible and user-friendly **Test Runner** which allows parallel runs and high isolation level.
+🖇️ A flexible and easy-to-use **Test Runner** for parallel or sequential runs and high isolation level.
 
-> - **Poku** is designed to be highly intuitive.<br />
-> - Compatible with **ESM** and **CJS**, **Node.js** and **TypeScript** (_no-build_).<br />
-> - From **Node.js 6** to the **Latest** release.<br />
-> - Totally dependency-free.
+[![NPM Version][npm-image]][npm-url]
+[![Node.js Version][node-version-image]][node-version-url]
+[![GitHub Workflow Status (with event)][ci-image]][ci-url]
+[![License][license-image]][license-url]
 
 ---
 
-## In progress
+## Why Poku?
+
+🪄 Runs test files in an individual process, shows progress and exits.<br/>
+
+- **Poku** is designed to be highly intuitive.<br />
+- Supports **Node.js 6+** (_ESM_ and _CJS_), **TypeScript** (_no need to build_) and **Coverage** tools.<br />
+- **Poku** dive to the deepest depths to find tests in the specified directories.
+- No constraints or rules, code in your own signature style.
+- Zero configurations, except you want.
+- Allows both **in-code** and **CLI** usage.
+
+---
 
-🧑🏻‍🔧 Soon releasing version `1.x`.
+- Totally **dependency-free**.
+- **Compatibility:** **Poku** is tested across all **Node 6+** versions.
+- **Poku** uses itself to test its own tests using `process.exit` at several depths on the same process node.
 
 ---
 
@@ -25,22 +47,147 @@ npm install --save-dev poku
 
 ---
 
-## Usage
+## Basic Usage
+
+## In-code
 
 ```ts
 import { poku } from 'poku';
 
-await poku(['./test/unit/']);
+await poku(['./a', './b']);
+```
+
+### CLI
 
-// 🧑🏻‍🔧 Soon documenting all options and Poku's usage variations.
+```bash
+npx poku --include='./a,./b'
 ```
 
 ---
 
-## TypeScript
+### TypeScript
 
 To run your tests without compile, just install `tsx` and it's done:
 
 ```bash
 npm install --save-dev tsx
 ```
+
+---
+
+## Documentation
+
+### `poku`
+
+#### Include directories
+
+```ts
+poku('./targetDir');
+```
+
+```ts
+poku(['./targetDirA', './targetDirB']);
+```
+
+```bash
+npx poku --include='./targetDir'
+```
+
+```bash
+npx poku --include='./targetDirA,./targetDirB'
+```
+
+---
+
+#### `filter`
+
+> 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 --include='...' --filter='some-file'
+```
+
+```bash
+# Testing only paths that contains "unit"
+
+npx poku --include='...' --filter='unit'
+```
+
+- **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 --include='...'
+```
+
+```bash
+# Testing only paths that contains "unit"
+
+FILTER='unit' npx poku --include='...'
+```
+
+---
+
+#### `parallel`
+
+Determines the mode of test execution across **parallelism** or **sequential** modes.
+
+```ts
+/**
+ * @default
+ *
+ * Sequential mode
+ */
+
+poku(['...'], {
+  parallel: false,
+});
+```
+
+```ts
+/**
+ * Parallel mode
+ */
+
+poku(['...'], {
+  parallel: true,
+});
+```
+
+---
+
+## Documentation in Progress
+
+> 🧑🏻‍🎓 Soon documenting all options and **Poku**'s usage variations.

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

@@ -21,16 +21,21 @@ export type Configs = {
         fail?: boolean;
     };
     /**
-     * This option overwrites all `log` settings
+     * This option overwrites all `log` settings.
      *
      * @default false
      */
     quiet?: boolean;
     /**
-     * Filter by path to match only the files that should be performed
+     * Filter by path to match only the files that should be performed.
      *
      * @default /\.test\./i
      */
     filter?: RegExp;
+    /**
+     * Determines the mode of test execution.
+     *
+     * @default false
+     */
     parallel?: boolean;
 };

package/lib/bin/index.d.ts

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+export {};

package/lib/bin/index.js

@@ -0,0 +1,12 @@
+#! /usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const escape_reg_exp_js_1 = require("../helpers/escape-reg-exp.js");
+const get_arg_js_1 = require("../helpers/get-arg.js");
+const index_js_1 = require("../index.js");
+const rawDirs = (0, get_arg_js_1.getArg)('include');
+const rawFilter = (0, get_arg_js_1.getArg)('filter');
+const dirs = (rawDirs === null || rawDirs === void 0 ? void 0 : rawDirs.split(',')) || [];
+(0, index_js_1.poku)(dirs, {
+    filter: rawFilter ? new RegExp((0, escape_reg_exp_js_1.escapeRegExp)(rawFilter)) : undefined,
+});

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

@@ -0,0 +1 @@
+export declare const getArg: (arg: string) => string | undefined;

package/lib/helpers/get-arg.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getArg = void 0;
+const [, , ...args] = process.argv;
+const getArg = (arg) => {
+    var _a;
+    const getArg = args.find((a) => a.startsWith(`--${arg}=`));
+    if (getArg)
+        return ((_a = getArg.split('=')) === null || _a === void 0 ? void 0 : _a[1]) || undefined;
+    return undefined;
+};
+exports.getArg = getArg;

package/lib/index.d.ts

@@ -1,2 +1,4 @@
 export { poku } from './modules/poku.js';
 export { exit } from './modules/exit.js';
+export type { Code } from './@types/code.js';
+export type { Configs } from './@types/poku.js';

package/lib/modules/poku.js

@@ -18,17 +18,13 @@ function poku(targetDirs, configs) {
         let code = 0;
         const dirs = (0, force_array_js_1.forceArray)(targetDirs);
         if (configs === null || configs === void 0 ? void 0 : configs.parallel) {
-            for (const dir of dirs) {
-                (0, runTests_js_1.runTestsParallel)(dir, configs).then((result) => {
-                    if (!result)
-                        code = 1;
-                });
+            const results = yield Promise.all(dirs.map((dir) => (0, runTests_js_1.runTestsParallel)(dir, configs)));
+            if (results.some((result) => !result)) {
+                code = 1;
             }
-            process.on('beforeExit', () => {
-                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);
-            });
+            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);
             return;
         }
         for (const dir of dirs) {

package/lib/services/runTests.d.ts

@@ -1,3 +1,3 @@
 import { Configs } from '../@types/poku.js';
 export declare const runTests: (dir: string, configs?: Configs) => Promise<boolean>;
-export declare const runTestsParallel: (dir: string, configs?: Configs) => Promise<unknown>;
+export declare const runTestsParallel: (dir: string, configs?: Configs) => Promise<boolean>;

package/lib/services/runTests.js

@@ -55,31 +55,27 @@ const runTests = (dir, configs) => __awaiter(void 0, void 0, void 0, function* (
     return passed;
 });
 exports.runTests = runTests;
-const runTestsParallel = (dir, configs) => {
+const runTestsParallel = (dir, configs) => __awaiter(void 0, void 0, void 0, function* () {
     const cwd = process.cwd();
     const testDir = path_1.default.join(cwd, dir);
     const files = (0, getFiles_js_1.getFiles)(testDir, undefined, configs);
     const showLogs = !(0, logs_js_1.isQuiet)(configs);
-    let passed = true;
-    return new Promise((resolve) => {
-        for (let i = 0; i < files.length; i++) {
-            const filePath = files[i];
-            const fileRelative = path_1.default.relative(cwd, filePath);
-            (0, runTestFile_js_1.runTestFile)(filePath, configs).then((testPassed) => {
-                const command = `${(0, runner_js_1.runner)(fileRelative)} ${fileRelative}`;
-                const log = command;
-                if (testPassed) {
-                    showLogs &&
-                        console.log(`${indentation_js_1.indentation.test}${format_js_1.format.success('✔')} ${log}`);
-                }
-                else {
-                    showLogs &&
-                        console.log(`${indentation_js_1.indentation.test}${format_js_1.format.fail('✖')} ${log}`);
-                    passed = false;
-                }
-            });
-            resolve(passed);
+    const promises = files.map((filePath) => __awaiter(void 0, void 0, void 0, function* () {
+        const fileRelative = path_1.default.relative(cwd, filePath);
+        const testPassed = yield (0, runTestFile_js_1.runTestFile)(filePath, configs);
+        const command = `${(0, runner_js_1.runner)(fileRelative)} ${fileRelative}`;
+        if (testPassed) {
+            showLogs &&
+                console.log(`${indentation_js_1.indentation.test}${format_js_1.format.success('✔')} ${command}`);
         }
-    });
-};
+        else {
+            showLogs &&
+                console.log(`${indentation_js_1.indentation.test}${format_js_1.format.fail('✖')} ${command}`);
+            return false;
+        }
+        return true;
+    }));
+    const results = yield Promise.all(promises);
+    return results.every((result) => result);
+});
 exports.runTestsParallel = runTestsParallel;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "poku",
-  "version": "0.1.0",
-  "description": "🐷 This is Poku",
+  "version": "1.0.0",
+  "description": "🐷 A flexible and easy-to-use Test Runner for parallel or sequential runs and high isolation level",
   "main": "./lib/index.js",
   "scripts": {
     "test": "npx tsx --tsconfig ./tsconfig.test.json ./test/run.test.ts",
@@ -12,6 +12,7 @@
     "update": "npx npu; npm run init",
     "prebuild": "rm -rf ./lib",
     "build": "npx tsc",
+    "postbuild": "npm audit",
     "eslint:checker": "npx eslint . --ext .js,.ts",
     "eslint:fix": "npx eslint . --fix --config ./.eslintrc.json",
     "prettier:checker": "npx prettier --check .",
@@ -22,17 +23,34 @@
     "type": "git",
     "url": "git+https://github.com/wellwelwel/poku.git"
   },
+  "bin": {
+    "poku": "./lib/bin/index.js"
+  },
   "keywords": [
     "test",
+    "testing",
     "runner",
-    "isolate"
+    "run",
+    "isolate",
+    "isolation",
+    "concurrent",
+    "concurrency",
+    "parallelism",
+    "parallel",
+    "sequential",
+    "unit",
+    "integration",
+    "typescript",
+    "filter",
+    "queue",
+    "queuing"
   ],
   "author": "https://github.com/wellwelwel",
   "bugs": {
     "url": "https://github.com/wellwelwel/poku/issues"
   },
   "engines": {
-    "node": ">=6.x"
+    "node": ">=6.0.0"
   },
   "files": [
     "lib"

package/lib/src/@types/code.d.ts

@@ -1 +0,0 @@
-export type Code = 0 | 1;

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

@@ -1,36 +0,0 @@
-export type Configs = {
-    /**
-     * By setting `true`, **Poku** won't exit the process and will return the exit code (`0` or `1`).
-     *
-     * You can combine this option with **Poku**'s `exit` method or just use the result, for example, in `process.exit(code)`.
-     *
-     * @default false
-     */
-    noExit?: boolean;
-    /**
-     * Customize `stdout` options.
-     */
-    log?: {
-        /**
-         * @default false
-         */
-        success?: boolean;
-        /**
-         * @default true
-         */
-        fail?: boolean;
-    };
-    /**
-     * This option overwrites all `log` settings
-     *
-     * @default false
-     */
-    quiet?: boolean;
-    /**
-     * Filter by path to match only the files that should be performed
-     *
-     * @default /\.test\./i
-     */
-    filter?: RegExp;
-    parallel?: boolean;
-};

package/lib/src/helpers/escape-reg-exp.d.ts

@@ -1 +0,0 @@
-export declare const escapeRegExp: (string: string) => string;

package/lib/src/helpers/filter.d.ts

@@ -1 +0,0 @@
-export declare const filter: RegExp | null;

package/lib/src/helpers/force-array.d.ts

@@ -1 +0,0 @@
-export declare const forceArray: <T>(input: T | T[]) => T[];

package/lib/src/helpers/format.d.ts

@@ -1,8 +0,0 @@
-export declare const format: {
-    counter: (current: number, total: number, pad?: string) => string;
-    bold: (value: string) => string;
-    underline: (value: string) => string;
-    info: (value: string) => string;
-    success: (value: string) => string;
-    fail: (value: string) => string;
-};

package/lib/src/helpers/getFiles.d.ts

@@ -1,2 +0,0 @@
-import { Configs } from '../@types/poku.js';
-export declare const getFiles: (dirPath: string, files?: string[], configs?: Configs) => string[];

package/lib/src/helpers/hr.d.ts

@@ -1 +0,0 @@
-export declare const hr: () => void;

package/lib/src/helpers/indentation.d.ts

@@ -1,4 +0,0 @@
-export declare const indentation: {
-    test: string;
-    stdio: string;
-};

package/lib/src/helpers/logs.d.ts

@@ -1,4 +0,0 @@
-import { Configs } from '../@types/poku.js';
-export declare const isQuiet: (configs?: Configs) => boolean;
-export declare const showSuccesses: (configs?: Configs) => boolean;
-export declare const showFailures: (configs?: Configs) => boolean;

package/lib/src/helpers/pad.d.ts

@@ -1,4 +0,0 @@
-/**
- * Custom implementations of `padStart` for compatibility with Node.js version 6.
- */
-export declare const padStart: (str: string, targetLength: number, padString: string) => string;

package/lib/src/helpers/runner.d.ts

@@ -1 +0,0 @@
-export declare const runner: (filename: string) => "tsx" | "node";

package/lib/src/index.d.ts

@@ -1,2 +0,0 @@
-export { poku } from './modules/poku.js';
-export { exit } from './modules/exit.js';

package/lib/src/modules/exit.d.ts

@@ -1,2 +0,0 @@
-import { Code } from '../@types/code.js';
-export declare const exit: (code: Code, quiet?: boolean) => never;

package/lib/src/modules/poku.d.ts

@@ -1,6 +0,0 @@
-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>;

package/lib/src/services/runTestFile.d.ts

@@ -1,2 +0,0 @@
-import { Configs } from '../@types/poku.js';
-export declare const runTestFile: (filePath: string, configs?: Configs) => Promise<boolean>;

package/lib/src/services/runTests.d.ts

@@ -1,3 +0,0 @@
-import { Configs } from '../@types/poku.js';
-export declare const runTests: (dir: string, configs?: Configs) => Promise<boolean>;
-export declare const runTestsParallel: (dir: string, configs?: Configs) => Promise<unknown>;

package/lib/test/ci.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-06.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-07.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-08.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-09.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-10.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-11.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-12.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-13.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-14.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-15.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-16.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-17.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-18.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-19.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-20.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/compatibility/node-21.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/helpers/check-node.test.d.ts

@@ -1 +0,0 @@
-export declare const checkNode: (version: number) => Promise<number>;

package/lib/test/integration/code.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/integration/import.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/run.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/unit/pad.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/unit/runTestFile.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/unit/runTests.test.d.ts

@@ -1 +0,0 @@
-export {};