playwright-archive/types/config.d.ts

A lightweight CLI tool to archive and serve your Playwright test run history with a web interface. Useful for CI environments and local development.

export interface PlaywrightArchiveConfig {
    /**
     * Server settings
     */
    server?: {
        /** Server port. Default: 3000 */
        port?: number;
        /** Server host. Default: localhost */
        host?: string;
    };
    
    /**
     * Display settings for test report metadata
     */
    display?: {
        /** Hide specific metrics. All metrics are shown by default */
        hideMetrics?: Array<
            | 'workers'     // number of worker processes
            | 'projects'    // number and names of Playwright projects
            | 'duration'    // test execution time
            | 'totalTests'  // total number of tests
            | 'passed'      // number of passed tests
            | 'failed'      // number of failed tests
            | 'skipped'     // number of skipped tests
            | 'flaky'       // number of flaky tests
        >;
        /** Hide passed/failed test names. Names are shown by default */
        hideTestNames?: boolean;
    };

    /**
     * Run results file settings
     */
    runResults?: {
        /** Enable generation of run results file. Default: false */
        enabled?: boolean;
        /** Path where to save the results file. Default: './playwright-results.txt' */
        path?: string;
        /** Format of the results. Default: 'text' */
        format?: 'text' | 'json';
        /** What information to include in the results file */
        include?: Array<
            | 'status'          // overall run status (passed/failed)
            | 'summary'         // test counts (total/passed/failed/skipped)
            | 'duration'        // total run duration
            | 'failedTests'     // list of failed tests
            | 'flakyTests'      // list of flaky tests
            | 'projectStats'    // stats per project
            | 'errorMessages'   // error messages from failed tests
        >;
        /** Custom template for text format. Available variables: {status}, {summary}, {duration}, etc. */
        template?: string;
    };
}