@coursebuilder/core/src/lib/utils/logger.ts

Core package for Course Builder

import { CourseBuilderError } from '../../errors.js'

export type WarningCode =
	| 'debug-enabled'
	| 'env-url-basepath-redundant'
	| 'env-url-basepath-mismatch'

export interface LoggerInstance extends Record<string, Function> {
	warn: (code: WarningCode) => void
	error: (error: Error) => void
	debug: (message: string, metadata?: unknown) => void
}

const red = '\x1b[31m'
const yellow = '\x1b[33m'
const grey = '\x1b[38;5;246m'
const reset = '\x1b[0m'

export const logger: LoggerInstance = {
	error(error) {
		const name = error instanceof CourseBuilderError ? error.type : error.name
		console.error(
			`${red}[coursebuilder][error]${reset} ${name}: ${error.message}`,
		)
		if (
			error.cause &&
			typeof error.cause === 'object' &&
			'err' in error.cause &&
			error.cause.err instanceof Error
		) {
			const { err, ...data } = error.cause
			console.error(`${red}[coursebuilder][cause]${reset}:`, err.stack)
			if (data)
				console.error(
					`${red}[coursebuilder][details]${reset}:`,
					JSON.stringify(data, null, 2),
				)
		} else if (error.stack) {
			console.error(error.stack.replace(/.*/, '').substring(1))
		}
	},
	warn(code) {
		const url = `https://warnings.coursebuilder.dev#${code}`
		console.warn(
			`${yellow}[coursebuilder][warn][${code}]${reset}`,
			`Read more: ${url}`,
		)
	},
	debug(message, metadata) {
		console.log(
			`${grey}[coursebuilder][debug]:${reset} ${message}`,
			JSON.stringify(metadata, null, 2),
		)
	},
}

/**
 * Override the built-in logger with user's implementation.
 * Any `undefined` level will use the default logger.
 */
export function setLogger(
	newLogger: Partial<LoggerInstance> = {},
	debug?: boolean,
) {
	// Turn off debug logging if `debug` isn't set to `true`
	if (!debug) logger.debug = () => {}

	if (newLogger.error) logger.error = newLogger.error
	if (newLogger.warn) logger.warn = newLogger.warn
	if (newLogger.debug) logger.debug = newLogger.debug
}