system-logging/README.md

Пакет npm для расширенной записи информации в вашей консоли.

# system-logging `0.0.1`

> Удобный вывод информации в консоль!

## Установка

Npm:
```cmd
npm install system-logging
```

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

Подключите модуль вначале вашего приложения:
```javascript
require('system-logging');
```
## Options

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

### Options.time

В этой опции есть три параметра:
- `normal` - Выводит время в таком стиле 26-03-2019 15:42:23.463. (значение по умолчанию)
- `iso` - Выводит время в формате ISO, например 2019-03-26T14:42:23.463Z
- `none` - Не выводит время.

Пример:
```javascript
require('system-logging')({
    time: 'none'
});

console.log('Вывод без времени!');
```

Результат:

![Результат](https://i.imgur.com/zW3ew99.png)

### Options.pid

Может быть установлено следующее:
- `true` - Добавляет pid процесса по истечении времени. Если это основной процесс, он будет окрашен в фиолетовый цвет. (значение по умолчанию)
- `false` - Удаляет вывод pid.

Пример:
```javascript
require('system-logging')({
    pid: false
});

console.log('Вывод без PID!');
```

Результат:

![Результат](https://i.imgur.com/dKmOVwz.png)

### Options.newline

Может быть установлено следующее:
- `true` - Добавляет перевод строки после всей информации. (значение по умолчанию)
- `false` - Не добавляет перевод строки после всей информации.

Пример:
```javascript
require('system-logging')({
    newline: false
});

console.log('Вывод без новой строки!');
```

Результат:

![Результат](https://i.imgur.com/chaXCYa.png)

### Options.info

Может быть установлено следующее:
- `true` -  Добавит тип вывода (info (зеленый), warn (желтый), error (красный), debug (синий)) после pid. (значение по умолчанию)
- `false` - Не добавляет тип вывода.

Пример:
```javascript
require('system-logging')({
    info: false
});

console.log('Вывод без типа!');
```

Результат:

![Результат](https://i.imgur.com/E7DGFDp.png)

### Options.char

Вы можете изменить его на тот который вы хотите!
- `options.char[0]` - Символ который находится слева от информации. ( По умолчанию `[` )
- `options.char[1]` - Символ который находится справа от информации. ( По умолчанию `]` )

Пример:
```javascript
require('system-logging')({
    char : [ ' -> ' , ' <- ' ]
});

console.log('Вывод с пользовательским символом!');
```

Результат:

![Результат](https://i.imgur.com/Ej5YSSE.png)

### Options.directory_logs 

Сохраняет всю информацию которая выводится в консоль в файл.
- `false` - Не сохраняет вывод в файл.
- `__dirname` - Сохраняет весь вывод консоли в каталоге вашей программы.


Пример:
```javascript
require('system-logging')({
    directory_logs: __dirname
});

console.log('Тест');
```

Результат:

![Результат](https://i.imgur.com/26Oox31.png)
![Результат](https://i.imgur.com/UUZL4Cb.png)

### Options.name_log_file 

Устанавливает имя файла в котором будет сохранятся вся информация которая выводится в консоль.
- `system-logging.log` - По умолчанию.


Пример:
```javascript
require('system-logging')({
    directory_logs: __dirname,
    name_log_file: "testerr-log.log"
});

console.log('Тест');
```

Результат:

![Результат](https://i.imgur.com/fD1H2xW.png)
![Результат](https://i.imgur.com/uNCQy3Y.png)

## Credits

Я использовал готовый модуль от [yologamer123415's log-info](https://www.npmjs.com/package/log-info) и немного изменил его, чтобы появилась возможность сохранять всю информацию (которая выводится в консоль) в файл.