Hints options | Doc Detective

Options for the post-run hints feature. After a test run, Doc Detective may print one short, contextual hint with code samples and links to encourage further engagement (for example, suggesting a CI workflow when none is detected). Doc Detective displays hints only in an interactive terminal (TTY) and only at the default info log level.

Referenced In

config

Fields

Field	Type	Description	Default
enabled	boolean	Required. If `true` (the default), Doc Detective may print one applicable hint after a test run. Disable from the CLI with `--no-hints`.	`true`

Examples

{
  "enabled": true
}