Installation & Setup

Prerequisites

• Node.js 18 or later
• @playwright/test ^1.50 (installed alongside Donobu as a peer dependency)

Install

npm install --save-dev donobu @playwright/test

Then download Playwright's browser binaries:

npx playwright install

Configure playwright.config.ts

A minimal configuration that works well with Donobu:

import { defineConfig, devices } from 'donobu';

export default defineConfig({
  testDir: './tests',
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chromium'] },
    },
  ],
  timeout: 180_000, // AI-driven flows can take time — 3 minutes is a safe default
  use: {
    baseURL: 'http://localhost:3000',
    screenshot: 'on', // Capture screenshots for every test (used in reports and self-healing)
    video: 'on', // Capture video for every test
  },
  reporter: [
    ['list', { printSteps: true }],
    ['json', { outputFile: 'test-results/playwright-report.json' }],
  ],
});

Why 180 seconds?

A single page.ai() call may invoke many browser actions (clicks, inputs, navigation, scrolls) in sequence. Setting the timeout too low causes tests to time out during legitimate first runs before the result is cached.

Module systems

Donobu ships both ESM and CommonJS builds. Use whichever your project requires — no extra configuration is needed.

ESM (package.json with "type": "module"):

import { expect, test } from 'donobu';

CommonJS:

const { test, expect } = require('donobu');

Verify the installation

Create a file tests/smoke.test.ts:

import { expect, test } from 'donobu';

test('donobu is installed', async ({ page }) => {
  expect(page.ai).toBeDefined();
});

Run it:

npx donobu test tests/smoke.test.ts

A passing test confirms the installation is working. See Quick Start for a first real test.