Diagnostics
PluginDiagnosticsAPI — canal estructurado de diagnósticos para plugins de Boltdocs con niveles de severidad, cola FIFO y códigos legibles por máquina.
ctx.diagnostics — PluginDiagnosticsAPI
Canal estructurado de diagnósticos. Los plugins envían registros en
lugar de spamear el logger; las herramientas downstream (dev-server
overlay, reportes CI, plugins de IDE) drenan la cola vía list().
ctx.diagnostics.report(
'warn',
'MI_PLUGIN_TRANSFORM_LENTO',
'La transformación tomó 3.2s — considera cachear el resultado',
{ filePath: '/ruta/absoluta/pagina.mdx' },
)
const todos: readonly DiagnosticRecord[] = ctx.diagnostics.list()
ctx.diagnostics.clear()
Forma de DiagnosticRecord
interface DiagnosticRecord {
readonly id: number
readonly severity: 'info' | 'warn' | 'error'
readonly code: string
readonly message: string
readonly pluginName: string
readonly filePath?: string
readonly routePath?: string
readonly time: Date
}
Límite FIFO
La cola está limitada a 256 registros. Cuando un plugin emite más rápido de lo que la overlay del dev-server drena, los registros más antiguos se eliminan silenciosamente.
Ver también
- PluginContext — objeto de contexto base
- Caches — cachés de transformación, rutas y memoria
- Server — middleware HTTP y ciclo de vida del servidor
Last updated on July 27, 2026