AdGuard Logger

AdGuard Logger is a simple tool designed for logging from AdGuard extensions.

Usage

Installation

yarn add @adguard/logger

Basic Usage

The package supports both CommonJS and ES Module import styles.

const { Logger } = require('@adguard/logger');
// or
import { Logger } from '@adguard/logger';

const logger = new Logger();
logger.info('This is an info message');

The default log level is set to info, meaning that messages at the debug level won't be logged. You can adjust this by setting the log level:

import { Logger, LogLevel } from './Logger';

const logger = new Logger();
logger.currentLevel = LogLevel.Debug;
console.log(logger.currentLevel); // Outputs 'debug'
logger.debug('This is a debug message');

Additionally, you can customize your logging solution by providing your own log writer, rather than relying solely on the default console logger:

import { Logger, LogLevel } from './Logger';

const writeToFile = (...args: any[]) => {
// Implement file writing logic here
};
const writer = {
    log: (...args: any[]): void => {
        writeToFile(...args);
        console.log(...args);
    },
    error: (...args: any[]): void => {
        writeToFile(...args);
        console.error(...args);
    },
    info: (...args: any[]): void => {
        writeToFile(...args);
        console.info(...args);
    },
};
const logger = new Logger(writer);

Trace logging level

This logging level made solely for development purposes, to provided clickable call stack trace in console.

This level works as Debug level, only difference is that for every method of logger it prints with call stack trace. Except error() which already provides call stack trace. In order to make it work these conditions should meet:

• Logging level must be LogLevel.Trace or higher.
• It should not be error() method.
• Writer must have trace() method.

If logging level is LogLevel.Trace or higher and trace() method is not provided with writer it will work as regular LogLevel.Debug level.

Development

To contribute to the development of AdGuard Logger, follow these steps:

Install dependencies

pnpm install

Run tests

pnpm test

Build

pnpm build

Lint

pnpm lint

Limitations

Development of this library was tested only on macOS, so some scripts may not work on Windows.