Tugboat QA config.yml

Configuration file for Tugboat QA

Type object
File match **/.tugboat/config.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/tugboat-qa-config-yml/latest.json
Source https://raw.githubusercontent.com/TugboatQA/docs/refs/heads/main/static/config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Schema for Tugboat QA config.yml

Properties

services object required

A list of service configurations

All of: variant

Definitions

screenshotConfig object
enabled boolean

Whether to render Screenshots for the URLs defined for this Service

Default: true
fullPage boolean

Whether to use the default fullPage method. Disabling this uses an alternative that is more friendly to elements that have vh CSS Styles, but can sometimes be less accurate

Default: true
timeout integer

How long to wait for a page to be ready when taking a screenshot, in seconds. Minimum: 1, Maximum: 60

min=1max=60
waitUntil string | string[]

Which browser event(s) to wait for before creating a screenshot of the page. If multiple events are specified, the screenshot is created after all events have fired

visualDiffConfig object
enabled boolean

Whether to render Screenshots for the URLs defined for this Service

Default: true
fullPage boolean

Whether to use the default fullPage method. Disabling this uses an alternative that is more friendly to elements that have vh CSS Styles, but can sometimes be less accurate

Default: true
timeout integer

How long to wait for a page to be ready when taking a screenshot, in seconds. Minimum: 1, Maximum: 60

min=1max=60
waitUntil string | string[]

Which browser event(s) to wait for before creating a screenshot of the page. If multiple events are specified, the screenshot is created after all events have fired

threshold integer | object

The maximum allowed difference between two screenshots before considering them different. Can be a single value for all screen types, or specific values per screen type

lighthouseConfig object

Configuration options to control Lighthouse's behavior

extends string

Base configuration to extend from. Currently only 'lighthouse:default' is supported

Values: "lighthouse:default"
settings object

Global settings that control how Lighthouse runs and what audits it includes

3 nested properties
onlyCategories string[]

Only run the specified categories. If both onlyCategories and onlyAudits are present, onlyCategories takes precedence

onlyAudits string[]

Only run the specified audits. If both onlyCategories and onlyAudits are present, onlyCategories takes precedence

skipAudits string[]

Skip the specified audits. Takes precedence over onlyAudits and onlyCategories

passes object[]

Controls how to load the page and what information to gather about it. Each pass loads the page with different settings and gathers different information

audits string[]

List of audit IDs to run. Only audits referenced by a category will appear in the report

categories object

Categories group audit results into sections in the report. Each category is organized by a set of audit references with their individual scores and grouped by audit groups

groups object

Groups organize audits in categories into expandable sections

commandGroup string | string[]