English · Português (BR)
\n\n---\n\n## Quick Start\n\n```bash\nnpm install --save-dev @aleosovski/muitto\n```\n\nCreate your first test:\n\n```typescript\n// sum.test.ts\nimport { describe, it, expect } from \"muitto\";\n\nfunction sum(a: number, b: number): number {\n return a + b;\n}\n\ndescribe(\"sum()\", () => {\n it(\"adds two positive numbers\", () => {\n expect(sum(2, 3)).toBe(5);\n });\n});\n```\n\nRun it:\n\n```bash\nnpx muitto\n```\n\n## Why MUITTO?\n\nMUITTO is for developers who want a test runner that:\n\n- **Gets out of the way** — no config files to fight, no plugins to wire up, no setup wizard\n- **Starts instantly** — zero runtime dependencies means nothing to install beyond the tool itself\n- **Is readable** — the source is written to be understood, not just executed\n- **Just works** — sensible defaults for file discovery, timeouts, and reporting\n\n## Features\n\n| Feature | Description |\n|---------|-------------|\n| ⚡ **Zero Config** | Discovers test files automatically. Works right after install. |\n| 🔄 **Watch Mode** | Re-runs tests on save. Watches the whole project, not just test files. |\n| ✓ **Full Matchers** | `toBe`, `toEqual`, `toThrow`, mock matchers, asymmetric matchers. |\n| ◐ **Mocks & Spies** | `fn()`, `spyOn()`, control returns, resolutions and implementations. |\n| ◷ **Fake Timers** | Control time in tests. Advance timers, run callbacks, no real waiting. |\n| ☙ **Snapshots** | Regression tests persisted to disk, compared across runs and commits. |\n| ▤ **Parameterized** | `it.each` for data-driven tests with auto-generated names. |\n| ▣ **CI Ready** | `json` and `junit` reporters for GitHub Actions, GitLab CI, Jenkins. |\n| ◈ **Visual Diffs** | See exactly what was expected vs received on failure. |\n\n## Installation\n\n### Requirements\n\n- **Node.js** ≥ 18\n- **TypeScript** (any version supported by `tsx`)\n\n### Install\n\n```bash\nnpm install --save-dev @aleosovski/muitto\n```\n\nOr run directly without installing:\n\n```bash\nnpx muitto\n```\n\n### TypeScript Configuration\n\nNo special configuration needed. MUITTO works with your existing `tsconfig.json`.\n\n## Usage\n\n### Run all tests\n\n```bash\nnpx muitto\n```\n\n### Watch mode\n\n```bash\nnpx muitto --watch\n```\n\n### Filter by name\n\n```bash\nnpx muitto --grep \"sum\"\n```\n\n### Run a specific file\n\n```bash\nnpx muitto src/math.test.ts\n```\n\n### Use a different reporter\n\n```bash\nnpx muitto --reporter json --output report.json\n```\n\n### Update snapshots\n\n```bash\nnpx muitto --update-snapshots\n```\n\n## Writing Tests\n\n### Basic Test\n\n```typescript\nimport { describe, it, expect } from \"muitto\";\n\ndescribe(\"math\", () => {\n it(\"adds numbers\", () => {\n expect(1 + 1).toBe(2);\n });\n\n it.skip(\"not ready yet\", () => {\n // This test will be skipped\n });\n});\n```\n\n### Async Tests\n\n```typescript\nit(\"fetches data\", async () => {\n const data = await fetchData();\n expect(data).toEqual({ id: 1 });\n});\n```\n\n### Parameterized Tests\n\n```typescript\nit.each([\n [1, 2, 3],\n [4, 5, 9],\n])(\"sum $1 + $2 = $3\", (a, b, expected) => {\n expect(sum(a, b)).toBe(expected);\n});\n```\n\n### Mocks\n\n```typescript\nimport { fn, spyOn } from \"muitto\";\n\nconst mockFn = fn();\nmockFn.mockReturnValue(42);\n\nexpect(mockFn()).toBe(42);\nexpect(mockFn).toHaveBeenCalled();\n```\n\n### Fake Timers\n\n```typescript\nimport { useFakeTimers } from \"muitto\";\n\nconst timers = useFakeTimers();\nlet called = false;\n\nsetTimeout(() => { called = true; }, 1000);\ntimers.advanceTimersByTime(1000);\n\nexpect(called).toBe(true);\ntimers.restore();\n```\n\n### Snapshots\n\n```typescript\nit(\"user profile\", () => {\n expect(getUserProfile()).toMatchSnapshot({ name: \"user-profile\" });\n});\n```\n\n## API Reference\n\n### Test Functions\n\n| Function | Description |\n|----------|-------------|\n| `describe(name, fn)` | Creates a test suite |\n| `it(name, fn)` | Defines a test case |\n| `it.skip(name, fn)` | Skips a test |\n| `it.only(name, fn)` | Runs only this test |\n| `it.todo(name)` | Registers a placeholder test to write later |\n| `it.each(table)(name, fn)` | Parameterized test |\n\n### Matchers\n\n| Matcher | Description |\n|---------|-------------|\n| `toBe(value)` | Strict equality (`Object.is`) |\n| `toEqual(value)` | Deep equality |\n| `toBeTruthy()` / `toBeFalsy()` | Truthy / falsy check |\n| `toBeNull()` / `toBeUndefined()` | Nullness checks |\n| `toBeGreaterThan(n)` | Numeric comparison |\n| `toContain(item)` | Array/string contains |\n| `toHaveLength(n)` | Has length `n` |\n| `toThrow(msg?)` | Throws exception |\n| `toHaveBeenCalled()` | Mock was called |\n| `toMatchSnapshot(opts?)` | Snapshot comparison |\n\nEvery matcher accepts negation via `.not` — `expect(x).not.toBe(y)`. See the [full documentation](./docs-site/index.html) for the complete matcher set, including asymmetric matchers (`expect.any`, `expect.objectContaining`, etc.).\n\n## Configuration\n\nOptional. Create `.muittorc.json` at your project root:\n\n```json\n{\n \"pattern\": [\"src/**/*.spec.ts\"],\n \"testPathIgnorePatterns\": [\"/fixtures/\"],\n \"timeout\": 10000,\n \"reporter\": \"verbose\",\n \"bail\": false,\n \"updateSnapshots\": false,\n \"globalSetup\": \"./test/global-setup.ts\",\n \"globalTeardown\": \"./test/global-teardown.ts\"\n}\n```\n\n`globalSetup` / `globalTeardown` point at a module (resolved relative to the project root) whose **default export** is a `() => void | PromiseEnglish · Português (BR)
\n\n---\n\n## Início rápido\n\n```bash\nnpm install --save-dev @aleosovski/muitto\n```\n\nCrie seu primeiro teste:\n\n```typescript\n// sum.test.ts\nimport { describe, it, expect } from \"muitto\";\n\nfunction sum(a: number, b: number): number {\n return a + b;\n}\n\ndescribe(\"sum()\", () => {\n it(\"adds two positive numbers\", () => {\n expect(sum(2, 3)).toBe(5);\n });\n});\n```\n\nRode:\n\n```bash\nnpx muitto\n```\n\n## Por que MUITTO?\n\nMUITTO é para quem quer um test runner que:\n\n- **Não atrapalha** — sem arquivo de config pra brigar, sem plugin pra configurar, sem assistente de setup\n- **Sobe instantaneamente** — zero dependências em runtime significa nada pra instalar além da própria ferramenta\n- **É legível** — o código-fonte é escrito para ser entendido, não apenas executado\n- **Simplesmente funciona** — padrões sensatos para descoberta de arquivos, timeouts e relatórios\n\n## Recursos\n\n| Recurso | Descrição |\n|---------|-------------|\n| ⚡ **Zero configuração** | Descobre arquivos de teste automaticamente. Funciona logo após instalar. |\n| 🔄 **Watch mode** | Reexecuta os testes ao salvar. Observa o projeto inteiro, não só os arquivos de teste. |\n| ✓ **Matchers completos** | `toBe`, `toEqual`, `toThrow`, matchers de mock, matchers assimétricos. |\n| ◐ **Mocks & Spies** | `fn()`, `spyOn()`, controle de retornos, resoluções e implementações. |\n| ◷ **Fake Timers** | Controle o tempo nos testes. Avance timers, execute callbacks, sem esperar de verdade. |\n| ☙ **Snapshots** | Testes de regressão persistidos em disco, comparados entre execuções e commits. |\n| ▤ **Parametrizado** | `it.each` para testes orientados a dados, com nomes gerados automaticamente. |\n| ▣ **Pronto para CI** | Reporters `json` e `junit` para GitHub Actions, GitLab CI, Jenkins. |\n| ◈ **Diffs visuais** | Veja exatamente o que era esperado vs. o que foi recebido quando um teste falha. |\n\n## Instalação\n\n### Requisitos\n\n- **Node.js** ≥ 18\n- **TypeScript** (qualquer versão suportada pelo `tsx`)\n\n### Instalar\n\n```bash\nnpm install --save-dev @aleosovski/muitto\n```\n\nOu rode diretamente sem instalar:\n\n```bash\nnpx muitto\n```\n\n### Configuração do TypeScript\n\nNenhuma configuração especial é necessária. O MUITTO funciona com o `tsconfig.json` que você já tem.\n\n## Uso\n\n### Rodar todos os testes\n\n```bash\nnpx muitto\n```\n\n### Modo watch\n\n```bash\nnpx muitto --watch\n```\n\n### Filtrar por nome\n\n```bash\nnpx muitto --grep \"sum\"\n```\n\n### Rodar um arquivo específico\n\n```bash\nnpx muitto src/math.test.ts\n```\n\n### Usar um reporter diferente\n\n```bash\nnpx muitto --reporter json --output report.json\n```\n\n### Atualizar snapshots\n\n```bash\nnpx muitto --update-snapshots\n```\n\n## Escrevendo testes\n\n### Teste básico\n\n```typescript\nimport { describe, it, expect } from \"muitto\";\n\ndescribe(\"math\", () => {\n it(\"adds numbers\", () => {\n expect(1 + 1).toBe(2);\n });\n\n it.skip(\"not ready yet\", () => {\n // Este teste será pulado\n });\n});\n```\n\n### Testes assíncronos\n\n```typescript\nit(\"fetches data\", async () => {\n const data = await fetchData();\n expect(data).toEqual({ id: 1 });\n});\n```\n\n### Testes parametrizados\n\n```typescript\nit.each([\n [1, 2, 3],\n [4, 5, 9],\n])(\"sum $1 + $2 = $3\", (a, b, expected) => {\n expect(sum(a, b)).toBe(expected);\n});\n```\n\n### Mocks\n\n```typescript\nimport { fn, spyOn } from \"muitto\";\n\nconst mockFn = fn();\nmockFn.mockReturnValue(42);\n\nexpect(mockFn()).toBe(42);\nexpect(mockFn).toHaveBeenCalled();\n```\n\n### Fake Timers\n\n```typescript\nimport { useFakeTimers } from \"muitto\";\n\nconst timers = useFakeTimers();\nlet called = false;\n\nsetTimeout(() => { called = true; }, 1000);\ntimers.advanceTimersByTime(1000);\n\nexpect(called).toBe(true);\ntimers.restore();\n```\n\n### Snapshots\n\n```typescript\nit(\"user profile\", () => {\n expect(getUserProfile()).toMatchSnapshot({ name: \"user-profile\" });\n});\n```\n\n## Referência da API\n\n### Funções de teste\n\n| Função | Descrição |\n|----------|-------------|\n| `describe(name, fn)` | Cria uma suíte de testes |\n| `it(name, fn)` | Define um caso de teste |\n| `it.skip(name, fn)` | Pula um teste |\n| `it.only(name, fn)` | Roda apenas esse teste |\n| `it.todo(name)` | Registra um placeholder para escrever o teste depois |\n| `it.each(table)(name, fn)` | Teste parametrizado |\n\n### Matchers\n\n| Matcher | Descrição |\n|---------|-------------|\n| `toBe(value)` | Igualdade estrita (`Object.is`) |\n| `toEqual(value)` | Igualdade profunda |\n| `toBeTruthy()` / `toBeFalsy()` | Checagem de truthy / falsy |\n| `toBeNull()` / `toBeUndefined()` | Checagens de nulidade |\n| `toBeGreaterThan(n)` | Comparação numérica |\n| `toContain(item)` | Array/string contém |\n| `toHaveLength(n)` | Tem comprimento `n` |\n| `toThrow(msg?)` | Lança exceção |\n| `toHaveBeenCalled()` | Mock foi chamado |\n| `toMatchSnapshot(opts?)` | Comparação com snapshot |\n\nTodo matcher aceita negação via `.not` — `expect(x).not.toBe(y)`. Veja a [documentação completa](./docs-site/index.html) para o conjunto completo de matchers, incluindo matchers assimétricos (`expect.any`, `expect.objectContaining`, etc.).\n\n## Configuração\n\nOpcional. Crie um `.muittorc.json` na raiz do projeto:\n\n```json\n{\n \"pattern\": [\"src/**/*.spec.ts\"],\n \"testPathIgnorePatterns\": [\"/fixtures/\"],\n \"timeout\": 10000,\n \"reporter\": \"verbose\",\n \"bail\": false,\n \"updateSnapshots\": false,\n \"globalSetup\": \"./test/global-setup.ts\",\n \"globalTeardown\": \"./test/global-teardown.ts\"\n}\n```\n\n`globalSetup` / `globalTeardown` apontam para um módulo (resolvido em relação à raiz do projeto) cuja **exportação padrão** é uma função `() => void | Promise