Class CheckLogger

CheckLogger is designed to output logging information during the execution of architectural checks. It creates a single log file per instance and supports both console and file logging.

Implements

Logger

Index

Constructors

Methods

debug info warn error getLogFilePath isEnabled startCheck endCheck logViolation logProgress logMetric logFileProcessing

Constructors

constructor

new CheckLogger(): CheckLogger
Returns CheckLogger
- Defined in common/util/logger.ts:12

Methods

debug

debug(
    options: LoggingOptions | undefined,
    message: string,
    ...args: unknown[],
): void
Parameters
- options: LoggingOptions | undefined
- message: string
- ...args: unknown[]
Returns void
Implementation of Logger.debug
- Defined in common/util/logger.ts:94

info

info(
    options: LoggingOptions | undefined,
    message: string,
    ...args: unknown[],
): void
Parameters
- options: LoggingOptions | undefined
- message: string
- ...args: unknown[]
Returns void
Implementation of Logger.info
- Defined in common/util/logger.ts:111

warn

warn(
    options: LoggingOptions | undefined,
    message: string,
    ...args: unknown[],
): void
Parameters
- options: LoggingOptions | undefined
- message: string
- ...args: unknown[]
Returns void
Implementation of Logger.warn
- Defined in common/util/logger.ts:124

error

error(
    options: LoggingOptions | undefined,
    message: string,
    ...args: unknown[],
): void
Parameters
- options: LoggingOptions | undefined
- message: string
- ...args: unknown[]
Returns void
Implementation of Logger.error
- Defined in common/util/logger.ts:137

getLogFilePath

getLogFilePath(): string
Gets the path to the log file for this logger instance

Returns string
- Defined in common/util/logger.ts:157

isEnabled

isEnabled(): boolean
Returns boolean
- Defined in common/util/logger.ts:162

startCheck

startCheck(ruleName: string, options?: LoggingOptions): void
Parameters
- ruleName: string
- Optionaloptions: LoggingOptions
Returns void
- Defined in common/util/logger.ts:165

endCheck

endCheck(
    ruleName: string,
    violationCount: number,
    options?: LoggingOptions,
): void
Parameters
- ruleName: string
- violationCount: number
- Optionaloptions: LoggingOptions
Returns void
- Defined in common/util/logger.ts:169

logViolation

logViolation(violation: string, options?: LoggingOptions): void
Parameters
- violation: string
- Optionaloptions: LoggingOptions
Returns void
- Defined in common/util/logger.ts:177

logProgress

logProgress(message: string, options?: LoggingOptions): void
Parameters
- message: string
- Optionaloptions: LoggingOptions
Returns void
- Defined in common/util/logger.ts:181

logMetric

logMetric(
    metricName: string,
    value: number,
    threshold?: number,
    options?: LoggingOptions,
): void
Parameters
- metricName: string
- value: number
- Optionalthreshold: number
- Optionaloptions: LoggingOptions
Returns void
- Defined in common/util/logger.ts:184

logFileProcessing

logFileProcessing(
    fileName: string,
    matchedRules: number,
    options?: LoggingOptions,
): void
Parameters
- fileName: string
- matchedRules: number
- Optionaloptions: LoggingOptions
Returns void
- Defined in common/util/logger.ts:196