bellman - npm Package Compare versions

Comparing version 1.1.10 to 1.1.11

package.json

@@ -5,3 +5,3 @@ {
   "license": "MIT",
-  "version": "1.1.10",
+  "version": "1.1.11",
   "description": "Yet another console logger. A pretty and powerful one, though.",
@@ -8,0 +8,0 @@ "homepage": "https://github.com/nskazki/bellman",

README.md

@@ -1,16 +0,19 @@
-# bellman
+# Bellman
 
-Аккуратный консольныый логгер.
+Yet another console logger. A pretty and powerful one, though.
 
-```bash
-npm i bellman
 ```
+yarn add bellman
+```
 
-### Public methods
-* `reg` - Служит для регистрации файлов, в которух будут вызванны логирующие методы. Нужен для определения минимальной ширины отводмой под столбец `:caller`.
+## Methods
 
-### Default output
+ - `reg` - registers a file from which methods that print console messages will be called in order to adjust the width of the `:caller` row
+
+### Default config
+
 ```js
 import Logger from 'bellman'
-let log = new Logger()
+
+new Logger()
   .reg()
@@ -22,49 +25,57 @@ .info('info message')
 ```
-![Default output](/accompanying-files/default-output.png)
 
-### User output
+![Default config](/misc/default-config.png)
+
+### Custom config
+
 ```js
-var Logger = require('bellman')
-var userConfig = {
-    timeTmp: 'HH:mm',
-    lineTmp: ':level :time :caller :message',
-    colorize: true,
-    callerColor: 'yellow.bold',
-    levelMap: {
-        'debug': 'blue',
-        'info': 'green',
-        'panic': 'red'
-    },
-    levelMin: 'debug',
-    isFullStack: true
+import Logger from 'bellman'
+
+const userConfig = {
+  timeTmp: 'HH:mm',
+  lineTmp: ':level :time :caller :message',
+  colorize: true,
+  callerColor: 'yellow.bold',
+  levelMap: {
+    debug: 'blue',
+    info: 'green',
+    panic: 'red'
+  },
+  levelMin: 'debug',
+  isFullStack: true
 }
-var logger = new Logger(userConfig)
-    .reg()
-    .info('info line')
-    .debug('debug line')
-    .panic('panic line: %s', new Error())
+
+new Logger(userConfig)
+  .reg()
+  .info('info line')
+  .debug('debug line')
+  .panic('panic line: %s', new Error())
 ```
-![User output](/accompanying-files/user-output.png)
 
-### Events
- * `log` - в качестве агрумента события используется объет, содержащий:
-   * `time` - Отформатированную временную метку
-   * `level` - Имя уровня логирования, соответствует имени логирующего метода
-   * `caller` - Имя файла и номер строки на которой был вызван логирующий метод
-   * `message` - Отфотматированное сообщение
-   * `args` - Аргументы переданные в логирующий метод, из которых формируется `message`
+![Custom config](/misc/custom-config.png)
 
-### Config
- * `timeTmp` - Задает формат `:time` части. Для форматирования используется библиотека [moment](https://github.com/moment/moment).
- * `lineTmp` - Задает формат строки логируемого сообщения.
-    * `:time` - Таймштамп, формат задается параметром `timeTmp`.
-    * `:level` - Соотвествует имени вызванного метода логгирования.
-    * `:caller` - Имя файла и номер строки на которой был вызван логирующий метод.
-    * `:message` - Отформатированное сообщение, составленное из переданных аргументов. Форматирование осуществляется функцией [util.format](https://nodejs.org/api/util.html#util_util_format_format).
- * `colorize` - Явно задает использовать окрашивание или нет. Для окрашивания используется библиотека [chalk](https://github.com/chalk/chalk).
- * `callerColor` - Задает цвет окрашивания `:caller` части.
- * `levelMap` - Задает имена, порядок приоритетов и цвета окрашивания логирующих методов.
- * `levelMin` - Задает имя минимально отображаемого приоритета.
- * `isFullStack` - Задает форматирование стэка ошибок. 
-    * Из неполного стэка удаляются файлы расположенные вне дирректории проекта и содержащие в пути папку `node_modules`. Корень дирректории проекта соответствует `__dirname` корневого модуля.
-    * Если указано выводить полный стэк ошибок, то никаких модификаций не вносится. Параметр может быть так же задани при момощи переменных окружения `STACK=full` и `FULLSTACK=true`
+## Config
+
+ - `lineTmp` - sets the logging line format. Supported placeholders:
+    * `:time` - a timestamp in the format defined by the `timeTmp` config option
+    * `:level` - a name of the logging method that has been called
+    * `:caller` - a name of the file and a number of the line from which the logging method has been called
+    * `:message` - a formatted message combined from the arguments passed to the logging method ([util.format](https://nodejs.org/api/util.html#util_util_format_format) is used to fromat messages)
+ - `timeTmp` - sets the timestamp format ([moment](https://github.com/moment/moment) is used to format timestamps)
+ - `colorize` - overrides whether the coloring should be used or not ([chalk](https://github.com/chalk/chalk) is used for colorization)
+ - `callerColor` - sets the `:caller` part color.
+ - `levelMap` - sets the names, priorities, and colors of the logging methods
+ - `levelMin` - sets the logging level
+ - `isFullStack` - sets whether the error stack formatter should be used or not
+    - if unset, all the lines that refer files out of the project's directory and all the files within `node_modules` directories will be removed
+    - if set, no modifications will be applied to the error-stacks
+    - `isFullStack` may be overridden with `STACK=full` and `FULLSTACK=true` environment variables
+
+## Events
+
+ - `log` - emits metadata of a logged line:
+   - `time` - a formateed timestamp
+   - `level` - a name of the logged message that has been called
+   - `caller` - a name of the file and a number of the line from which the logging method has been called
+   - `message` - a formatted message
+   - `args` - arguments passed the logged message

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

81

increased by15.71%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

11851

decreased by-10.84%

No dependency changes