@kabanooovd/loggertool
v1.1.0
Published
A simple logging tool for development
Downloads
335
Maintainers
Readme
LoggerTool
Небольшой инструмент для разработки, который заменяет обычные console.log, console.warn и console.error на именованные логгеры с визуальными маркерами и цветами.
Основная идея — быстро находить нужные логи в большом количестве вывода. Вместо поиска среди сотен console.log можно искать конкретный логгер, например arrowGold или arrowError.
Все логгеры начинаются со стрелки ==> (кроме arrowResult, у которого стрелка <=, и arrowFinal с двойной стрелкой ==> ==>).
Установка
npm install @kabanooovd/loggertoolUsage
import {
arrowLog,
arrowWarn,
arrowError,
arrowSuccess,
arrowGold,
arrowInfo,
arrowDebug,
arrowBold,
arrowNote,
arrowDeprecated,
arrowAlert,
arrowInverse,
arrowDone,
arrowSend,
arrowReceive,
arrowProcess,
arrowAccent,
arrowResult,
arrowFinal,
} from "@kabanooovd/loggertool";
arrowLog("Обычное сообщение");
arrowWarn("Предупреждение");
arrowError("Ошибка");
arrowSuccess("Успешно!");
arrowGold("Важное событие");
arrowInfo("Информация");
arrowDebug("Отладка");
arrowBold("Важное выделенное сообщение");
arrowNote("Заметка");
arrowDeprecated("Устаревшее");
arrowAlert("Внимание!");
arrowInverse("Инверсия");
arrowDone("Готово");
arrowSend("Отправлено");
arrowReceive("Получено");
arrowProcess("В процессе...");
arrowAccent("Акцент");
arrowResult("Результат");
arrowFinal("Всё завершено!");Логгеры
Базовые
| Функция | Вид | Назначение |
| ---------------- | -------------------------------------- | ----------------------------------- |
| arrowLog | обычный текст | Обычные сообщения |
| arrowWarn | чёрный текст на оранжевом фоне | Предупреждения |
| arrowError | чёрный текст на красном фоне | Ошибки |
| arrowSuccess | зелёный текст | Успешные операции |
| arrowGold | золотой текст | Важные события / специальные условия|
Информационные
| Функция | Вид | Назначение |
| ---------------- | -------------------------------------- | ----------------------------------- |
| arrowInfo | голубой (cyan) текст | Информационные сообщения |
| arrowDebug | приглушённый серый текст | Отладочный вывод |
| arrowNote | курсив, magenta | Заметки и пояснения |
Акценты и стили
| Функция | Вид | Назначение |
| ---------------- | -------------------------------------- | ----------------------------------- |
| arrowBold | жирный, подчёркнутый, белый | Максимально важные сообщения |
| arrowAccent | жирный, magenta | Акценты |
| arrowInverse | инвертированные цвета (reverse) | Обратный контраст |
| arrowAlert | мигающий, жирный, красный | Привлечение внимания (если терминал поддерживает blink) |
Статусы и процессы
| Функция | Вид | Назначение |
| ---------------- | -------------------------------------- | ----------------------------------- |
| arrowDone | чёрный текст на зелёном фоне, жирный | Задача завершена |
| arrowSend | чёрный текст на голубом фоне | Отправка данных |
| arrowReceive | чёрный текст на пурпурном фоне | Получение данных |
| arrowProcess | белый текст на синем фоне | Процесс выполняется |
| arrowDeprecated| зачёркнутый серый | Устаревшие / не рекомендуемые вызовы|
Результаты и финал
| Функция | Вид | Назначение |
| ---------------- | -------------------------------------- | ----------------------------------- |
| arrowResult | жирный зелёный, стрелка <= | Результат / ответ |
| arrowFinal | жирный зелёный, двойная стрелка ==> ==> | Финальное сообщение |
Палитра
Цвета текста
| Name | ANSI code | Пример |
| --------- | ---------------- | ---------- |
| reset | \x1b[0m | Сброс |
| green | \x1b[32m | 🟢 Green |
| gold | \x1b[38;5;214m | 🟡 Gold |
| red | \x1b[31m | 🔴 Red |
| yellow | \x1b[33m | 🟡 Yellow |
| blue | \x1b[34m | 🔵 Blue |
| magenta | \x1b[35m | 🟣 Magenta |
| cyan | \x1b[36m | 🔵 Cyan |
| white | \x1b[37m | ⚪ White |
| gray | \x1b[90m | ⚫ Gray |
| black | \x1b[30m | ⚫ Black |
Фоны
| Name | ANSI code | Пример |
| ----------- | ---------------- | --------------- |
| bgRed | \x1b[41m | 🔴 Red bg |
| bgGreen | \x1b[42m | 🟢 Green bg |
| bgBlue | \x1b[44m | 🔵 Blue bg |
| bgMagenta | \x1b[45m | 🟣 Magenta bg |
| bgCyan | \x1b[46m | 🔵 Cyan bg |
| bgWhite | \x1b[47m | ⚪ White bg |
| bgOrange | \x1b[48;5;214m | 🟠 Orange bg |
Стили
| Name | ANSI code | Эффект |
| --------------- | ----------- | --------------- |
| bold | \x1b[1m | Жирный |
| dim | \x1b[2m | Приглушённый |
| italic | \x1b[3m | Курсив |
| underline | \x1b[4m | Подчёркнутый |
| blink | \x1b[5m | Мигающий |
| reverse | \x1b[7m | Инвертированный |
| strikethrough | \x1b[9m | ~~Зачёркнутый~~ |
Примечания
- Мигание (
blink) поддерживается не всеми терминалами. В VS Code, например, оно может не работать — используйтеarrowAlertтолько если уверены в поддержке. arrowWarnиarrowErrorиспользуютconsole.logвместоconsole.warn/console.error, так как последние игнорируют ANSI-коды фона в Node.js.
