nocol v2.1.0

nocl

Styled nodejs console logger

Installation

npm i nocol

Usage

import nocl, { Nocl } from "nocol";

nocl.log("Hello world!");

Default export: nocl - an instance of Nocl class

Create new instance

const nocl2 = new Nocl(options);
nocl2.log("Hello world from nocl2!");

Class init options / properties

You can also modify the properties directly to change the styling without creating new instance

Default theme

For color or symbolColor value, you can pass hex color or chalk ForegroundColor

Examples

Modifying theme

This will merge into current instance theme

nocl.info("default theme");
const theme = {
  info: {
    symbol: "info",
    symbolColor: "#074880",
  },
};
nocl.theme = theme;
nocl.info("modified theme");
// OR
const nocl3 = new Nocl({
  theme,
});
nocl3.info("modified theme from nocl3");

Modifying theme: ts

Change timestamp display

nocl.ts("default theme: ts");
nocl.theme = {
  ts: {
    // type LocalesArgument
    locales: undefined,
    // type DateTimeFormatOptions
    options: {
      hour12: true,
      timeStyle: "medium",
    },
  },
};
nocl.ts("modified theme: ts");

Using symbolPrefix

nocl.log("without symbolPrefix");
nocl.symbolPrefix = {
  symbol: "1/10",
};
nocl.log("with symbolPrefix");

Using symbolPostfix

nocl.log("without symbolPostfix");
nocl.symbolPostfix = {
  symbol: "username",
};
nocl.log("with symbolPostfix");

Using encloseSymbol

nocl.info("with encloseSymbol");
nocl.encloseSymbolColor = "blue";
nocl.info("with encloseSymbolColor");
nocl.encloseSymbolColor = null;
nocl.encloseSymbol = false;
nocl.info("without encloseSymbol");

Using useChalkTemplate

This will fallback to chalk if there was an error coloring using template

nocl.log("{yellow without using chalk template}");
nocl.useChalkTemplate = true;
nocl.log("{yellow using chalk template}");

.line

nocl.line();
nocl.line({ color: "magenta", symbol: "~" });
nocl.line({ label: "Left" });
nocl.line({ label: "{white.inverse  Center }", align: "center" });
nocl.line({ color: "green", symbol: "~", label: "Right", align: "right" });
nocl.line({ symbol: " ", label: "{white.inverse  Center }", align: "center" });
nocl.line({ symbol: " ", label: "{white.inverse  Left }", align: "left" });
nocl.line({ symbol: " ", label: "{white.inverse  Right }", align: "right" });

.group

const n = new Nocl({ useChalkTemplate: true });
n.group("ms:");
n.log("a");
n.group("{yellow members3:}");
n.log("b");
n.groupEnd();
n.log("c");
n.groupEnd();
n.log("d");

Using session log

nocl.startSession(filepath, options); // createWriteStream
nocl.log("hello");
nocl.endSession();

Check tests

TODO

• session logging

Changelog

• 2.1.0
  • added line method
  • customization improvements
• 2.0.0
  • added clone, group, groupEnd, and nl methods
  • fixed theme setter typings
  • now using stdout for session logging
  • improvements
• 1.1.4
  • fixed circular json error on session log
• 1.1.3
  • fixed chalk template
• 1.1.2
  • added new theme "comment"
• 1.1.1
  • added object support for session log
• 1.1.0
  • added session logging
• 1.0.2
  • stable version