Por que usar o Poku?
Ao criar o Poku, meu objetivo é mostrar que tests podem ser simples 🌱
Vamos tornar os describe
, beforeEach
e tudo mais ainda mais fáceis 🚀
🔬 Comece vendo como usar o
assert
🧪 Então aprenda a usar opoku
no terminal para executar todos seus arquivos de uma vez só
🧙🏻 Finalmente, apenas se você quiser, se aprofunde no aprendizado completo do Poku🩵 Leve seu tempo
Començando
Instale 📦
- Node.js
- TypeScript (Node.js)
- Bun
- Deno
npm i -D poku
npm i -D poku tsx
bun add -d poku
deno add npm:poku
Teste 🔬
- test/file.test.mjs
import { assert } from 'poku';
assert(true, 'Poku irá descrever isso 🐷');
- Troque a extensão de
.mjs
para.js
ao definir"type": "module"
em seu package.json. - Note que os exemplos são baseados em ESM, mas você pode usar CJS normalmente.
Execute 🚀
- Node.js and TypeScript (Node.js)
- Bun
- Deno
npx poku
bun poku
deno run npm:poku
Poku requer as seguintes as seguintes permissões por padrão:
--allow-read
--allow-env
--allow-run
É isso 🎉
Métodos Disponíveis
Essenciais
- poku (test runner)
- assert (testes de asserção)
- startScript (execute scripts do
package.json
em segundo plano) - startService (execute arquivos em segundo plano)
Auxiliares
test
beforeEach
eafterEach
describe
elog
listFiles
exit
Documentação
Inicialmente, a documentação e exemplos são baseados no Node.js e ESM, mas você pode usar tudo normalmente para Bun e Deno, além do CJS.
Comunidade
Eu estou continuamente trabalhando para melhorar o Poku. Se você tem algo interessante para compartilhar, sinta-se à vontade para submeter um Pull Request. Se você percebeu algo estranho, eu apreciaria se você abrisse um Issue.
Contribuindo
Verifique o CONTRIBUTING.md para instruções 🚀
Licença
Poku está sob a Licença do MIT.
Política de Segurança
Verifique o SECURITY.md e a seção O Poku é Seguro? na Documentation.
Agradecimentos
Author
@wellwelwel