# Poku Enjoying **Poku**? Give him a star to show your support 🌟 [![Version](https://img.shields.io/npm/v/poku?label=&color=70a1ff&logo=npm&logoColor=white)]() [![Downloads](https://img.shields.io/npm/dm/poku?label=&logo=npm&logoColor=white&color=45aaf2)]() [![CI](https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/ci_coverage-linux.yml?event=push&label=&branch=main&logo=testcafe&logoColor=white&color=9c88ff)]() [![Coverage](https://img.shields.io/codecov/c/github/wellwelwel/poku?label=&logo=codecov&logoColor=white&color=98cc00)]() --- 🐷 [**Website**](https://poku.io/) • 📘 [**Documentation**](https://poku.io/docs) • 🧪 [**Examples**](https://poku.io/docs/category/examples) • 🧑🏻‍🎓 [**Tutorials**](https://poku.io/docs/category/quick-tutorials)

--- ## Why does Poku exist? 💡 **Poku** is a cross-platform test runner that brings the [**JavaScript** essence back to testing](https://poku.io/docs/philosophy#javascript-essence-for-tests-). ![v][] High **isolation** level per file
![v][] **Performant** and **lightweight**
![v][] Support for **ESM**, **CJS**, and **TypeScript**
![v][] Plugin ecosystem for **custom** and **official** plugins
![v][] Run the **same test suite** for **Node.js**, **Bun**, and **Deno**
![v][] Easily handle **servers**, **processes**, **ports**, and **containers** ✨ --- ## Quickstart ### ![v][] Install #### 🐢 Node.js ```sh npm i -D poku ``` #### 📘 TypeScript (Node.js) ```sh npm i -D poku tsx ``` #### 🍞 Bun ```sh bun add -d poku ``` #### 🦕 Deno (optional) ```sh deno add npm:poku ``` --- ### ![v][] Test ```ts import { assert } from 'poku'; assert(true, 'Poku will describe it 🐷'); ``` --- ### ![v][] Run #### Node.js (and TypeScript) ```sh npx poku ``` #### Bun ```sh bun --bun poku ``` #### Deno ```sh deno run npm:poku ``` --- ## Features ### ![v][] Essentials

poku	🧪 Test runner
assert • strict	🔬 Test assertion (Node.js* familiar API)*

### ![v][] Common Helpers and Options

test • describe • it	🤹🏻‍♀️ Organize, group, and isolate tests
envFile	⚙️ Process an environment file
beforeEach • afterEach	🃏 Hooks for test setup and teardown
startScript • startService	🌐 Run scripts and files in background
docker	🐳 Build, start, compose, stop, and remove containers
kill	🔌 Terminate ports, port ranges, and PIDs
waitForPort	😴 Wait for specified ports to become active
waitForExpectedResult	🥱 Retry until an expected result or times out
skip	⏭️ Skip tests when necessary
only	🌌 Debug tests by enabling selective runs
coverage	☔️ Enable coverage collection
config	⚙️ Customize your Poku
watch	🍿 Watch for changes and re-run related test files
debug	🕵🏻 Shows all logs

- _and much more_ 🔥 --- ### FAQ - [Properly running asynchronous tests on the same file](https://poku.io/docs/examples/promises) - Migrating: - [**3.x.x** → **4.x.x**](https://github.com/wellwelwel/poku/issues/1006) --- ## Quick Comparisons ### Performance - ~**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. --- ### Installation Size [![Install Size](https://packagephobia.com/badge?p=poku)](https://pkg-size.dev/poku) - [~**145x** lighter than **Jest**](https://pkg-size.dev/jest@30.4.2) - [~**124x** lighter than **Vitest**](https://pkg-size.dev/vitest@4.1.6) - [~**2.8x** 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. --- ## Security Policy Please check the [**SECURITY.md**](https://github.com/wellwelwel/poku/blob/main/SECURITY.md). --- ## Contributing See the [**Contributing Guide**](https://github.com/wellwelwel/poku/blob/main/CONTRIBUTING.md) and please follow our [**Code of Conduct**](https://github.com/wellwelwel/poku/blob/main/CODE_OF_CONDUCT.md) 🚀 --- ## Acknowledgements ### Contributors My thanks to everyone who has dedicated their time and effort to improving **Poku**. [![Contributors](https://opencollective.com/poku/contributors.svg?width=890&button=false)]() ### Sponsors Really thanks to everyone who has supported and keeps supporting my work. [![Sponsors](https://wellwelwel.github.io/wellwelwel/sponsors.svg?v=1)](https://github.com/sponsors/wellwelwel) --- ## License **Poku** is under the [**MIT License**](https://github.com/wellwelwel/poku/blob/main/LICENSE).
Copyright © 2024-present [**Weslley Araújo**](https://github.com/wellwelwel) and [**contributors**](https://github.com/wellwelwel/poku/graphs/contributors). [v]: https://raw.githubusercontent.com/wellwelwel/poku/main/.github/assets/readme/check.svg