@dev-build-deploy/diagnose-it/lib/parser.d.ts

Expressive Diagnostics library

import { DiagnosticsMessage } from "./diagnosticsMessage";
import * as sarif from "@dev-build-deploy/sarif-it";
/**
 * Extracts Expressive Diagnostic messages from SARIF.
 *
 * NOTE: currently we only support:
 *   - plain text files
 *   - the results of the last run
 *
 * @param sarif The SARIF to extract messages from.
 * @param run Index of run, defaults to the last run.
 *
 * @returns Async Generator of Expressive Messages.
 */
export declare function extractFromSarif(sarif: sarif.Log, run?: number | undefined): Generator<DiagnosticsMessage, void, unknown>;
/**
 * Extracts Expressive Diagnostic messages from a file.
 * This can be used to extract messages from compile output
 *
 * @param filePath Path to file to extract messages from.
 * @returns Async Generator of Expressive Messages.
 *
 * @see https://clang.llvm.org/diagnostics.html
 */
export declare function extractFromFile(filePath: string): AsyncGenerator<DiagnosticsMessage, void, unknown>;