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
      Don't export your server (just run it) 🚀
      Run the same test suite for Node.js, Bun and Deno.

Safety and Reliability
      High isolation level per file
      Compatible with Coverage tools
      Run CJS (CommonJS) files directly with Deno
      Easily handle services, servers, processes and ports
      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)
• Processes
  • kill (terminate Ports, Port Ranges and PIDs)
  • getPIDs (get all processes IDs using ports and port ranges)

Helpers

• beforeEach and afterEach
• test
• describe
• and much more ✨

---

Documentation and Examples

To see the detailed documentation, please visit the Documentation and Examples sections 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.

---

Contributing

Please check the CONTRIBUTING.md for instructions 🚀

---

Philosophy

Please check the Philosophy section from Documentation.

---

License

Poku is under the MIT License.

---

Security Policy

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

---

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.

---

Overview

Sequential	Concurrent

---

Acknowledgements

---

Author

@wellwelwel

Changelog

1.14.1 (2024-06-05)

Bug Fixes

• cli: improve performance and indentation (#333) (5efe7d0)
• cli: show external errors without requiring debugging (#335) (f954089)