нпмлог

нпмлог

Утилита логгера, которую использует npm.

Этот регистратор очень простой. Он ведет журнал для npm. Он поддерживает пользовательские уровни и цветной вывод.

По умолчанию логи записываются в stderr. Если вы хотите отправлять сообщения журнала на выходы, отличные от потоков, вы можете изменить член log.stream или просто прослушивать события, которые он генерирует, и делать с ними все, что захотите.

Установка

 npm install npmlog --save

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

 var log = require ( 'npmlog' )

// additional stuff ---------------------------+
// message ----------+                         |
// prefix ----+      |                         |
// level -+   |      |                         |
//        v   v      v                         v
    log . info ( 'fyi' , 'I have a kitty cat: %j' , myKittyCat ) 

уровень журнала

• {Нить}

Уровень отображения журналов. Будут отображены все журналы на этом уровне или выше. Специальный уровень silent предотвратит отображение чего-либо.

журнал.запись

• {Множество}

Массив всех введенных сообщений журнала.

log.maxRecordSize

• {Число}

Максимальное количество записей, которые можно сохранить. Если log.record превышает это значение более чем на 10 %, он сокращается до 90 % от этого значения.

Причина использования окна 10% заключается в том, что ему не нужно изменять размер большого массива при каждой записи журнала.

log.prefixStyle

• {Объект}

Объект стиля, определяющий стиль префиксов. (См. ниже)

log.headingStyle

• {Объект}

Объект стиля, определяющий стиль заголовка. (См. ниже)

log.heading

• {String} По умолчанию: ""

Если установлено, заголовок печатается в начале каждой строки.

log.stream

• {Stream} По умолчанию: process.stderr

Поток, в который записывается вывод.

журнал.enableColor()

Принудительно использовать цвета во всех сообщениях, независимо от выходного потока.

журнал.disableColor()

Отключить цвета во всех сообщениях.

журнал.enableProgress()

Включить отображение счетчика активности журнала и индикатора выполнения.

журнал.disableProgress()

Отключить отображение индикатора выполнения

журнал.enableUnicode()

Принудительно использовать тему Unicode для индикатора выполнения.

журнал.disableUnicode()

Отключите использование Юникода в индикаторе выполнения.

log.setGaugeTemplate(шаблон)

Установите шаблон для вывода индикатора выполнения. Подробности смотрите в документации на манометр.

log.setGaugeThemeset(темы)

Выберите набор тем, из которого нужно выбрать темы для индикатора выполнения. Подробности смотрите в документации на манометр.

журнал.пауза()

Прекратите отправлять сообщения в поток, но не удаляйте их.

журнал.резюме()

Выдать все буферизованные сообщения, которые были записаны во время паузы.

log.log(уровень, префикс, сообщение,...)

• level {String} Уровень отправки сообщения
• prefix {String} Префикс строки. Установите значение «», чтобы пропустить.
• message... Аргументы для util.format

Выдать сообщение журнала на указанном уровне.

log[уровень](префикс, сообщение, ...)

Например,

• log.silly(префикс, сообщение,...)
• log.verbose(префикс, сообщение, ...)
• log.info(префикс, сообщение, ...)
• log.http(префикс, сообщение, ...)
• log.warn(префикс, сообщение,...)
• log.error(префикс, сообщение, ...)

Например log.log(level, prefix, message, ...) . Таким образом, каждому уровню присваивается сокращение, поэтому вы можете использовать log.info(prefix, message) .

log.addLevel(уровень, n, стиль, отображение)

• level {String} Индикатор уровня
• n {Number} Числовой уровень
• style {Object} Объект с fg, bg, инверсией и т. д.
• disp {String} Необязательная замена level в выходных данных.

Устанавливает новый уровень с помощью функции сокращения и т. д.

Обратите внимание: если число равно Infinity , то установка этого уровня приведет к подавлению всех сообщений журнала. Если число равно -Infinity , то единственный способ отобразить его — включить все сообщения журнала.

log.newItem(имя, задача, вес)

• name {String} Необязательно; Название элемента прогресса.
• todo {Номер} Необязательно; общий объем работ, которые предстоит выполнить. По умолчанию 0.
• weight {Number} Необязательно; вес этого предмета относительно других. По умолчанию 1.

Это добавляет новый трекер are-we-there-yet » к трекеру прогресса. Возвращенный объект имеет методы log[level] , но в остальном это объект Tracker are-we-there-yet .

log.newStream(имя, задача, вес)

Это добавляет новый трекер потока are-we-there-yet к трекеру прогресса. Возвращенный объект имеет методы log[level] , но в остальном это объект TrackerStream are-we-there-yet .

log.newGroup(имя, вес)

Это добавит новую группу трекеров are-we-there-yet к трекеру прогресса. Возвращенный объект имеет методы log[level] , но в остальном это объект TrackerGroup are-we-there-yet .

События

Все события создаются с помощью объекта сообщения.

• log Выдается для всех сообщений
• log. Выдается для всех сообщений с уровнем .
• Сообщения с префиксами также выдают свой префикс как событие.

Объекты стиля

Объекты стиля могут иметь следующие поля:

• fg {String} Цвет текста переднего плана.
• bg {String} Цвет фона
• bold , inverse , underline {Boolean} Установить связанное свойство
• bell {Boolean} Пошуметь (наверное, это очень раздражает.)

Объекты сообщений

Каждое событие журнала генерируется с объектом сообщения, и список log.record содержит все созданные события. Они имеют следующие поля:

• id {номер}
• level {String}
• prefix {строка}
• message {String} Результат util.format()
• messageRaw {Array} Аргументы для util.format()

Блокировка телетайпа

Мы используем set-blocking для установки блокировки stderr и stdout, если они являются tty и имеют вызов setBlocking. Это обход проблемы в ранних версиях Node.js 6.x, из-за которой stderr и stdout неблокировались в OSX. (Они всегда блокируют Windows и никогда не блокировали Linux.) npmlog требует, чтобы они блокировались, чтобы разрешить чередование вывода на stdout и stderr.