!Consono

🕵️ Consono 🕵️‍♀️

The most correct, informative, appealing, and configurable variable inspector for JavaScript.

📝 Consono Documentation


---

🔋 Motivation

Motivation and differences from other libraries.

- ☀️ Light and 🌑 dark themes for terminal output.
- prefers-color-scheme: Hello darkness, my old friend
- 🎚️ Configurable coloring of variables.
- Can print to terminal or 🌈 return formatted and colored string for later use.
- How to get result string of console.log in javascript code? You can't.
- 🔀 Turn on/off output colorization.
- It even works on Windows - use Windows Terminal.
- Configurable indent - tabs 🆚 spaces holy war 👼🏻 ⚔️ 🇻🇦.
- Availability to set the 🕳️ depth for object inspection.
- Configurable #️⃣ max items for array, map, object, set.
- ✂️Limit string length when printing for better readability.
- Inspect both string 📐 character count and 📏 string length.
- It’s Not Wrong that "🤦🏼‍♂️".length == 7.
- Inspect ➕0️ positive zeroes and ➖0️ negative zeroes.
- JavaScript’s two zeros.
- Inspect 🔍 items count for collection-like variables array, map, object, set.
- Actually 🔬 can inspect arguments, set and map.
- Can print 📛 function names or mark them as anonymous.
- Handles 🔄 circular references.
- Has 📘 TypeScript declaration file.
- Writing Declaration Files for @types.
- Avoids 🔱😈🔥 dependency hell.
- Wikipedia article.
- Can 🧹 clear terminal before output.
- Can 💥 exit Node.js process after output.
- Import as 🆕 ECMAScript module.
- And so on and so forth ♾️.

🧬 Examples

``javascript
consono(undefined);
consono(null);
`

!Nil

`javascript
consono(true);
consono(false);
`

!Boolean

`javascript
consono(Infinity);
consono(Number.NEGATIVE_INFINITY);
consono(NaN);
consono(1);
consono(1.5);
consono(BigInt(9007199254740991));
`

!Number

`javascript
consono(new Date());
`

!Date

`javascript
consono("Hello, world 😀😁😂🤣😃😄😅😆😉😊", { stringMaxLength: 17 });
consono(Symbol("🌈"));
`

!String

`javascript
consono(/[0-9]+/);
consono(/\w+/giu);
`

!RegExp

`javascript
consono(function() {});
consono(function helloWorld() {});
consono(() => {});
`

!Function

`javascript
consono(new Promise(() => {}));
consono(async function helloWorld() {});
consono(async () => {});
consono(function* gen() { yield 1; });
`

!Async

`javascript
consono([1, 2, 3]);
consono(Int8Array.from([1, 2, 3]));
`

!Array

`javascript
consono(new ArrayBuffer(8));
consono(new SharedArrayBuffer(16));
`

!Array Buffer

`javascript
consono(new Set(["a", true, { prop: 1 }]));
consono(new Map([["first", "a"], [true, "b"]]));
consono(new WeakMap());
consono(new WeakSet());
`

!Collection

`javascript
consono({});

class MyClass {} const myClass = new MyClass(); myClass.deeper = new
MyClass(); consono(myClass);
`

!Object

`javascript
consono(new Error("Standard error"));
consono(new EvalError("Unable to run this code"));
consono(new RangeError("Must be less than 10 and greater than 0"));
consono(new ReferenceError("This is error from try/catch"));
consono(new SyntaxError("Not a source code"));
consono(new TypeError("Value is not of the expected type"));
`

!Error

`javascript
(function(a, b) { consono(arguments); })(true, false);
`

!Arguments

`javascript
consono(global || globalThis, { objectMaxProps: 3 });
`

!Global

📦 Installation

`bash
npm -s install consono
`

⌨️ Include

The default is a function for printing variable.

`javascript
import { consono } from "consono";
`

Import multiple items: function, constructor, options object, theme objects.

`javascript
import {
Consono,
consono,
options,
THEME_DARK,
THEME_LIGHT,
} from "consono";
`

UNPKG CDN.

> Note that the web browser version has no theme support, limited color palette, and only support chromium based browsers.

`html

`

⚙️ Options

`javascript
import { Consono } from "consono";
const options = {
clear: true,
quotesEnd: ”,
quotesStart: “,
stringMaxLength: 54,
};
const theme = "light"; // default is "dark"
const consono = new Consono(options, theme);
consono.log("Cleared before output. Different quotes. And cut to 54!");
// string • "Cleared before output. Different quotes. And cut to 54"
// (length=55, shown=54)
`

`javascript
import { Consono } from "consono";
const theme = {
argument: [253, 151, 31],
boolean: [174, 129, 255],
comment: [117, 113, 94],
keyword: [249, 38, 114],
name: [230, 219, 116],
number: [174, 129, 255],
plain: [255, 255, 255],
property: [102, 217, 239],
string: [166, 226, 46],
};
const consono = new Consono(null, theme);
consono.log("Themed");
`

`javascript
import { Consono, options } from "consono";
options.colorize = false;
const consono = new Consono(options);
consono.log("Text without colorization");
`

`javascript
import { consono } from "consono";
console.debug(
consono("Outputs a message only at the debug log level.", false)
);
`

🏷️ Instance

`javascript
const consono = Consono.factory(options, theme);
consono("This is log function with your own options");
`

🔖 Log function

`javascript
import { consono } from "consono";
const map = new Map();
map.add("key", true);
consono(map);
`

Return string with variable description.

`javascript
const variableAsString = consono({}, false);
`

or

`javascript
const variableAsString = consono({}, { console: false });
`

`javascript
const defaultOptions = {
// Maximum number of elements in array to show
arrayMaxElements: 99,
// Assign symbol
assignSymbol: "→",
// Clear console before output
clear: false,
// Colorize the output
colorize: true,
// Output to console
console: true,
// Default depth of object
depth: 20,
// 'false' - do nothing. 'true' - exit status ok.
// Number greater than zero - exit status with passed error code.
exit: false,
// Call console.log immediately
immediate: false,
// Print indentation
indent: "ˑˑ",
// Maximum number of entries in map to show
mapMaxEntries: 99,
// Maximum number of properties in object to show
objectMaxProps: 99,
// Quote start
quotesEnd: ",
// Quote end
quotesStart: ",
// Return inspected variable as string
returns: true,
// Maximum number of values in set to show
setMaxValues: 99,
// Call process.stdout.write instead of console.log.
stdout: false,
// Maximum length of string to show
stringMaxLength: 360,
};
consono("Some variable", defaultOptions);
`

🔮 Shortcuts

`javascript
// Exit code - 15
consonoExit("Some value", null, null, 15);
// No colorization, no description, only printing with console.dir
consonoJSON("Some value");
// No colorization, no description, only printing with process.stdout.write
consonoOut("Some value");
// No colorization
consonoPlain("Some value");
// Return only, no console.log
consonoReturn("Some value");
``

👀 Discover more

My other projects