+[**English**](https://poku.io/docs) | [**Português (BR)**](https://poku.io/pt-BR/docs)
+
**Poku** is your Test Runner Pet for [**Node.js**][node-version-url], [**Bun**][bun-version-url] and [**Deno**][deno-version-url].
[![Node.js Version][node-version-image]][node-version-url]
@@ -47,6 +49,7 @@ By creating **Poku**, my aim is to show that testing can be simpler 🌱
- No configurations
- Supports **ESM** and **CJS**
- High **isolation** level per file
+- **Poku** is [**100%** documented](https://poku.io/docs)
- Zero external dependencies
- **Parallel** and **Sequential** runs
- Designed to be highly intuitive
diff --git a/website/docs/index.mdx b/website/docs/index.mdx
index fb5f2573..196dee18 100644
--- a/website/docs/index.mdx
+++ b/website/docs/index.mdx
@@ -217,7 +217,7 @@ Please check the [**SECURITY.md**](https://github.com/wellwelwel/poku/blob/main/
## Acknowledgements
-[](https://github.com/wellwelwel/poku/graphs/contributors)
+[](https://github.com/wellwelwel/poku/graphs/contributors)
+ +### Criando o arquivo de teste + +> _test/index.test.ts_ + +```ts +import { assert } from 'poku'; + +assert.deepStrictEqual('1', 1, 'Número não deve ser uma string'); +``` + +
+ +### Executando o teste + +```bash +npx poku +``` + +
+ +É isso 🎉 + +:::tip + +O **Poku** não usa **`describe`** ou **`it`**, visto que a mensagem já está no **`assert`**. + +- O **`assert`** do **Poku** é apenas uma abstração do **`assert`** original do **Node.js**.
+- Isso significa: **Sem necessidade de novos aprendizados** 🎉 + +::: + +Adote um **Poku** pra você 🩵 + +
+ +### Configurando o TypeScript + +> Adicione no seu _tsconfig.json_ + +```json +{ + "compilerOptions": { + "esModuleInterop": true + } +} +``` + +
+ +### Configurando o Jest + +> _jest.config.js_ + +```js +export default { + preset: 'ts-jest', + testEnvironment: 'node', + testMatch: ['**/test/**/*.test.ts'], +}; +``` + +
+ +### Criando o arquivo de teste + +> _test/index.test.ts_ + +```ts +describe('Comparação de Tipos', () => { + test('Número não deve ser uma string', () => { + expect('1').toStrictEqual(1); + }); +}); +``` + +
+ +### Executando o teste + +```bash +npx jest +``` + +
+ +### Configurando o Mocha + +> _.mocharc.json_ + +```json +{ + "require": "tsx", + "extension": ["ts"], + "spec": "./test/**/*.test.ts" +} +``` + +
+ +### Criando o arquivo de teste + +> _test/index.test.ts_ + +```ts +import { expect } from 'chai'; + +describe('Comparação de Tipos', () => { + it('Número não deve ser uma string', () => { + expect('1').to.deep.equal(1); + }); +}); +``` + +
+ +### Executando o teste + +```bash +npx mocha +``` + +
+ +### Configurando o Vitest + +> _vitest.config.ts_ + +```ts +import { defineConfig } from 'vitest/config'; + +export default defineConfig({ + test: { + include: ['test/**/*.test.ts'], + globals: true, + environment: 'node', + }, +}); +``` + +
+ +### Criando o arquivo de teste + +> _test/index.test.ts_ + +```ts +import { describe, it, expect } from 'vitest'; + +describe('Comparação de Tipos', () => { + it('Número não deve ser uma string', () => { + expect('1').toStrictEqual(1); + }); +}); +``` + +
+ +### Executando o teste + +```bash +npx vitest run +``` + +
+Por favor, envie um _PR_ se você souber como chegar a essa abordagem. + +- Relacionado: [avajs/ava#3308](https://github.com/avajs/ava/discussions/3308). + +::: + +### Instalação + +```bash +npm i -D ava tsx +``` + +> ~26M + +
+ +### Configurando o AVA + +> Include in the _package.json_: + +```json +{ + "ava": { + "files": ["test/**/*.test.ts"], + "extensions": { + "ts": "commonjs" + }, + "nodeArguments": ["--import=tsx"] + } +} +``` + +
+ +### Criando o arquivo de teste + +> _test/index.test.ts_ + +```ts +import test from 'ava'; + +test('Número não deve ser uma string', (t) => { + t.deepEqual('1', 1); +}); +``` + +
+ +### Executando o teste + +```bash +npx ava +``` + +
+It supports both [**Bun**][bun-version-url] and [**Deno**][deno-version-url]. + +[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 + +- [**Node.js**][node-version-url], [**Bun**][bun-version-url] and [**Deno**][deno-version-url] compatible. + +> The `assert` is used to write tests and verify if your code works as expected by comparing values and throwing errors, otherwise 🧑🏻🎓 +> +> _Since **1.3.0**_ + +## Migrating to **Poku**'s `assert` + +_But only if you want to, of course._ + +
+Your **Poku** is waiting for you 🐷✨ +::: + +
+ +## Available methods + +```ts +import { assert, assertPromise } from 'poku'; +``` + +> You can combine promise **assert** with beforeEach and afterEach helpers. + +- `assert(value[, message])` +- `assert.deepEqual(actual, expected[, message])` +- `assert.deepStrictEqual(actual, expected[, message])` +- `assert.doesNotMatch(string, regexp[, message])` +- `assert.doesNotReject(asyncFn[, error][, message])` +- `assert.doesNotThrow(fn[, error][, message])` +- `assert.equal(actual, expected[, message])` +- `assert.fail([message])` +- `assert.ifError(value)` +- `assert.match(string, regexp[, message])` +- `assert.notDeepEqual(actual, expected[, message])` +- `assert.notDeepStrictEqual(actual, expected[, message])` +- `assert.notEqual(actual, expected[, message])` +- `assert.notStrictEqual(actual, expected[, message])` +- `assert.ok(value[, message])` +- `assert.rejects(asyncFn[, error][, message])` +- `assert.strictEqual(actual, expected[, message])` +- `assert.throws(fn[, error][, message])` + +You can follow the [**assert documentation**](https://nodejs.org/api/assert.html) from **Node.js**'s documentation. + +:::info + +To use `assert` with **TypeScript**, you may will need to instal **@types/node**: + +```bash +npm i -D @types/node +``` + +::: diff --git a/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/_category_.json b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/_category_.json new file mode 100644 index 00000000..cc6797db --- /dev/null +++ b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Helpers", + "collapsed": false, + "link": { + "type": "generated-index" + } +} diff --git a/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/before-after-each/_category_.json b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/before-after-each/_category_.json new file mode 100644 index 00000000..93043d1d --- /dev/null +++ b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/before-after-each/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "beforeEach and afterEach", + "collapsed": true, + "link": { + "type": "generated-index" + }, + "position": 2 +} diff --git a/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/before-after-each/in-code.mdx b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/before-after-each/in-code.mdx new file mode 100644 index 00000000..cce908f0 --- /dev/null +++ b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/before-after-each/in-code.mdx @@ -0,0 +1,255 @@ +--- +sidebar_position: 2 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# In-Code + +## How can I combine `beforeEach`, `afterEach` and `assert`? + +Both `beforeEach`, `afterEach` are recommended for tests that consume a particular global state for each test.
+For example, by populating or resetting a database before and/or after multiple assertions. + +### See how Poku solve it 🧙🏻 + +
+ +:::info +Although it also works with `parallel` runs, it's strongly discouraged to use these features for sequential tests. +::: diff --git a/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/describe.mdx b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/describe.mdx new file mode 100644 index 00000000..8fc16509 --- /dev/null +++ b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/documentation/helpers/describe.mdx @@ -0,0 +1,124 @@ +--- +sidebar_position: 1 +--- + +import { FAQ } from '@site/src/components/FAQ'; +import Example from '@site/static/img/describe-example.png'; + +# describe + +On **Poku**, `describe` is just a pretty `console.log` to title your test suites in the terminal. + +```ts +import { describe, assert } from 'poku'; + +describe('Group A'); +assert(true, '1'); +assert(true, '2'); + +describe('Group B'); +assert(true, '1'); +assert(true, '2'); +``` + +## Personalization + +> `describe(title: string, options?: DescribeOptions)` + +### pad + +Skips a line before to console it. + +```ts +import { describe, assert } from 'poku'; + +describe('Group A', { pad: true }); +assert.ok(true, '1'); +assert.ok(true, '2'); +``` + +### background + +Change the background color for your personal title. + +> Set `false` to disable it. + +```ts +import { describe, assert } from 'poku'; + +describe('Group A', { background: 'blue' }); +assert.ok(true, '1'); +assert.ok(true, '2'); +``` + +
+ +## Overview + +
+