fock-logger v2.3.1

Logger

Простой вывод выших сообщений в консоль

Установка (Windows, npm)

npm install fock-logger@latest

Примеры

/* Импортируем конфиг, желательно, чтобы он находился вверху импортов */
import { Configurator } from "f-logger";

/* Устанавливаем свои значение в конфиг */
/* Тут мы установили значение date на false, потому что мне лень в примере писать дату */
/* Вы можете устанавливать свои значение, указанные в конфиге */
new Configurator({date: false})

import Logger, { Colors } from "f-logger";

/* dir - Ваша папка, где находится конфиг */
/* loggerName - Название вашего логгера */
const dir = "./";
const loggerName = "The Void"; /* MY-APP-NAME */

/* Первый logger - бесцветный */
/* Второй logger - с цветами, первый цвет - цвет логгера, второй цвет - цвет сообщения */
const loggerNO_COLOR = new Logger(loggerName, {dir});
const loggerCOLOR = new Logger(loggerName, {dir, colors: [Colors.magenta, Colors.reset]});

/* Если вы хотите вывести бесцветное сообщение в чат, просто введите текст */
/* Однако это сработает только при том случае, если в конфиге не будет указано цветов по умолчанию */
loggerNO_COLOR.execute("Hello, World !");
// \u001B[35mThe Void\u001B[0m: \u001B[0mHello, World !\u001B[0m (The Void: Hello, World!)

loggerCOLOR.execute("Hello, World !");
// \u001B[35mThe Void\u001B[0m: \u001B[0mHello, World!\u001B[0m (The Void: Hello, World!)

loggerCOLOR.execute("Hello, World !", Colors.magenta);
// \u001B[35mThe Void\u001B[0m: \u001B[35m0mHello, World!\u001B[0m (The Void: Hello, World!)

config-файл

config-файл называется .loggercfg, его можно создать автоматически:

import { Configurator } from "fock-logger";

new Configurator({create_file: true, dir: "../", level: "info", /* тут могут быть ещё значения из конфига */});

Стандартный файл выглядит так:

{
    "logging": true,
    "dir": "./",
    "level": "info",
    "deletion_interval": 7,
    "date": true,
    "colors": [
        "\u001b[0m",
        "\u001b[0m"
    ],
    "loggers": {
        "Success": {
            "name": "Success",
            "colors": [
                "\u001b[31m",
                "\u001b[32m"
            ]
        },
        "Fail": {
            "name": "Fail",
            "colors": [
                "\u001b[31m",
                "\u001b[31m"
            ]
        }
    }
}

Рассмотрим подробнее

• logging - Булевое значение, если true, то все логи будут выводит, иначе логгер перестанет работать
• dir - Ваша папка, где будет лежать config-файл .loggercfg, и папка log, принимает значения типа: string.
• level - Уровень логирования в консоли, info - Вся информация, warn - Предупреждения, err - Ошибки, принимает значения типа: string.
• deletion_interval - Промежуток удаления лога, принимает значение типа number, отображает количесто дней (Количество дней, после которых лог удалится)
• date - Включает и выключает дату в консоли
• colors - Стандартные цвета для логгера, принимает значения типа: [Colors, Colors].
• loggers - Ваши логгеры, принимает значения типа: LoggersNameType ({[key: string]: {name: string, colors: [Colors, Colors]}}).

Внимание!

• Если у Вас есть файл loggers.json логгеры не будут записываться в конфиг.
• Чтобы их записывать в конфиг, удалите файл loggers.json.
• Или иначе, если Вам конфиг не нужен и Вас устраивают стандартные значение, то ничего не делаете, loggers.json сам создаться с предустановленными настройками.

Если

• Если возникли проблемы или сложности, создайте обсуждение в репозитории
• Если Вы заметили проблемы в коде, пишите мне в Discord или в Telegram