Информация

Маленькая и простая библиотека для форматированного логирования и ввода команд в консоль для вашего NodeJs приложения.

Возможности доступные Вам:

• Создание собственных команд для Вашего приложения.
• Логирование с использованием цветового обозначения (успешно, внимание, ошибка, информация, вторичный текст).

Удобства:

• Ввод консоли имеет временную отметку которая не бросается в глаза.
• Имеет адаптивность, если вывод в консоль слишком длинный, то он автоматически перенесется на новую строчку не смешиваясь с другой информацией.

Установка

Установите библиотеку в свой проект в качестве зависимости:

mkdir project_name
cd project_name
npm init -y
npm i --save ds-console

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

Логирование

Подключите библиотеку к своему проекту и напишите свой первый hello world!:

const Console = require('ds-console');

Console.log('Этот текст написан для проверки обработки текста. Данный метод принимает не только строку, а также булевые значения: ', true, false, 'цифры: ', 1, 2, 3, 'и объекты:', {
  test: 'test',
  ban: 'ban',
}, 'info');

Обычная команда

const Console = require('ds-console');

Console.cmd('ping', () => {
  Console.log('pong');
});

> ping
console => [00:44:32] pong

Команда с использованием арг-флага

const Console = require('ds-console');

Console.cmd('ping', (arg) => {
  if (arg.flags.view){
    Console.log('pong');
  }
});

> ping --view
console => [00:44:32] pong
> ping
console => 

Команда с использованием арг-значения

const Console = require('ds-console');

Console.cmd('ping', (arg) => {
  if (arg.values.view == 'yes'){
    Console.log('pong');
  }
});

> ping --view=yes
console => [00:44:32] pong
> ping
console => 

Вы так же можете добавить описание своей команде (для команды help)

const Console = require('ds-console');

Console.cmd('ping', {
  description: 'pong'
}, () => {
  Console.log('pong');
});

или

const Console = require('ds-console');

Console.cmd('ping', 'Это описание', () => {
  Console.log('pong');
});

[!CAUTION] Обработчик команд определяет название команды по введенному аргументу, т.е. если внесете в описание всего 1 слово, то последний внесенный аргумент будет считаться названием

Неправельная команда ping

const Console = require('ds-console');

Console.cmd('ping', 'pong', () => {
  Console.log('pong');
});

Дополнительно

Вы также можете вызвать Chalk напрямую из нашей библиотеки:

const Chalk = require('ds-console').chalk;