kaiwyvern.notes
← Заметки

logger

plugins/sys/logger/main.js

В загрузчике плагинов десятки модулей пишут в одну консоль. Логгер существует, чтобы быстро ответить на один вопрос: какой модуль напечатал эту строку.

Один вызов, без лишних аргументов

Каждый модуль создаёт логгер при импорте и передаёт import.meta.url. Путь обрезается и становится префиксом, поэтому на месте вызова чисто: log.info('...') без повторения имени модуля.

export function createLogger(moduleUrl) {
    const path = moduleUrl.replace('https://plugins/', '');
    const prefix = `[${path}]`;
    const colorName = MODULE_COLORS[path];
    const color = colorName && COLORS[colorName] ? COLORS[colorName] : '';

    return {
        debug: (msg, ...args) => console.debug(`${COLORS.gray}${prefix}${COLORS.reset} ${msg}`, ...args),
        info:  (msg, ...args) => console.log(`${color}${prefix}${COLORS.reset} ${msg}`, ...args),
        warn:  (msg, ...args) => console.warn(`${COLORS.yellow}${prefix}${COLORS.reset} ${msg}`, ...args),
        error: (msg, ...args) => console.error(`${COLORS.red}${prefix}${COLORS.reset} ${msg}`, ...args)
    };
}

Почему у уровня фиксированный цвет

Уровень закодирован дважды: методом консоли (чтобы работал фильтр в DevTools) и цветом (чтобы глаз цеплялся при прокрутке). Серый отдан debug — он читается, но не спорит с предупреждениями.

const COLORS = {
    reset: '\x1b[0m',  red: '\x1b[31m',  green: '\x1b[32m',
    yellow: '\x1b[33m', blue: '\x1b[34m', magenta: '\x1b[35m',
    cyan: '\x1b[36m',  white: '\x1b[37m', gray: '\x1b[90m'
};

Таблица модулей

Цвета не случайны: они по папкам. Точки входа (index.js) — жёлтые, сервисные модули — синие, мелкие хелперы — голубые, низкоуровневые библиотеки — пурпурные или серые. Одна папка — один цвет, поэтому поток строк можно отнести к области, не читая пути.

const MODULE_COLORS = {
    'module/index.js': 'yellow',
    'module/push/main.js': 'blue',

    'sys/logger/main.js': 'gray',
    'sys/gamestate/main.js': 'blue',
    'sys/gamestate/LCUX/mode.js': 'cyan',

    'ui-shared/main.js': 'gray'
};

Неизвестный модуль

Если пути нет в таблице, логгер всё равно работает: color становится пустой строкой, префикс печатается без цвета. Новый модуль не ломает логирование — он просто выглядит обычным, пока кто-нибудь не добавит цвет.

Использование

import { createLogger } from 'https://plugins/sys/logger/main.js';

const log = createLogger(import.meta.url);

log.info('shim started');          // [sys/gamestate/LCUX/mode.js] shim started
log.warn('socket is missing');     // жёлтый
log.error('failed to parse', e);   // красный + объект ошибки