poku

Poku

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.

Enjoying Poku? Consider giving him a star ⭐️

---

🐷 Documentation Website • 🔬 Compare Poku with the Most Popular Test Runners

---

Why Poku?

Don't worry about describe, it, beforeEach and everything else 🚀

You don't need to learn what you already know ✨

• Supports ESM and CJS
• Designed to be highly intuitive
• No need to compile TypeScript *
• Compatible with Coverage tools
• Allows both in-code and CLI usage
• Node.js, Bun and Deno compatibility
• Zero configurations, except you want
• Poku adapts to your test, not the other way around
• And much more!

---

• 
• Zero external dependencies 🌱

---

Documentation

• See detailed usage in Documentation section for Poku's CLI, API (in-code) and assert, advanced concepts and much more.

---

Overview

Sequential	Concurrent

• By default, Poku:
  • Searches for all .test. and .spec. files, but you can customize it using the option filter.
  • Uses sequential mode.
• You can use concurrecy by use the flag --parallel for CLI or the option parallel to true in API (in-code) usage.

Follow the same idea for Bun and Deno.

---

Poku also includes the assert method, keeping everything as it is, but providing human readability and automatic describe and it:

Compatible with Node.js, Bun and Deno.

import { assert } from 'poku'; // Node and Bun
import { assert } from 'npm:poku'; // Deno

const actual = '1';

assert(actual, 'My first assert');
assert.deepStrictEqual(actual, 1, 'My first assert error');

Using poku	Using node

• ❌ Both cases finish with code 1, as expected
• 🧑🏻‍🎓 The message param is optional, as it's in Node.js
• 💚 Yes, you can use Poku's assert running node ./my-file.js
• 🐷 Unlike most, Poku adapts to your test, not the other way around

See the complete assert's documentation.

---

Install

Node.js

npm i -D poku

TypeScript (Node.js)

npm i -D poku tsx

Bun

bun add -d poku

Deno

import { poku } from 'npm:poku';

---

Quick Start

In-code

Node.js and Bun

import { poku } from 'poku';

await poku(['targetDir']);

Deno

import { poku } from 'npm:poku';

await poku(['targetDir']);

CLI

npx poku targetDir

bun poku targetDir

deno run npm:poku targetDir

---

To see the detailed documentation, please visit the Documentation section in the Poku's website.

---

Community

I'm continuously working to improve Poku. If you've got something interesting to share, feel free to submit a Pull Request. If you notice something wrong, I'd appreciate if you'd open an Issue.

---

Acknowledgements

• Contributors

Changelog

1.5.0 (2024-02-26)

Features

• assert: automatic describe it (#29) (77c0b54)

Bug Fixes

• filter: include both .test. and .spec. as default (#27) (9172160)