# Tie Logger

> 👔 Fully typed minimal platform-agnostic logger

[![Test Status](https://github.com/zibuthe7j11/deserunt-quasi-impedit/actions/workflows/test.yml/badge.svg)](https://github.com/zibuthe7j11/deserunt-quasi-impedit)
[![Downloads](https://img.shields.io/npm/dt/@zibuthe7j11/deserunt-quasi-impedit.svg)](https://npmjs.com/package/@zibuthe7j11/deserunt-quasi-impedit)
[![last commit](https://img.shields.io/github/last-commit/AlexXanderGrib/@zibuthe7j11/deserunt-quasi-impedit.svg)](https://github.com/zibuthe7j11/deserunt-quasi-impedit)
[![codecov](https://img.shields.io/codecov/c/github/AlexXanderGrib/@zibuthe7j11/deserunt-quasi-impedit/main.svg)](https://codecov.io/gh/AlexXanderGrib/@zibuthe7j11/deserunt-quasi-impedit)
[![GitHub](https://img.shields.io/github/stars/AlexXanderGrib/@zibuthe7j11/deserunt-quasi-impedit.svg)](https://github.com/zibuthe7j11/deserunt-quasi-impedit)
[![@zibuthe7j11/deserunt-quasi-impedit](https://snyk.io/advisor/npm-package/@zibuthe7j11/deserunt-quasi-impedit/badge.svg)](https://snyk.io/advisor/npm-package/@zibuthe7j11/deserunt-quasi-impedit)
[![Known Vulnerabilities](https://snyk.io/test/npm/@zibuthe7j11/deserunt-quasi-impedit/badge.svg)](https://snyk.io/test/npm/@zibuthe7j11/deserunt-quasi-impedit)
[![Quality](https://img.shields.io/npms-io/quality-score/@zibuthe7j11/deserunt-quasi-impedit.svg?label=quality%20%28npms.io%29&)](https://npms.io/search?q=@zibuthe7j11/deserunt-quasi-impedit)
[![npm](https://img.shields.io/npm/v/@zibuthe7j11/deserunt-quasi-impedit.svg)](https://npmjs.com/package/@zibuthe7j11/deserunt-quasi-impedit)
[![license MIT](https://img.shields.io/npm/l/@zibuthe7j11/deserunt-quasi-impedit.svg)](https://github.com/zibuthe7j11/deserunt-quasi-impedit/blob/main/LICENSE.txt)
[![Size](https://img.shields.io/bundlephobia/minzip/@zibuthe7j11/deserunt-quasi-impedit)](https://bundlephobia.com/package/@zibuthe7j11/deserunt-quasi-impedit)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c32597c51ac540b08a2474575ae25cbb)](https://www.codacy.com/gh/AlexXanderGrib/@zibuthe7j11/deserunt-quasi-impedit/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AlexXanderGrib/@zibuthe7j11/deserunt-quasi-impedit&utm_campaign=Badge_Grade)

## 📦 Installation

- **Using `npm`**
  ```shell
  npm i @zibuthe7j11/deserunt-quasi-impedit
  ```
- **Using `Yarn`**
  ```shell
  yarn add @zibuthe7j11/deserunt-quasi-impedit
  ```
- **Using `pnpm`**
  ```shell
  pnpm add @zibuthe7j11/deserunt-quasi-impedit
  ```

## Usage

### Initialization

```javascript
/** @file: logger.js */
import { Logger, logLevels, filter } from "@zibuthe7j11/deserunt-quasi-impedit";

export const logger = new Logger(
  "app", // Root logger name
  logLevels(), // Define log levels. By default are: verbose, debug, info, warn, error, fatal
  // You can use custom levels by using
  // logLevels("info", "warn", "error")

  {
    // Custom data
    appVersion: "3.1"
    moduleName: "root",
    moduleVersion: "1.0.0"
  }
);

export const child = logger.child(
  // Child logger name
  "auth",

  // Child logger data
  { moduleName: "auth", moduleVersion: "0.3.1" }
);

const criticalLogs = [];

const unsubscribe = logger.subscribe(
  // Subscribe to all logs, they go to console
  (log) => console.log(...log.message.parts),

  // All logs, that level is greater or equal than "warn" will be added to critical logs

  // Severity is determined by index of level in levels array
  // Current array is: verbose, debug, info, warn, error, fatal
  //                             [less] <<<  ^^^^   >> [greater]
  filter(">=", "warn", (log) => criticalLogs.push(log))
)

process.on("SIGINT", () => {
  unsubscribe();
})
```

## Logging

```javascript
/** @file: index.js */
import { child, logger } from "./logger.js";

const PORT = parseInt(process.env.PORT) || 3000;
logger.subscribe(log => console.log(log));

child.log.debug`Application initialized. Port: ${{ port: PORT }}. Environment: ${{process.env}}`;
// Level:  ^^^^^

// Here goes app
```

## Log format

```javascript
({
  // One of defined levels
  level: "debug",

  message: {
    template:
      "Application initialized. Port: {port}. Environment: {SHELL,COLORTERM,PWD}",
    plain:
      'Application initialized. Port: 3000. Environment: {"SHELL":"/bin/bash","COLORTERM":"truecolor","PWD":"/home/alexxgrib/Projects/@zibuthe7j11/deserunt-quasi-impedit"}',
    parts: [
      "Application initialized. Port:",
      { port: 3000 },
      ". Environment: ",
      {
        SHELL: "/bin/bash",
        COLORTERM: "truecolor",
        PWD: "/home/alexxgrib/Projects/@zibuthe7j11/deserunt-quasi-impedit"
      }
    ]
  },

  // merge of
  // - logger data
  // - logger parents data
  // - data passed in log message
  data: {
    appVersion: "3.1",
    moduleName: "auth",
    moduleVersion: "0.3.1",
    port: 3000,
    SHELL: "/bin/bash",
    COLORTERM: "truecolor",
    PWD: "/home/alexxgrib/Projects/@zibuthe7j11/deserunt-quasi-impedit"
  },

  context: {
    // name of the logger
    name: "auth",

    // list of logger inheritance
    path: ["app", "auth"]
  },

  // logger object
  origin: child
});
```