itivrutaha 2.0.14 → 3.0.0-beta.1

package/examples/index.ts

@@ -0,0 +1,48 @@
+import chalk from 'chalk'
+import { itivrutaha } from '../dist/index.js'
+
+const log = itivrutaha({
+    theme: `:time ${chalk.gray.dim('•')} :scope :emoji :type :msg :data`,
+    timeFormat: 'hh:mm:ss dd-MM-yyyy',
+    scopes: [
+        {
+            name: 'app',
+            color: chalk.redBright
+        },
+        {
+            name: 'web',
+            color: chalk.cyanBright
+        }
+    ],
+    types: [
+        {
+            name: 'error',
+            emoji: 'x',
+            color: chalk.redBright
+        },
+        {
+            name: 'warning',
+            emoji: 'construction',
+            color: chalk.yellowBright
+        }
+    ]
+})
+
+log.error('a simple error message')
+log.warning('a simple warning message', {
+    hello: {
+        works: false,
+        some: 'wow!'
+    },
+    world: '🎊'
+})
+
+log.error({
+    msg: 'hellow rold',
+    scope: 'app'
+})
+
+log.warning({
+    msg: 'wow!',
+    scope: 'web'
+})

package/package.json

@@ -1,16 +1,16 @@
 {
     "name": "itivrutaha",
-    "description": "( इतिवृत्तः ) — Logging system ✍ for Node.js with 🍬 theming and file 🗃 logging support.",
-    "version": "2.0.14",
+    "description": "",
+    "version": "3.0.0-beta.1",
     "license": "MIT",
     "type": "module",
-    "main": "dist/itivrutaha.js",
+    "main": "dist/index.js",
     "homepage": "https://github.com/vsnthdev/itivrutaha#readme",
     "bugs": "https://github.com/vsnthdev/itivrutaha/issues",
     "author": {
-        "name": "Vasanth Srivatsa",
-        "email": "vasanth@vasanthdeveloper.com",
-        "url": "https://vsnth.dev"
+        "email": "hey@vsnth.dev",
+        "url": "https://vsnth.dev",
+        "name": "Vasanth Srivatsa"
     },
     "repository": {
         "type": "git",
@@ -18,51 +18,18 @@
     },
     "scripts": {
         "dev": "tsc --watch",
-        "build": "rimraf ./dist && tsc --incremental false",
-        "docs": "rimraf docs/ && node scripts/docs.js",
-        "clean": "rimraf dist"
+        "clean": "rimraf dist",
+        "build": "rimraf dist && tsc"
     },
-    "keywords": [
-        "cli",
-        "tty",
-        "log",
-        "logs",
-        "shell",
-        "logger",
-        "logging",
-        "terminal",
-        "command-line"
-    ],
     "dependencies": {
-        "chalk": "^5.0.1",
-        "clear-terminal-line": "^0.0.1",
-        "deepmerge": "^4.2.2",
-        "del": "^7.0.0",
-        "env-paths": "^3.0.0",
-        "joi": "^17.6.0",
-        "luxon": "^3.0.1",
-        "mkdirp": "^1.0.4",
-        "node-cleanup": "^2.1.2",
-        "node-emoji": "^1.11.0",
-        "read-pkg-up": "^9.1.0",
-        "strip-ansi": "^7.0.1"
+        "chalk": "^5.3.0",
+        "cli-highlight": "^2.1.11",
+        "date-format": "^4.0.14",
+        "node-emoji": "^2.1.3"
     },
     "devDependencies": {
-        "@types/luxon": "^3.0.0",
-        "@types/mkdirp": "^1.0.2",
-        "@types/node": "^18.6.1",
-        "@types/node-cleanup": "^2.1.2",
-        "@types/node-emoji": "^1.8.1",
-        "@typescript-eslint/eslint-plugin": "^5.30.7",
-        "@typescript-eslint/parser": "^5.30.7",
-        "es-dirname": "^0.1.0",
-        "eslint": "^8.20.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-import": "^2.26.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "eslint-plugin-simple-import-sort": "^7.0.0",
-        "prettier": "^2.7.1",
-        "rimraf": "^3.0.2",
-        "typescript": "^4.7.4"
+        "@types/node": "^20.10.6",
+        "rimraf": "^5.0.5",
+        "typescript": "^5.3.3"
     }
-}
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+/*
+ *  Entryfile for itivrutaha logging module.
+ *  Created On 29 October 2023
+ */
+
+export { itivrutaha } from './itivrutaha.js'

package/src/itivrutaha.ts

@@ -0,0 +1,46 @@
+/*
+ *  Contains an exportable logger function.
+ *  Created On 29 October 2023
+ */
+
+import { ChalkInstance } from "chalk"
+import { render } from "./renderer.js"
+
+export interface IScope<ScopeName> {
+    name: ScopeName
+    color: ChalkInstance
+}
+
+export interface LogType<Name> {
+    name: Name
+    emoji: string
+    color: ChalkInstance
+}
+
+export interface Config<ScopeName, LogTypeName> {
+    theme: string
+    timeFormat: string
+    scopes: IScope<ScopeName>[]
+    types: LogType<LogTypeName>[]
+}
+
+export interface UnifiedData<ScopeName> {
+    scope?: ScopeName
+    msg: string
+    [key: string]: any
+}
+
+export function itivrutaha<Scope extends string, LogTypeName extends string>(config: Config<Scope, LogTypeName>) {
+    type Types = typeof config['types'][0]['name']
+    type Signature = (msgOrData: string | UnifiedData<Scope>, data?: any, scope?: Scope) => void
+
+    type ReturnSignature = {
+        [Type in Types]: Signature
+    }
+
+    // return all the log functions
+    return config.types.reduce((previous, current) => ({
+        ...previous,
+        [current.name]: render(config, current)
+    }), {}) as ReturnSignature
+}

package/src/renderer.ts

@@ -0,0 +1,43 @@
+/*
+ *  Renders a single log line by consuming an object.
+ *  Created On 15 January 2024
+ */
+
+import { filterObject } from './utilts.js';
+import { Config, LogType, UnifiedData } from './itivrutaha.js'
+import { emojify } from 'node-emoji';
+import * as variables from './variables/index.js'
+
+function line<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>, type: LogType<LogTypeName>, msg: string, scopeName?: ScopeName, data?: any) {
+    // filter internal keys from data
+    if (data) data = filterObject(data, ['msg', 'scope'])
+
+    console.log(
+        config.theme
+            .replace(/:time/g, variables.time(config))
+            .replace(/:scope/g, variables.scope(config, scopeName))
+            .replace(/:emoji/g, variables.emoji(type))
+            .replace(/:type/g, variables.type(type))
+            .replace(/:msg/g, emojify(msg))
+            .replace(/:data/g, variables.data(data))
+    )
+}
+
+export function render<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>, type: LogType<LogTypeName>) {
+    // consume all the log objects
+
+    return (msgOrData: string | UnifiedData<ScopeName>, data?: any, scope?: ScopeName) => {
+        // determine whether we're using unified data or seperate arguments
+        if (typeof msgOrData == 'string') {
+            // seperate arguments
+            line(config, type, msgOrData, scope, data)
+        } else {
+            // unified data
+            // ensure scope & data are not given in both placces
+            if (scope) throw Error(`Specifying scope as argument is not allowed`)
+            if (data) throw Error(`Specifying data separately is not allowed`)
+
+            line(config, type, msgOrData.msg, msgOrData.scope, msgOrData)
+        }
+    }
+}

package/src/utilts.ts

@@ -0,0 +1,10 @@
+/*
+ *  Contains small utility functions used across this project.
+ *  Created On 15 January 2024
+ */
+
+export function filterObject(obj: Record<string, any>, keysToExclude: string[]): Record<string, any> {
+    return Object.fromEntries(
+        Object.entries(obj).filter(([key]) => !keysToExclude.includes(key))
+    )
+}

package/src/variables/data.ts

@@ -0,0 +1,40 @@
+/*
+ *  Renders the ":data" variable.
+ *  Created On 15 January 2024
+ */
+
+import chalk from 'chalk'
+import { highlight } from 'cli-highlight'
+
+function formatJSON(data: any) {
+    return JSON.stringify(data)
+        .replace(/{"/g, '{ "')
+        .replace(/"}/g, '" }')
+        .replace(/,"/g, ", \"")
+        .replace(/":/g, '": ')
+}
+
+export function data(input: any) {
+    if (!input) return ''
+
+    let str = ''
+
+    for (const key in input) {
+        const value = input[key]
+        const keyBlock = `${chalk.cyanBright(key)}${chalk.whiteBright('=')}`
+
+
+        if (typeof value == 'object') {
+            str = str.concat(keyBlock).concat(highlight(formatJSON(value), {
+                language: 'json',
+                ignoreIllegals: true,
+            })).concat(' ')
+        } else if (typeof value == 'string') {
+            str = str.concat(keyBlock).concat(chalk.magentaBright(value)).concat(' ')
+        } else {
+            str = str.concat(keyBlock).concat(chalk.magentaBright(JSON.stringify(value))).concat(' ')
+        }
+    }
+
+    return str.trim()
+}

package/src/variables/emoji.ts

@@ -0,0 +1,11 @@
+/*
+ *  Renders the ":emoji" variable if an emoji is specified.
+ *  Created On 15 January 2024
+ */
+
+import { get } from "node-emoji";
+import { type LogType } from '../itivrutaha.js';
+
+export function emoji<LogTypeName extends string>(type: LogType<LogTypeName>) {
+    return get(type.emoji)
+}

package/src/variables/index.ts

@@ -0,0 +1,10 @@
+/*
+ *  Exports all render functions neatly as single package.
+ *  Created On 15 January 2024
+ */
+
+export * from './time.js'
+export * from './type.js'
+export * from './data.js'
+export * from './emoji.js'
+export * from './scope.js'

package/src/variables/scope.ts

@@ -0,0 +1,11 @@
+/*
+ *  Renders ":scope" variable with the current log line's scope.
+ *  Created On 15 January 2024
+ */
+
+import { Config } from "../itivrutaha.js"
+
+export function scope<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>, scopeName?: ScopeName) {
+    const scope = scopeName ? config.scopes.find(sco => sco.name == scopeName) : config.scopes[0]
+    return scope.color(scope.name)
+}

package/src/variables/time.ts

@@ -0,0 +1,12 @@
+/*
+ *  Renders the ":time" variable printing current time.
+ *  Created On 15 January 2024
+ */
+
+import chalk from 'chalk'
+import { Config } from "../itivrutaha.js"
+import format from 'date-format'
+
+export function time<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>) {
+    return chalk.gray.dim(format.asString(config.timeFormat))
+}

package/src/variables/type.ts

@@ -0,0 +1,10 @@
+/*
+ *  Renders the ":type" variable.
+ *  Created On 15 January 2024
+ */
+
+import { LogType } from "../itivrutaha.js";
+
+export function type<LogTypeName extends string>(type: LogType<LogTypeName>) {
+    return type.color(type.name)
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compileOnSave": true,
+    "compilerOptions": {
+        "newLine": "LF",
+        "outDir": "dist/",
+        "target": "ESNext",
+        "declaration": true,
+        "incremental": false,
+        "module": "NodeNext",
+        "alwaysStrict": true,
+        "removeComments": true,
+        "esModuleInterop": true,
+        "preserveConstEnums": true,
+        "moduleResolution": "NodeNext"
+    },
+    "include": [
+        "src"
+    ]
+}

package/LICENSE.md

@@ -1,9 +0,0 @@
-## MIT License
-
-Copyright © 2019 Vasanth Developer.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,82 +0,0 @@
-<h5 align="center">
-    <img src="https://github.com/vasanthdeveloper/itivrutaha/blob/designs/header.png?raw=true" alt="itivrutaha">
-</h5>
-<p align="center"><strong>( इतिवृत्तः ) — Logging system ✍ for Node.js with 🍬 theming and file 🗃 logging support.</strong></p>
-<p align="center">
-    <a target="_blank" rel="noopener" href="https://www.npmjs.com/package/itivrutaha">
-        <img src="https://img.shields.io/npm/v/itivrutaha.svg?style=flat-square" alt="">
-    </a>
-    <a target="_blank" rel="noopener" href="https://www.npmjs.com/package/itivrutaha?activeTab=versions">
-        <img src="https://img.shields.io/npm/dm/itivrutaha.svg?style=flat-square" alt="">
-    </a>
-    <a href="https://github.com/vasanthdeveloper/itivrutaha/issues">
-        <img src="https://img.shields.io/github/issues/vasanthdeveloper/itivrutaha.svg?style=flat-square" alt="">
-    </a>
-    <a href="https://github.com/vasanthdeveloper/itivrutaha/commits/main">
-        <img src="https://img.shields.io/github/last-commit/vasanthdeveloper/itivrutaha.svg?style=flat-square"
-            alt="">
-    </a>
-</p>
-<br>
-
-<!-- header -->
-
-**itivrutaha** is my first ever JavaScript (initially) project. It is a console logging module for Node.js to be used in CLIs, GUI desktop frameworks (like <a href="https://github.com/electron/electron" target="_blank" rel="noopener">Electron</a> & <a href="https://github.com/nodegui/nodegui" target="_blank" rel="noopener">NodeGUI</a>) and for web servers.
-
-> Tweet me <a target="_blank" rel="noopener" href="https://vas.cx/twitter">@vsnthdev</a>, I would love to know your opinion/experience on this project 😍
-
-## ⚡️ Features
-
-1. Save logs to files
-2. Create multiple loggers with context
-3. Flexible theming support with <a href="https://www.npmjs.com/package/chalk" target="_blank" rel="noopener">chalk</a>
-4. Terminal emoji support
-5. Written in TypeScript
-
-## 💿 Installation
-<a href="https://www.npmjs.com/package/itivrutaha"><img src="https://nodei.co/npm/itivrutaha.png?downloads=true&downloadRank=true&stars=true" alt="npm module badge"></a>
-```
-npm i itivrutaha
-```
-
-## 🚴‍♂️ Quick Start
-After installing `itivrutaha` using the above commands, you can use it in the following way:
-
-```javascript
-import itivrutaha from 'itivrutaha'
-
-// create a new instance of the logger
-const logger = await itivrutaha.createNewLogger({
-    // optional configuration
-})
-
-// examples of logging with itivrutaha
-logger.error('Ouch!')
-logger.note('Point to be noted')
-logger.okay('Not an info message')
-logger.success('Makes users happy')
-logger.info('Nice to know something is happening')
-logger.verbose("Always makes developer's life easy")
-```
-
-To know more configuration options like **file logging**, **themes**, and **time formatting** see the [customization page](docs/Customization.md).
-
-## 🛠 Building
-
-* `npm install` — Installs all dependencies.
-* `npm run dev` — Builds TypeScript and docs automatically upon save.
-* `npm run build` — Deletes existing build files & freshly compiles TypeScript code.
-* `npm run docs` — Deletes existing docs and freshly builds by reading code.
-
-**Note:** Run `node examples/index.js` to test `itivrutaha` with the latest code.
-
-<!-- footer -->
-
-## 📰 License
-> The **itivrutaha** project is released under the [MIT license](https://github.com/vasanthdeveloper/itivrutaha/blob/main/LICENSE.md). <br> Developed &amp; maintained By Vasanth Srivatsa. Copyright 2022 © Vasanth Developer.
-<hr>
-
-> <a href="https://vsnth.dev" target="_blank" rel="noopener">vsnth.dev</a> &nbsp;&middot;&nbsp;
-> YouTube <a href="https://vas.cx/videos" target="_blank" rel="noopener">@vasanthdeveloper</a> &nbsp;&middot;&nbsp;
-> Twitter <a href="https://vas.cx/twitter" target="_blank" rel="noopener">@vsnthdev</a> &nbsp;&middot;&nbsp;
-> Discord <a href="https://vas.cx/discord" target="_blank" rel="noopener">Vasanth Developer</a>

package/dist/class/index.d.ts

@@ -1,13 +0,0 @@
-import { ConfigImpl, DataImpl } from '../config.js';
-export declare class Logger {
-    config: ConfigImpl;
-    data: DataImpl;
-    constructor(config: ConfigImpl, data: DataImpl);
-    success: (msg: string) => void;
-    note: (msg: string) => void;
-    info: (msg: string) => void;
-    okay: (msg: string) => void;
-    warning: (msg: string | Error) => void;
-    error: (msg: string | Error, exitCode?: number) => void;
-    verbose: (msg: string) => void;
-}

package/dist/class/index.js

@@ -1,36 +0,0 @@
-/*
- *  This class which holds all the log functions.
- *  Created On 11 October 2019
- */
-import { configSchema } from '../config.js';
-import lifecycle from './lifecycle.js';
-import render from './wrapper.js';
-export class Logger {
-    // constructor() executes when the class is initialized
-    constructor(config, data) {
-        this.success = (msg) => render({ msg, config: this.config, data: this.data });
-        this.note = (msg) => render({ msg, config: this.config, data: this.data });
-        this.info = (msg) => render({ msg, config: this.config, data: this.data });
-        this.okay = (msg) => render({ msg, config: this.config, data: this.data });
-        this.warning = (msg) => render({ msg, config: this.config, data: this.data });
-        this.error = (msg, exitCode) => render({ msg, config: this.config, data: this.data, exitCode });
-        // verbose() will only log the message
-        // when a flag/command/option is found in the
-        // command-line arguments
-        this.verbose = (msg) => render({
-            msg,
-            config: this.config,
-            data: this.data,
-            condition: () => this.config.verboseIdentifier.some(argument => process.argv.includes(argument)),
-        });
-        const valid = configSchema.validate(config);
-        if (valid.error)
-            throw new Error(`itivrutaha was misconfigured: ${valid.error.message}`);
-        // make the config globally relative accessible
-        this.config = valid.value;
-        this.data = data;
-        // log a message that the the application has
-        // started/stopped as per user's request
-        lifecycle(valid.value, data);
-    }
-}

package/dist/class/lifecycle.d.ts

@@ -1,3 +0,0 @@
-import { ConfigImpl, DataImpl } from '../config';
-declare const _default: (config: ConfigImpl, data: DataImpl) => void;
-export default _default;

package/dist/class/lifecycle.js

@@ -1,65 +0,0 @@
-/*
- *  Logs when application starts or stops.
- *  Created On 15 April 2021
- */
-import ctl from 'clear-terminal-line';
-import { DateTime } from 'luxon';
-import cleanup from 'node-cleanup';
-import { close } from './log.js';
-import render from './wrapper.js';
-const startup = (config, data) => {
-    render({
-        data,
-        config,
-        msg: `${config.appName} startup`,
-        type: 'note',
-        condition: () => config.bootLog,
-    });
-    render({
-        data,
-        config,
-        msg: `Started on ${DateTime.local().toFormat('hh:mm:ss a, LLL dd yyyy')}`,
-        type: 'info',
-        condition: () => config.bootLog,
-    });
-};
-const shutdown = (config, data, signal) => {
-    const now = DateTime.local().diff(data.startedOn, [
-        'days',
-        'hours',
-        'minutes',
-        'seconds',
-        'milliseconds',
-    ]);
-    const time = [];
-    now.days && time.push(`${Math.round(now.days)} days`);
-    now.hours && time.push(`${Math.round(now.hours)} hours`);
-    now.minutes && time.push(`${Math.round(now.minutes)} minutes`);
-    now.seconds && time.push(`${Math.round(now.seconds)} seconds`);
-    now.milliseconds && time.push(`${Math.round(now.milliseconds)} ms`);
-    if (signal == 'SIGINT' && config.clearOnSIGINT) {
-        ctl();
-        process.stdout.write('\r');
-    }
-    render({
-        data,
-        config,
-        msg: `Bye 👋 ran for ${time.slice(-3).join(', ')}`,
-        type: 'info',
-        condition: () => config.shutdownLog,
-    });
-    render({
-        data,
-        config,
-        msg: `${config.appName} shutdown`,
-        type: 'note',
-        condition: () => config.shutdownLog,
-    });
-    close(true, data);
-};
-export default (config, data) => {
-    startup(config, data);
-    cleanup((exitCode, signal) => {
-        shutdown(config, data, signal);
-    });
-};

package/dist/class/log.d.ts

@@ -1,5 +0,0 @@
-import { ConfigImpl, DataImpl } from '../config';
-export declare const close: (close: boolean, data: DataImpl) => Promise<void>;
-export declare const open: (config: ConfigImpl) => Promise<DataImpl>;
-declare const _default: (log: string, type: string, config: ConfigImpl, data: DataImpl) => Promise<void>;
-export default _default;

package/dist/class/log.js

@@ -1,60 +0,0 @@
-/*
- *  Handles writing log files.
- *  Created On 15 April 2021
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import paths from 'env-paths';
-import fs from 'fs/promises';
-import { DateTime } from 'luxon';
-import mkdirp from 'mkdirp';
-import cleanup from 'node-cleanup';
-import path from 'path';
-import strip from 'strip-ansi';
-export const close = (close, data) => __awaiter(void 0, void 0, void 0, function* () {
-    if (close && (data.error || data.output)) {
-        yield data.output.close();
-        yield data.error.close();
-    }
-});
-export const open = (config) => __awaiter(void 0, void 0, void 0, function* () {
-    // variable to store data
-    const data = {
-        startedOn: DateTime.local(),
-    };
-    if (config.logs.enable == true && !config.logs.dir) {
-        const { log } = paths(config.appName, {
-            suffix: '',
-        });
-        config.logs.dir = log;
-    }
-    if (config.logs.enable) {
-        // make sure that the folder exists
-        yield mkdirp(config.logs.dir);
-        // open log files
-        data.output = yield fs.open(path.join(config.logs.dir, config.logs.output), 'a', 0o666);
-        data.error = yield fs.open(path.join(config.logs.dir, config.logs.error), 'a', 0o666);
-    }
-    // attach the closing hook
-    cleanup(() => {
-        close(!config.shutdownLog, data);
-    });
-    return data;
-});
-export default (log, type, config, data) => __awaiter(void 0, void 0, void 0, function* () {
-    if (config.logs.enable == false)
-        return;
-    // whether to write in error or output file
-    const stream = ['error', 'warning'].includes(type) ? 'error' : 'output';
-    // strip ansi terminal styling codes
-    log = strip(log) + '\n';
-    // write it!
-    yield data[stream].appendFile(log);
-});

package/dist/class/renderer.d.ts

@@ -1,3 +0,0 @@
-import { ConfigImpl } from '../config.js';
-declare const _default: (typeStr: string, msg: string, config: ConfigImpl) => string;
-export default _default;

package/dist/class/renderer.js

@@ -1,33 +0,0 @@
-/*
- *  This file will replace all the placeholders with real values.
- *  Created On 12 October 2019
- */
-import ne from 'node-emoji';
-import path from 'path';
-import emoji from './variables/emoji.js';
-import time from './variables/time.js';
-import type from './variables/type.js';
-export default (typeStr, msg, config) => config.theme.string
-    // <!-- docs -->
-    // The time of the log message. A [Luxon](https://moment.github.io/luxon/docs/manual/formatting.html#table-of-tokens) format string can be given as `theme.timeFormat` to change the formatting.
-    .replace(':time', time(config))
-    // Emoji according to the message type.
-    .replace(':emoji', emoji(typeStr))
-    // Log message in terminal's default color.
-    .replace(':message', ne.emojify(msg))
-    // Full path to Node.js executable.
-    .replace(':node_path', process.argv[0])
-    // Message type (ie. info, warning, error, etc).
-    .replace(':type', type(typeStr, config))
-    // Full path of the Node.js entry JavaScript file.
-    .replace(':script_path', process.argv[1])
-    // Version of Node.js running.
-    .replace(':node_version', process.version)
-    // Version of V8 engine running along with Node.js.
-    .replace(':v8_version', process.versions.v8)
-    // Filename of the Node.js entryfile.
-    .replace(':filename', path.basename(process.argv[1]))
-    // Version of OpenSSL running along with Node.js.
-    .replace(':openssl_version', process.versions.openssl)
-    // Version of Electron.js running. Returns `undefined` if not Electron.
-    .replace(':electron_version', process.versions.electron);

package/dist/class/variables/emoji.d.ts

@@ -1,2 +0,0 @@
-declare const _default: (type: string) => string;
-export default _default;

package/dist/class/variables/emoji.js

@@ -1,15 +0,0 @@
-/*
- *  Renders ":emoji" variable in log messages.
- *  Created On 15 April 2021
- */
-import emoji from 'node-emoji';
-const emojis = {
-    okay: 'thumbsup',
-    info: 'loudspeaker',
-    error: 'x',
-    note: 'memo',
-    verbose: 'telescope',
-    success: 'white_check_mark',
-    warning: 'construction',
-};
-export default (type) => emoji.emojify(`:${emojis[type]}:`).trim();

package/dist/class/variables/time.d.ts

@@ -1,3 +0,0 @@
-import { ConfigImpl } from '../../config.js';
-declare const _default: (config: ConfigImpl) => string;
-export default _default;

package/dist/class/variables/time.js

@@ -1,9 +0,0 @@
-/*
- *  This file will render the ":time" variable.
- *  Created On 12 October 2019
- */
-import chalk from 'chalk';
-import { DateTime } from 'luxon';
-export default (config) => config.theme.colored
-    ? chalk.gray.dim(DateTime.local().toFormat(config.theme.timeFormat))
-    : DateTime.local().toFormat(config.theme.timeFormat);

package/dist/class/variables/type.d.ts

@@ -1,3 +0,0 @@
-import { ConfigImpl } from '../../config.js';
-declare const _default: (type: string, config: ConfigImpl) => string;
-export default _default;

package/dist/class/variables/type.js

@@ -1,34 +0,0 @@
-/*
- *  This file will render the ":type" variable in the theme.
- *  Created On 12 October 2019
- */
-import chalk from 'chalk';
-// bold() will make the text bold
-const bold = (type, config) => config.theme.boldType ? chalk.bold(type) : type;
-// this function will call the rest of the styling
-// functions will make a function chain like that
-const colorize = (type, config) => {
-    if (!config.theme.colored)
-        return bold(type, config);
-    const colors = {
-        okay: chalk.gray,
-        info: chalk.blueBright,
-        error: chalk.redBright,
-        note: chalk.magentaBright,
-        verbose: chalk.cyanBright,
-        success: chalk.greenBright,
-        warning: chalk.yellowBright,
-    };
-    return bold(colors[type](type), config);
-};
-// casing() will set the character casing
-const casing = (type, config) => {
-    const toTitleCase = (str) => str.replace(/\w\S*/g, txt => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase());
-    const func = {
-        0: (str) => str.toUpperCase(),
-        1: (str) => str.toLowerCase(),
-        2: (str) => toTitleCase(str),
-    };
-    return colorize(func[config.theme.typeCase](type), config);
-};
-export default (type, config) => casing(type, config);

package/dist/class/wrapper.d.ts

@@ -1,10 +0,0 @@
-import { ConfigImpl, DataImpl } from '../config.js';
-declare const _default: ({ msg, type, data, config, exitCode, condition, }: {
-    type?: string;
-    data: DataImpl;
-    exitCode?: number;
-    config: ConfigImpl;
-    msg: string | Error;
-    condition?: (config: ConfigImpl) => boolean;
-}) => void;
-export default _default;

package/dist/class/wrapper.js

@@ -1,29 +0,0 @@
-/*
- *  A wrapper function that handles all specifics
- *  before passing data to the render function.
- *  Created On 14 April 2021
- */
-import writeLog from './log.js';
-import renderer from './renderer.js';
-const getType = () => new Error().stack.split('\n')[3].trim().slice(10).split(' ')[0];
-export default ({ msg, type, data, config, exitCode, condition, }) => {
-    // check if there's a condition
-    const showOutput = condition ? condition(config) : true;
-    // set the type, incase it isn't already
-    if (!type)
-        type = getType();
-    // handle if Error or message string
-    if (typeof msg == 'object')
-        msg = msg.message;
-    // render the log message
-    const log = renderer(type, msg, config);
-    writeLog(log, type, config, data);
-    if (!showOutput)
-        return;
-    if (config.quietIdentifier.some(argument => process.argv.includes(argument)) == false) {
-        console.log(log);
-    }
-    // handle the exitCode
-    if (exitCode)
-        process.exit(exitCode);
-};

package/dist/config.d.ts

@@ -1,40 +0,0 @@
-/// <reference types="node" />
-import { FileHandle } from 'fs/promises';
-import Joi from 'joi';
-import { DateTime } from 'luxon';
-export declare enum typeCase {
-    'upper' = 0,
-    'lower' = 1,
-    'title' = 2
-}
-export interface ConfigImpl {
-    appName?: string;
-    bootLog?: boolean;
-    shutdownLog?: boolean;
-    clearOnSIGINT?: boolean;
-    quietIdentifier?: Array<string>;
-    verboseIdentifier?: Array<string>;
-    context?: {
-        name: string;
-        color: (str: string) => string;
-    };
-    theme?: {
-        string?: string;
-        colored?: boolean;
-        boldType?: boolean;
-        typeCase?: typeCase;
-        timeFormat?: string;
-    };
-    logs?: {
-        dir?: string;
-        error?: string;
-        output?: string;
-        enable?: boolean;
-    };
-}
-export declare const configSchema: Joi.ObjectSchema<any>;
-export interface DataImpl {
-    output?: FileHandle;
-    error?: FileHandle;
-    startedOn: DateTime;
-}

package/dist/config.js

@@ -1,38 +0,0 @@
-/*
- *  This file will contain code related to loading and storing configuration.
- *  Created On 11 October 2019
- */
-import Joi from 'joi';
-// typeCase enumerator will hold the
-// int values for type string case
-export var typeCase;
-(function (typeCase) {
-    typeCase[typeCase["upper"] = 0] = "upper";
-    typeCase[typeCase["lower"] = 1] = "lower";
-    typeCase[typeCase["title"] = 2] = "title";
-})(typeCase || (typeCase = {}));
-export const configSchema = Joi.object({
-    appName: Joi.string(),
-    bootLog: Joi.bool().required(),
-    shutdownLog: Joi.bool().required(),
-    clearOnSIGINT: Joi.bool().required(),
-    quietIdentifier: Joi.array().items(Joi.string()),
-    verboseIdentifier: Joi.array().items(Joi.string()),
-    context: Joi.object({
-        color: Joi.any().required(),
-        name: Joi.string().allow(null).required(),
-    }),
-    theme: Joi.object({
-        string: Joi.string().required(),
-        colored: Joi.bool(),
-        boldType: Joi.bool(),
-        typeCase: Joi.number(),
-        timeFormat: Joi.string(),
-    }),
-    logs: Joi.object({
-        dir: Joi.string().allow(null).required(),
-        output: Joi.string().required(),
-        error: Joi.string().required(),
-        enable: Joi.bool().required(),
-    }),
-});

package/dist/itivrutaha.d.ts

@@ -1,17 +0,0 @@
-import { Logger } from './class/index.js';
-import { ConfigImpl } from './config.js';
-declare const _default: {
-    /**
-     * Creates a new instance of a logger.
-     * @param config {ConfigImpl}
-     * @returns Logger
-     */
-    createNewLogger: (config?: ConfigImpl) => Promise<Logger>;
-    /**
-     * Deletes the log directory for a given logger.
-     * @param logger {Logger}
-     * @returns string[]
-     */
-    clearLogs: (logger: Logger) => Promise<string[]>;
-};
-export default _default;

package/dist/itivrutaha.js

@@ -1,118 +0,0 @@
-/*
- *  Entryfile for itivrutaha logging module.
- *  Created On 10 October 2019
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import chalk from 'chalk';
-import merge from 'deepmerge';
-import { deleteAsync } from 'del';
-import { DateTime } from 'luxon';
-import { readPackageUpSync } from 'read-pkg-up';
-import { Logger } from './class/index.js';
-import { open } from './class/log.js';
-import { typeCase } from './config.js';
-// Holds the default configuration which acts like a
-// replacement when no value is provided for a
-// particular configuration key
-const defaults = {
-    // The name of your app, if not provided
-    // the value will be determined by reading
-    // package.json of the above project.
-    appName: null,
-    // Whether to log when the logger is initialized.
-    bootLog: true,
-    // Whether to log when the Node.js process exits.
-    // Logs when terminating gracefully, due to an error
-    // or when POSIX signals are received.
-    shutdownLog: true,
-    // remove the "^C⏎" after terminating the process
-    // when Ctrl+C is pressed
-    clearOnSIGINT: true,
-    // Command-line arguments that suppress the output
-    // to the console if found.
-    quietIdentifier: ['--quiet', '-q'],
-    // Command-line arguments that render verbose message
-    // type to the console if found.
-    verboseIdentifier: ['--verbose', '-v'],
-    // Configuration for this particular logger.
-    // Useful when application has multiple loggers.
-    context: {
-        // Name of the context, example "app", "api",
-        // "bot", "server"...
-        name: null,
-        // Chalk color function for this context.
-        color: chalk.blueBright,
-    },
-    // Configuration options related to rendering the
-    // log messages to the console.
-    theme: {
-        // The theme string, that determines which variables
-        // are to be rendered.
-        string: `:time ${chalk.gray.dim('•')} :emoji :type :message`,
-        // Whether to log colored output
-        // or plain.
-        colored: true,
-        // Whether to render message type (":type" variable)
-        // in bold.
-        boldType: true,
-        // The character casing to render message type or
-        // the (":type" variable).
-        typeCase: typeCase.lower,
-        // Luxon time formatting used to render the
-        // ":time" variable. See 👇 for formatting guide
-        // https://moment.github.io/luxon/docs/manual/formatting.html#table-of-tokens
-        timeFormat: 'HH:mm:ss dd-LL-yyyy',
-    },
-    logs: {
-        // Whether to enable file logging or not.
-        enable: false,
-        // The directory where log files are saved.
-        dir: null,
-        // Filename for writing output (stdout)
-        // logs.
-        output: `output-${DateTime.local().toFormat('dd-LL-yyyy')}.log`,
-        // Filename for writing error (stderr)
-        // logs.
-        error: `error-${DateTime.local().toFormat('dd-LL-yyyy')}.log`,
-    },
-};
-// createNewLogger() will create a new instance of the logger class
-const createNewLogger = (config = defaults) => __awaiter(void 0, void 0, void 0, function* () {
-    // if custom properties were given merge those together
-    // with defaults so we have all properties defined
-    config = merge(defaults, config);
-    // fill out the fields which are specific to this
-    // particular instance of Logger
-    if (config.appName == null)
-        config.appName = readPackageUpSync().packageJson.name;
-    if (config.context.name)
-        config.theme.string = `:time ${chalk.gray.dim('•')} ${config.context.color(config.context.name)} :emoji :type :message`;
-    // initialize file logging according to the configuration
-    const data = yield open(config);
-    // return a new LoggerClass instance
-    return new Logger(config, data);
-});
-const clearLogs = (logger) => __awaiter(void 0, void 0, void 0, function* () { return yield deleteAsync(logger.config.logs.dir, { force: true }); });
-// Export the above two functions
-export default {
-    /**
-     * Creates a new instance of a logger.
-     * @param config {ConfigImpl}
-     * @returns Logger
-     */
-    createNewLogger,
-    /**
-     * Deletes the log directory for a given logger.
-     * @param logger {Logger}
-     * @returns string[]
-     */
-    clearLogs,
-};