poku

Poku

Enjoying Poku? Give him a star to show your support 🌟

---

🐷 Website  •  📘 Documentation  •  🧪 Examples  •  🧑🏻‍🎓 Quick Tutorials

---

Why does Poku exist?

💡 Poku makes testing easy and brings the native JavaScript syntax back to tests, letting you to write tests intuitively.

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

Easier and Less Verbose
      Run CJS (CommonJS) files directly with Deno
      Easily handle containers, servers, processes, and ports

Safety and Reliability
      High isolation level per file
      Performant and lightweight

---

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

---

Features

Essentials

Name	Description
poku	🧪 Test runner.
assert	🔍 Test assertion (Node.js familiar API).
strict	🔬 Strict test assertion (Node.js familiar API).

Helpers

Name	Description
test • describe • it	🤹🏻‍♀️ Organize, group, and isolate tests.
envFile	⚙️ Process an environment file (out-of-box).
beforeEach • afterEach	🃏 Hooks for test setup and teardown.
startScript	🌐 Run package.json scripts in background.
startService	🌐 Run files in background.
docker	🐳 Build, start, compose, stop, remove, and test 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.
getPIDs	🕵🏻 Debug processes IDs using ports and port ranges.

Common Options

Name	Description
watch	🍿 Watch for changes and re-run related test files.
parallel	🏃🏻‍♀️ Run tests in parallel.
debug	🕵🏻 Shows all logs.

and much more 👇🏻

---

Documentation and Examples

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

---

Tutorials

Poku offers mini-lessons for different users needs in the Quick Tutorials section.

---

Common Issues

• Avoiding conflicts in environments with multiple platforms installed.
• Properly running asynchronous tests on the same file.
• Migrating to version 2.x.

---

Contributing

See the Contributing Guide and please follow our Code of Conduct 🚀

---

Security Policy

Please check the SECURITY.md.

---

Quick Comparisons

Performance

Poku is continuously tested to ensure the following expectations for basic usage:

• ~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

• ~300x lighter than Vitest
• ~170x lighter than Jest
• ~40x lighter than Mocha + Chai

Poku size is highly significant in development to ensure cost-saving CI that require servers that charge for storage and usage.

---

Limitations

• Although it has no external dependencies, Poku is not all-in-one, so it doesn't have integrated features such as mocks, spies, coverage reports, etc., where you can use your favorite packages or native solutions.
  • See a mock example.
• Poku doesn't render components (such as Angular, React, etc.).
  • See an end-to-end test example.
• Our community is gradually building up.

---

Acknowledgements

---

License

Poku is under the MIT License.

Changelog

2.0.0 (2024-07-11)

⚠ BREAKING CHANGES

• drop beforeEach and afterEach support for each assert (#539)
• drop assertPromise helper (#538)
• change listFiles helper from sync to async (#537)
• drop deprecated methods and options (#536)
• drop support for Node.js 6 and 7 (#534)

Features

• support for strict assertions (#541) (68dae82)

Miscellaneous Chores

• change listFiles helper from sync to async (#537) (945c4fb)
• drop assertPromise helper (#538) (954ca1b)
• drop beforeEach and afterEach support for each assert (#539) (a8455a7)
• drop deprecated methods and options (#536) (ae6ff4b)
• drop support for Node.js 6 and 7 (#534) (a11b1b4)