Interface LoggingOptions

interface LoggingOptions {
    enabled?: boolean;
    level?: LogLevel;
    logger?: Logger;
    logTiming?: boolean;
    logViolations?: boolean;
    logProgress?: boolean;
    logFile?: boolean;
    appendToLogFile?: boolean;
}

Properties

enabled? level? logger? logTiming? logViolations? logProgress? logFile? appendToLogFile?

Properties

Optional enabled

enabled?: boolean

Whether to enable logging during check execution

Optional level

level?: LogLevel

Minimum log level to output (defaults to 'info')

Optional logger

logger?: Logger

Custom logger implementation (defaults to console)

Optional logTiming

logTiming?: boolean

Whether to log rule execution start/end times

Optional logViolations

logViolations?: boolean

Whether to log violation details as they are found

Optional logProgress

logProgress?: boolean

Whether to log file processing progress

Optional logFile

logFile?: boolean

If true, logs are written to a file (auto created)

Optional appendToLogFile

appendToLogFile?: boolean

Whether to append to an existing log file (true) or overwrite it (false)

Settings

Member Visibility

Theme

On This Page

enabledlevelloggerlogTiminglogViolationslogProgresslogFileappendToLogFile