poku

Poku

Poku can show you how simple testing can be 🌱

Enjoying Poku? Give him a star to show your support ⭐️

---

Why does Poku exist?

Poku takes on the testers' difficulties by itself and lets you focus on the tests.

No configurations
      Auto detect ESM and CJS
      Auto detect Typescript files
      Run the same test suite for Node.js, Bun and Deno

Easier and Less Verbose
      Node.js familiar API
      Easily test your server just by running it 🚀
      Run CJS (CommonJS) files directly with Deno
      Easily handle services, servers, processes and ports

Safety and Reliability
      High isolation level per file
      Performant and lightweight
      Compatible with Coverage tools
      Poku doesn't use eval nor global state 🔐
           In other words, you can run your tests directly, without relying on Poku

---

Quickstart

Install

Node.js	TypeScript + Node.js	Bun	Deno
npm i -D poku	npm i -D poku tsx	bun add -d poku	deno add npm:poku

Test

test/file.test.mjs

import { assert } from 'poku'; assert(true, 'Poku will describe it 🐷');

Run

Node.js (and TypeScript)	Bun	Deno
npx poku	bunx poku	deno run npm:poku

That's it 🎉

---

🐷 Documentation  •  🧪 Examples  •  🔬 Compare the Most Popular Test Runners

---

Available Methods

Essentials

• Test
  • poku (test runner)
  • assert (test assertion)
• Background Services
  • startScript (run package.json scripts in a background process)
  • startService (run files in a background process)

Helpers

• test
• describe and it
• beforeEach and afterEach
• Processes
  • kill (terminate Ports, Port Ranges and PIDs)
  • getPIDs (get all processes IDs using ports and port ranges)
• and much more ✨

---

Documentation and Examples

To see the detailed documentation, please visit the Documentation and Examples sections in the Poku's website.

---

Contributing

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.

Please check the CONTRIBUTING.md for instructions 🚀

---

Philosophy

Please check the Philosophy section from Documentation.

---

Security Policy

Please check the SECURITY.md and the section Is Poku Safe? from Documentation.

---

Quick Comparisons

Performance

Poku is continuously tested (CI) to ensure the following expectations:

• ~4x faster than Jest (v29.7.0)
• ~3x faster than Vitest (v1.6.0)
• ~1x faster than Mocha (v10.4.0) + Chai (v5.1.1)

You can see how the tests are run and compared in the benchmark directory.

---

Installation Size

• ~175x lighter than Jest
• ~302x lighter than Vitest
• ~44x lighter than Mocha + Chai

---

Limitations

• Poku community is gradually building up 🤝
• Although it has no external dependencies, Poku is not all-in-one, so it doesn't have features such as mocks and spies, where you can use your favorite packages or native solutions.

---

Acknowledgements

---

License

Poku is under the MIT License.

Changelog

1.15.0 (2024-06-10)

Features

• cli: show individual and total test execution times (#359) (56f08d0)
• cli: show paths and options when using --debug (#358) (1c0da5c)
• describe: support for Node.js familiar API usage (#353) (b423a7e)
• it: support for Node.js familiar API usage (#354) (c7b2b48)
• test: support for Node.js familiar API usage (#352) (1c425e1)

Bug Fixes

• logs: improve output for test, describe and it (#357) (a6facf0)
• perf: improve validations, recursions, logs and imports (#346) (89bcac3)