reporter

Specify the reporter for test execution.

History

Version	Changes
v3.0.3-canary.a1456563	Remove verbose reporter. Its behavior is now the default in the poku reporter.

Reporters

poku (default)

• Logs all describe, it, test and assert titles and messages, including their modifiers.
• Logs errors both in real time and at the running end.

dot (inspired by Mocha)

• Logs a dot for each success file test and F for each failed file.
• Lists all logs for each failed file at the running end.

compact (partially inspired by modern Tap)

• Lists only file paths with PASS or FAIL and, in case of failures, lists all logs for each failed file at the running end.

focus

• Logs only errors (in real time). If there is no error, it just logs a small footnote resume.

classic

• The standard report style from version 2 to preserve our history 🐷

---

Usage

CLI

poku

npx poku --reporter=poku # default

dot

npx poku --reporter=dot

compact

npx poku --reporter=compact

focus

npx poku --reporter=focus

classic

npx poku --reporter=classic

• Short flag: -r.

Config File

poku

{
  // "$schema": "https://poku.io/schemas/configs.json",
  "reporter": "poku" // default
}

const { defineConfig } = require('poku');

module.exports = defineConfig({
  reporter: 'poku', // default
});

dot

{
  // "$schema": "https://poku.io/schemas/configs.json",
  "reporter": "dot"
}

const { defineConfig } = require('poku');

module.exports = defineConfig({
  reporter: 'dot',
});

compact

{
  // "$schema": "https://poku.io/schemas/configs.json",
  "reporter": "compact"
}

const { defineConfig } = require('poku');

module.exports = defineConfig({
  reporter: 'compact',
});

focus

{
  // "$schema": "https://poku.io/schemas/configs.json",
  "reporter": "focus"
}

const { defineConfig } = require('poku');

module.exports = defineConfig({
  reporter: 'focus',
});

classic

{
  // "$schema": "https://poku.io/schemas/configs.json",
  "reporter": "classic"
}

const { defineConfig } = require('poku');

module.exports = defineConfig({
  reporter: 'classic',
});

API

poku

await poku('./test', {
  reporter: 'poku', // default
});

dot

await poku('./test', {
  reporter: 'dot',
});

compact

await poku('./test', {
  reporter: 'compact',
});

focus

await poku('./test', {
  reporter: 'focus',
});

classic

await poku('./test', {
  reporter: 'classic',
});

---

dica

• To create a custom reporter, see Custom Reporters.
• To debug, see debug option.
• To quiet the output, see quiet option.
• Both the --debug and --quiet options work with all reporters.