itivrutaha 2.0.15 → 3.0.0-beta.2

package/dist/config.d.ts

@@ -1,40 +1,23 @@
-/// <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
+import { ChalkInstance } from "chalk";
+export interface Scope<ScopeName> {
+    name: ScopeName;
+    color: ChalkInstance;
 }
-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 interface LogType<Name> {
+    name: Name;
+    emoji: string;
+    color: ChalkInstance;
 }
-export declare const configSchema: Joi.ObjectSchema<any>;
-export interface DataImpl {
-    output?: FileHandle;
-    error?: FileHandle;
-    startedOn: DateTime;
+export interface UnifiedData<ScopeName> {
+    scope?: ScopeName;
+    msg: string;
+    [key: string]: any;
 }
+export interface Config<ScopeName, LogTypeName> {
+    theme: string;
+    timeFormat: string;
+    scopes: Scope<ScopeName>[];
+    types: LogType<LogTypeName>[];
+}
+export declare function makeConfig<Scope extends string, LogTypeName extends string>(config: Config<Scope, LogTypeName>): Config<Scope, LogTypeName>;
+export declare const defaultConfig: Config<"app", "error" | "success" | "info" | "okay" | "note" | "verbose" | "warning">;

package/dist/config.js

@@ -1,38 +1,55 @@
 /*
- *  This file will contain code related to loading and storing configuration.
- *  Created On 11 October 2019
+ *  Contains configuration related code.
+ *  Created On 15 January 2024
  */
-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(),
-    }),
+import chalk from "chalk";
+export function makeConfig(config) {
+    return config;
+}
+export const defaultConfig = makeConfig({
+    theme: `:time ${chalk.gray.dim('•')} :scope :emoji :type :msg :data`,
+    timeFormat: 'hh:mm:ss dd-MM-yyyy',
+    scopes: [
+        {
+            name: 'app',
+            color: chalk.redBright
+        }
+    ],
+    types: [
+        {
+            name: 'success',
+            emoji: '✅',
+            color: chalk.greenBright,
+        },
+        {
+            name: 'info',
+            emoji: 'ℹ️',
+            color: chalk.blueBright,
+        },
+        {
+            name: 'okay',
+            emoji: '👍',
+            color: chalk.gray,
+        },
+        {
+            name: 'note',
+            emoji: '✍️',
+            color: chalk.magentaBright,
+        },
+        {
+            name: 'verbose',
+            emoji: '🧐',
+            color: chalk.cyanBright,
+        },
+        {
+            name: 'warning',
+            emoji: '⚠️',
+            color: chalk.yellowBright
+        },
+        {
+            name: 'error',
+            emoji: '🚨',
+            color: chalk.redBright
+        },
+    ]
 });

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { defaultConfig } from './config.js';
+export { itivrutaha } from './itivrutaha.js';

package/dist/index.js

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

package/dist/itivrutaha.d.ts

@@ -1,17 +1,2 @@
-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;
+import { Config, UnifiedData } from "./config.js";
+export declare function itivrutaha<Scope extends string, LogTypeName extends string>(config: Config<Scope, LogTypeName>): { [Type in LogTypeName]: (msgOrData: string | UnifiedData<Scope>, data?: any, scope?: Scope) => void; };

package/dist/itivrutaha.js

@@ -1,118 +1,12 @@
 /*
- *  Entryfile for itivrutaha logging module.
- *  Created On 10 October 2019
+ *  Contains an exportable logger function.
+ *  Created On 29 October 2023
  */
-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,
-};
+import { render } from "./renderer.js";
+export function itivrutaha(config) {
+    // return all the log functions
+    return config.types.reduce((previous, current) => ({
+        ...previous,
+        [current.name]: render(config, current)
+    }), {});
+}

package/dist/renderer.d.ts

@@ -0,0 +1,2 @@
+import { Config, LogType, UnifiedData } from './config.js';
+export declare function render<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>, type: LogType<LogTypeName>): (msgOrData: string | UnifiedData<ScopeName>, data?: any, scope?: ScopeName) => void;

package/dist/renderer.js

@@ -0,0 +1,37 @@
+/*
+ *  Renders a single log line by consuming an object.
+ *  Created On 15 January 2024
+ */
+import { filterObject } from './utilts.js';
+import * as variables from './variables/index.js';
+function line(config, type, msg, scopeName, data) {
+    // 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, msg)
+        .replace(/:data/g, variables.data(data)));
+}
+export function render(config, type) {
+    // consume all the log objects
+    return (msgOrData, data, scope) => {
+        // 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/dist/utilts.d.ts

@@ -0,0 +1 @@
+export declare function filterObject(obj: Record<string, any>, keysToExclude: string[]): Record<string, any>;

package/dist/utilts.js

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

package/dist/variables/data.d.ts

@@ -0,0 +1 @@
+export declare function data(input: any): string;

package/dist/variables/data.js

@@ -0,0 +1,35 @@
+/*
+ *  Renders the ":data" variable.
+ *  Created On 15 January 2024
+ */
+import chalk from 'chalk';
+import { highlight } from 'cli-highlight';
+function formatJSON(data) {
+    return JSON.stringify(data)
+        .replace(/{"/g, '{ "')
+        .replace(/"}/g, '" }')
+        .replace(/,"/g, ", \"")
+        .replace(/":/g, '": ');
+}
+export function data(input) {
+    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/dist/variables/emoji.d.ts

@@ -0,0 +1,2 @@
+import { LogType } from "../config.js";
+export declare function emoji<LogTypeName extends string>(type: LogType<LogTypeName>): string;

package/dist/variables/emoji.js

@@ -0,0 +1,7 @@
+/*
+ *  Renders the ":emoji" variable if an emoji is specified.
+ *  Created On 15 January 2024
+ */
+export function emoji(type) {
+    return type.emoji.trim();
+}

package/dist/variables/index.d.ts

@@ -0,0 +1,5 @@
+export * from './time.js';
+export * from './type.js';
+export * from './data.js';
+export * from './emoji.js';
+export * from './scope.js';

package/dist/variables/index.js

@@ -0,0 +1,9 @@
+/*
+ *  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/dist/variables/scope.d.ts

@@ -0,0 +1,2 @@
+import { Config } from "../config.js";
+export declare function scope<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>, scopeName?: ScopeName): string;

package/dist/variables/scope.js

@@ -0,0 +1,8 @@
+/*
+ *  Renders ":scope" variable with the current log line's scope.
+ *  Created On 15 January 2024
+ */
+export function scope(config, scopeName) {
+    const scope = scopeName ? config.scopes.find(sco => sco.name == scopeName) : config.scopes[0];
+    return scope.color(scope.name);
+}

package/dist/variables/time.d.ts

@@ -0,0 +1,2 @@
+import { type Config } from '../config.js';
+export declare function time<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>): string;

package/dist/variables/time.js

@@ -0,0 +1,9 @@
+/*
+ *  Renders the ":time" variable printing current time.
+ *  Created On 15 January 2024
+ */
+import chalk from 'chalk';
+import format from 'date-format';
+export function time(config) {
+    return chalk.gray.dim(format.asString(config.timeFormat));
+}

package/dist/variables/type.d.ts

@@ -0,0 +1,2 @@
+import { type LogType } from "../config.js";
+export declare function type<LogTypeName extends string>(type: LogType<LogTypeName>): string;

package/dist/variables/type.js

@@ -0,0 +1,7 @@
+/*
+ *  Renders the ":type" variable.
+ *  Created On 15 January 2024
+ */
+export function type(type) {
+    return type.color(type.name);
+}

package/examples/index.ts

@@ -0,0 +1,11 @@
+import { defaultConfig, itivrutaha } from '../dist/index.js'
+
+const log = itivrutaha(defaultConfig)
+
+log.error('some error')
+log.info('nice info')
+log.note('a useful note')
+log.okay(`it's okay`)
+log.success('that is a success')
+log.verbose('useful for developers')
+log.warning('something is going wrong')

package/package.json

@@ -1,16 +1,16 @@
 {
     "name": "itivrutaha",
-    "description": "( इतिवृत्तः ) — Logging system ✍ for Node.js with 🍬 theming and file 🗃 logging support.",
-    "version": "2.0.15",
+    "description": "",
+    "version": "3.0.0-beta.2",
     "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,50 +18,17 @@
     },
     "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.2.0",
-        "clear-terminal-line": "^0.0.1",
-        "deepmerge": "^4.3.1",
-        "del": "^7.0.0",
-        "env-paths": "^3.0.0",
-        "joi": "^17.9.1",
-        "luxon": "^3.3.0",
-        "mkdirp": "^3.0.0",
-        "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"
     },
     "devDependencies": {
-        "@types/luxon": "^3.3.0",
-        "@types/node": "^18.16.0",
-        "@types/node-cleanup": "^2.1.2",
-        "@types/node-emoji": "^1.8.2",
-        "@typescript-eslint/eslint-plugin": "^5.59.0",
-        "@typescript-eslint/parser": "^5.59.0",
-        "es-dirname": "^0.1.0",
-        "eslint": "^8.39.0",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-import": "^2.27.5",
-        "eslint-plugin-prettier": "^4.2.1",
-        "eslint-plugin-simple-import-sort": "^10.0.0",
-        "prettier": "^2.8.8",
-        "rimraf": "^5.0.0",
-        "typescript": "^5.0.4"
+        "@types/node": "^20.10.6",
+        "rimraf": "^5.0.5",
+        "typescript": "^5.3.3"
     }
 }

package/src/config.ts

@@ -0,0 +1,82 @@
+/*
+ *  Contains configuration related code.
+ *  Created On 15 January 2024
+ */
+
+import chalk, { ChalkInstance } from "chalk"
+
+export interface Scope<ScopeName> {
+    name: ScopeName
+    color: ChalkInstance
+}
+
+export interface LogType<Name> {
+    name: Name
+    emoji: string
+    color: ChalkInstance
+}
+
+export interface UnifiedData<ScopeName> {
+    scope?: ScopeName
+    msg: string
+    [key: string]: any
+}
+
+export interface Config<ScopeName, LogTypeName> {
+    theme: string
+    timeFormat: string
+    scopes: Scope<ScopeName>[]
+    types: LogType<LogTypeName>[]
+}
+
+export function makeConfig<Scope extends string, LogTypeName extends string>(config: Config<Scope, LogTypeName>) {
+    return config
+}
+
+export const defaultConfig = makeConfig({
+    theme: `:time ${chalk.gray.dim('•')} :scope :emoji :type :msg :data`,
+    timeFormat: 'hh:mm:ss dd-MM-yyyy',
+    scopes: [
+        {
+            name: 'app',
+            color: chalk.redBright
+        }
+    ],
+    types: [
+        {
+            name: 'success',
+            emoji: '✅',
+            color: chalk.greenBright,
+        },
+        {
+            name: 'info',
+            emoji: 'ℹ️',
+            color: chalk.blueBright,
+        },
+        {
+            name: 'okay',
+            emoji: '👍',
+            color: chalk.gray,
+        },
+        {
+            name: 'note',
+            emoji: '✍️',
+            color: chalk.magentaBright,
+        },
+        {
+            name: 'verbose',
+            emoji: '🧐',
+            color: chalk.cyanBright,
+        },
+        {
+            name: 'warning',
+            emoji: '⚠️',
+            color: chalk.yellowBright
+        },
+        {
+            name: 'error',
+            emoji: '🚨',
+            color: chalk.redBright
+        },
+    ]
+})