Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wellwelwel/poku
🐷 Poku makes testing easy for Node.js, Bun & Deno at the same time.
https://github.com/wellwelwel/poku
assert assertion bdd bun cli concurrency deno e2e nodejs parallel run runner sequential tdd test testing typescript unit
Last synced: about 2 months ago
JSON representation
🐷 Poku makes testing easy for Node.js, Bun & Deno at the same time.
- Host: GitHub
- URL: https://github.com/wellwelwel/poku
- Owner: wellwelwel
- License: mit
- Created: 2024-02-13T06:36:15.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-01T18:11:34.000Z (5 months ago)
- Last Synced: 2024-05-01T23:41:12.383Z (5 months ago)
- Topics: assert, assertion, bdd, bun, cli, concurrency, deno, e2e, nodejs, parallel, run, runner, sequential, tdd, test, testing, typescript, unit
- Language: TypeScript
- Homepage: https://poku.io
- Size: 3.86 MB
- Stars: 62
- Watchers: 2
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Poku
Enjoying **Poku**? Give him a star to show your support 🌟
[](https://www.npmjs.com/package/poku)
[](https://www.npmjs.com/package/poku)
[](https://github.com/wellwelwel/poku/tree/main/.nycrc)
[](https://github.com/wellwelwel/poku/actions/workflows/ci_coverage-linux.yml?query=branch%3Amain)
[](https://github.com/wellwelwel/poku/actions/workflows/ci_coverage-osx.yml?query=branch%3Amain)
[](https://github.com/wellwelwel/poku/actions/workflows/ci_coverage-windows.yml?query=branch%3Amain)
---
🐷 [Website](https://poku.io/) • 📘 [Documentation](https://poku.io/docs/category/documentation) • 🧪 [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-).
High **isolation** level per file
**Performant** and **lightweight**
Run **CommonJS** files directly with [**Deno**][deno-version-url]
Auto detect **ESM**, **CJS**, and **TypeScript** files
Run the **same test suite** for [**Node.js**][node-version-url], [**Bun**][bun-version-url], and [**Deno**][deno-version-url]
Easily handle **servers**, **processes**, **ports**, and even **containers** ✨
---
## Quickstart
### Install
```bash
# Node.js
npm i -D poku
```
```bash
# TypeScript (Node.js)
npm i -D poku tsx
```
```bash
# Bun
bun add -d poku
```
```bash
# Deno (optional)
deno add npm:poku
```
---
### Test
test/file.test.mjs
```ts
import { assert } from 'poku';
assert(true, 'Poku will describe it 🐷');
```
---
### Run
Node.js (and TypeScript)
Bun
Deno
```bash
npx poku
```
```bash
bunx poku
```
```bash
deno run npm:poku
```
---
## Features
### Essentials
poku
🧪 Test runner.
assert
🔍 Test assertion (Node.js familiar API).
strict
🔬 Strict test assertion (Node.js familiar API).
### Helpers
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
watch
🍿 Watch for changes and re-run related test files.
parallel
🏃🏻♀️ Run tests in parallel.
debug
🕵🏻 Shows all logs.
config
⚙️ Customize your Poku options in a config file.
> _and much more_ 👇🏻
---
## Documentation and Examples
To see the detailed documentation, please visit the [**Documentation**](https://poku.io/docs/category/documentation) and [**Examples**](https://poku.io/docs/category/examples) sections in the [**Poku**'s website](https://poku.io).
---
### Tutorials
**Poku** offers _mini-lessons_ for different users needs in the [**Quick Tutorials**](https://poku.io/docs/category/quick-tutorials) section.
---
### Common Issues
- [Avoiding conflicts in environments with multiple platforms installed](https://poku.io/docs/tutorials/cross-platform#recommendations).
- [Properly running asynchronous tests on the same file](https://poku.io/docs/examples/promises).
- [Using **Poku** without installing on **Deno** and alternatives to **JSR**](https://github.com/wellwelwel/poku/discussions/565).
- [Migrating from version **1.x** to version **2.x**](https://github.com/wellwelwel/poku/issues/533).
---
## Quick Comparisons
### Performance
**Poku** is [continuously tested](https://github.com/wellwelwel/poku/blob/main/.github/workflows/ci_benchmark.yml) to ensure the following expectations for basic usage:
- ~**4x** faster than [**Jest**](https://github.com/jestjs/jest) (v29.7.0)
- ~**3x** faster than [**Vitest**](https://github.com/vitest-dev/vitest) (v1.6.0)
- ~**1x** faster than [**Mocha**](https://github.com/mochajs/mocha) (v10.4.0) + [**Chai**](https://github.com/chaijs/chai) (v5.1.1)
> You can see how the tests are run and compared in the [benchmark](https://github.com/wellwelwel/poku/tree/main/benchmark) directory.
---
### Installation Size
[](https://pkg-size.dev/poku)
- [~**230x** lighter than **Vitest**](https://pkg-size.dev/vitest)
- [~**130x** lighter than **Jest**](https://pkg-size.dev/jest)
- [~**30x** lighter than **Mocha** + **Chai**](https://pkg-size.dev/mocha%20chai)
> **Poku** size is highly significant in development to ensure cost-saving **CI** that require servers that charge for storage and usage.
---
## Security Policy
[](https://github.com/wellwelwel/poku/actions/workflows/ci_codeql.yml?query=branch%3Amain)
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
[](https://github.com/wellwelwel/poku/graphs/contributors)
[](https://opencollective.com/poku/contributors.svg?button=false)
---
## 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 **Poku** [contributors](https://github.com/wellwelwel/poku/graphs/contributors).
[node-version-url]: https://github.com/nodejs/node
[bun-version-url]: https://github.com/oven-sh/bun
[deno-version-url]: https://github.com/denoland/deno