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 src/common/util/logger.ts:12

Methods

debug

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

info

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

warn

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

error

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

getLogFilePath

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

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

isEnabled

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

startCheck

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

endCheck

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

logViolation

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

logProgress

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

logMetric

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

logFileProcessing

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