itivrutaha 2.0.8 → 2.0.12

package/README.md

@@ -23,7 +23,7 @@
 
 **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">@vasanthdevelop</a>, I would love to know your opinion/experience on this project 😍
+> 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
 
@@ -68,7 +68,7 @@ To know more configuration options like **file logging**, **themes**, and **time
 * `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 src/example.js` to test `itivrutaha` with the latest compiled code.
+**Note:** Run `node examples/index.js` to test `itivrutaha` with the latest code.
 
 <!-- footer -->
 
@@ -76,7 +76,7 @@ To know more configuration options like **file logging**, **themes**, and **time
 > 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 2021 © Vasanth Developer.
 <hr>
 
-> <a href="https://vasanth.tech" target="_blank" rel="noopener">vasanth.tech</a> &nbsp;&middot;&nbsp;
+> <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">@vasanthdevelop</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/config.d.ts

@@ -8,28 +8,28 @@ export declare enum typeCase {
     'title' = 2
 }
 export interface ConfigImpl {
-    appName: string;
-    bootLog: boolean;
-    shutdownLog: boolean;
-    clearOnSIGINT: boolean;
-    quietIdentifier: Array<string>;
-    verboseIdentifier: Array<string>;
+    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;
+        string?: string;
+        colored?: boolean;
+        boldType?: boolean;
+        typeCase?: typeCase;
+        timeFormat?: string;
     };
-    logs: {
-        dir: string;
-        error: string;
-        output: string;
-        enable: boolean;
+    logs?: {
+        dir?: string;
+        error?: string;
+        output?: string;
+        enable?: boolean;
     };
 }
 export declare const configSchema: Joi.ObjectSchema<any>;

package/package.json

@@ -1,25 +1,25 @@
 {
     "name": "itivrutaha",
     "description": "( इतिवृत्तः ) — Logging system ✍ for Node.js with 🍬 theming and file 🗃 logging support.",
-    "version": "2.0.8",
+    "version": "2.0.12",
     "license": "MIT",
     "type": "module",
     "main": "dist/itivrutaha.js",
-    "homepage": "https://github.com/vasanthdeveloper/itivrutaha#readme",
-    "bugs": "https://github.com/vasanthdeveloper/itivrutaha/issues",
+    "homepage": "https://github.com/vsnthdev/itivrutaha#readme",
+    "bugs": "https://github.com/vsnthdev/itivrutaha/issues",
     "author": {
-        "name": "Vasanth Developer",
+        "name": "Vasanth Srivatsa",
         "email": "vasanth@vasanthdeveloper.com",
-        "url": "https://vasanth.tech"
+        "url": "https://vsnth.dev"
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/vasanthdeveloper/itivrutaha.git"
+        "url": "https://github.com/vsnthdev/itivrutaha.git"
     },
     "scripts": {
-        "dev": "concurrently 'tsc --watch' 'nodemon'",
-        "build": "rm -rf tsconfig.tsbuildinfo dist/ && tsc",
-        "docs": "rm -rf docs/ && node scripts/docs.js"
+        "dev": "tsc --watch",
+        "build": "rimraf ./dist && tsc --incremental false",
+        "docs": "rimraf docs/ && node scripts/docs.js"
     },
     "keywords": [
         "cli",
@@ -33,41 +33,36 @@
         "command-line"
     ],
     "dependencies": {
-        "chalk": "^4.1.1",
+        "chalk": "^5.0.0",
         "clear-terminal-line": "^0.0.1",
         "deepmerge": "^4.2.2",
         "del": "^6.0.0",
-        "env-paths": "^2.2.1",
-        "joi": "^17.4.1",
-        "luxon": "^2.0.1",
+        "env-paths": "^3.0.0",
+        "joi": "^17.5.0",
+        "luxon": "^2.2.0",
         "mkdirp": "^1.0.4",
         "node-cleanup": "^2.1.2",
-        "node-emoji": "^1.10.0",
-        "read-pkg-up": "^8.0.0",
-        "strip-ansi": "^7.0.0"
+        "node-emoji": "^1.11.0",
+        "read-pkg-up": "^9.0.0",
+        "strip-ansi": "^7.0.1"
     },
     "devDependencies": {
-        "@types/chalk": "^2.2.0",
-        "@types/deepmerge": "^2.2.0",
-        "@types/del": "^4.0.0",
-        "@types/env-paths": "^2.1.0",
-        "@types/joi": "^17.2.3",
-        "@types/luxon": "^1.27.1",
+        "@types/luxon": "^2.0.8",
         "@types/mkdirp": "^1.0.2",
-        "@types/node": "^16.3.3",
-        "@types/node-cleanup": "^2.1.1",
+        "@types/node": "^17.0.0",
+        "@types/node-cleanup": "^2.1.2",
         "@types/node-emoji": "^1.8.1",
-        "@typescript-eslint/eslint-plugin": "^4.28.3",
-        "@typescript-eslint/parser": "^4.28.3",
-        "concurrently": "^6.2.0",
+        "@typescript-eslint/eslint-plugin": "^5.7.0",
+        "@typescript-eslint/parser": "^5.7.0",
+        "concurrently": "^6.4.0",
         "es-dirname": "^0.1.0",
-        "eslint": "^7.30.0",
+        "eslint": "^8.4.1",
         "eslint-config-prettier": "^8.3.0",
-        "eslint-plugin-import": "^2.23.4",
-        "eslint-plugin-prettier": "^3.4.0",
+        "eslint-plugin-import": "^2.25.3",
+        "eslint-plugin-prettier": "^4.0.0",
         "eslint-plugin-simple-import-sort": "^7.0.0",
-        "nodemon": "^2.0.12",
-        "prettier": "^2.3.2",
-        "typescript": "^4.3.5"
+        "prettier": "^2.5.1",
+        "rimraf": "^3.0.2",
+        "typescript": "^4.5.4"
     }
-}
+}

package/.eslintrc.cjs

@@ -1,36 +0,0 @@
-/*
- *  ESLint run control.
- *  Created On 01 April 2021
- */
-
-module.exports = {
-    parser: '@typescript-eslint/parser',
-    plugins: ['prettier', 'simple-import-sort', '@typescript-eslint', 'import'],
-    extends: [
-        'eslint:recommended',
-        'plugin:prettier/recommended',
-        'plugin:@typescript-eslint/recommended',
-    ],
-    env: {
-        es2021: true,
-        node: true,
-    },
-    parserOptions: {
-        ecmaVersion: 12,
-        sourceType: 'module',
-    },
-    settings: {
-        'import/extensions': ['.js'],
-    },
-    rules: {
-        indent: ['error', 4],
-        'linebreak-style': ['error', 'unix'],
-        quotes: ['off', 'single'],
-        semi: ['error', 'never'],
-        'prettier/prettier': 'error',
-        'simple-import-sort/imports': 'error',
-        'sort-imports': 'off',
-        'import/order': 'off',
-        '@typescript-eslint/no-explicit-any': 'off',
-    },
-}

package/docs/Customization.md

@@ -1,133 +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>
-
-## 🛠 Customization
-
-```javascript
-import chalk from 'chalk'
-import itivrutaha from 'itivrutaha'
-
-// create a new instance of the logger
-const logger = await itivrutaha.createNewLogger({
-    // 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`,
-    },
-})
-```
-
-## ⚡️ Variables
-
-| Variable | Description |
-|-|-|
-| `:time` | 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. |
-| `:emoji` | Emoji according to the message type. |
-| `:message` | Log message in terminal's default color. |
-| `:node_path` | Full path to Node.js executable. |
-| `:type` | Message type (ie. info, warning, error, etc). |
-| `:script_path` | Full path of the Node.js entry JavaScript file. |
-| `:node_version` | Version of Node.js running. |
-| `:v8_version` | Version of V8 engine running along with Node.js. |
-| `:filename` | Filename of the Node.js entryfile. |
-| `:openssl_version` | Version of OpenSSL running along with Node.js. |
-| `:electron_version` | Version of Electron.js running. Returns `undefined` if not Electron. |
-
-
-## 📰 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 2021 © Vasanth Developer.
-<hr>
-
-> <a href="https://vasanth.tech" target="_blank" rel="noopener">vasanth.tech</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">@vasanthdevelop</a> &nbsp;&middot;&nbsp;
-> Discord <a href="https://vas.cx/discord" target="_blank" rel="noopener">Vasanth Developer</a>

package/examples/index.js

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

package/nodemon.json

@@ -1,9 +0,0 @@
-{
-    "quiet": true,
-    "verbose": false,
-    "ext": "ts",
-    "exec": "node scripts/docs.js",
-    "watch": [
-        "./src"
-    ]
-}

package/prettier.config.cjs

@@ -1,17 +0,0 @@
-/*
- *  Run control for Prettier.
- *  Created On 01 April 2021
- */
-
-module.exports = {
-    semi: false,
-    tabWidth: 4,
-    useTabs: false,
-    endOfLine: 'lf',
-    singleQuote: true,
-    trailingComma: 'all',
-    bracketSpacing: true,
-    arrowParens: 'avoid',
-    parser: 'typescript',
-    quoteProps: 'as-needed',
-}

package/scripts/docs.js

@@ -1,94 +0,0 @@
-/*
- *  Reads source code and builds documentation.
- *  Created On 19 April 2021
- */
-
-import chalk from 'chalk'
-import dirname from 'es-dirname'
-import fs from 'fs/promises'
-import mkdirp from 'mkdirp'
-import path from 'path'
-
-const dest = path.join(dirname(), '..', 'docs', 'Customization.md')
-
-const getHeaderFooter = async () => {
-    const readme = await fs.readFile(path.join(dirname(), '..', 'README.md'), {
-        encoding: 'utf-8',
-    })
-
-    const header = readme.split('<!-- header -->')[0].trim()
-    const footer = readme.split('<!-- footer -->')[1].trim()
-
-    return { header, footer }
-}
-
-const getCustomization = async () => {
-    const indexFile = await fs.readFile(
-        path.join(dirname(), '..', 'src', 'itivrutaha.ts'),
-        {
-            encoding: 'utf-8',
-        },
-    )
-
-    return indexFile
-        .split('const defaults: ConfigImpl = {')[1]
-        .split('\n}')[0]
-        .slice(1)
-}
-
-const getVariables = async () => {
-    const renderer = await fs.readFile(
-        path.join(dirname(), '..', 'src', 'class', 'renderer.ts'),
-        { encoding: 'utf-8' },
-    )
-
-    let returnable = ''
-
-    const lines = renderer
-        .split('// <!-- docs -->')[1]
-        .split('\n')
-        .map(line => line.trim())
-        .filter(line => line != '')
-        .join('\n')
-        .split('\n//')
-
-    for (const line of lines) {
-        const comment = line.split('\n')[0].replace('// ', '').trim()
-        const code = line.split('\n')[1].slice(10).split("'")[0]
-
-        returnable = `${returnable}| \`${code}\` | ${comment} |\n`
-    }
-
-    return returnable
-}
-
-const readme = await getHeaderFooter()
-const customization = await getCustomization()
-const variables = await getVariables()
-
-const contents = readme.header
-    .concat('\n\n## 🛠 Customization')
-    .concat('\n\n```javascript')
-    .concat(
-        `
-        import chalk from 'chalk'
-        import itivrutaha from 'itivrutaha'
-    `
-            .split('\n')
-            .map(line => line.trim())
-            .join('\n'),
-    )
-    .concat('\n// create a new instance of the logger')
-    .concat('\nconst logger = await itivrutaha.createNewLogger({\n')
-    .concat(customization)
-    .concat('\n})\n```')
-    .concat('\n\n## ⚡️ Variables')
-    .concat('\n\n| Variable | Description |')
-    .concat('\n|-|-|\n')
-    .concat(variables)
-    .concat('\n\n')
-    .concat(readme.footer)
-
-await mkdirp(path.dirname(dest))
-await fs.writeFile(dest, contents)
-console.log(`✅ ${chalk.greenBright.bold('Built')} ${dest}`)

package/src/class/index.ts

@@ -1,60 +0,0 @@
-/*
- *  This class which holds all the log functions.
- *  Created On 11 October 2019
- */
-
-import { ConfigImpl, configSchema, DataImpl } from '../config.js'
-import lifecycle from './lifecycle.js'
-import render from './wrapper.js'
-
-export class Logger {
-    // store the config and data globally
-    // relative to this class
-    public config: ConfigImpl
-    public data: DataImpl
-
-    // constructor() executes when the class is initialized
-    constructor(config: ConfigImpl, data: DataImpl) {
-        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)
-    }
-
-    public success = (msg: string): void =>
-        render({ msg, config: this.config, data: this.data })
-    public note = (msg: string): void =>
-        render({ msg, config: this.config, data: this.data })
-    public info = (msg: string): void =>
-        render({ msg, config: this.config, data: this.data })
-    public okay = (msg: string): void =>
-        render({ msg, config: this.config, data: this.data })
-
-    public warning = (msg: string | Error): void =>
-        render({ msg, config: this.config, data: this.data })
-    public error = (msg: string | Error, exitCode?: number): void =>
-        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
-    public verbose = (msg: string): void =>
-        render({
-            msg,
-            config: this.config,
-            data: this.data,
-            condition: () =>
-                this.config.verboseIdentifier.some(argument =>
-                    process.argv.includes(argument),
-                ),
-        })
-}

package/src/class/lifecycle.ts

@@ -1,79 +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 { ConfigImpl, DataImpl } from '../config'
-import { close } from './log.js'
-import render from './wrapper.js'
-
-const startup = (config: ConfigImpl, data: DataImpl): void => {
-    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: ConfigImpl, data: DataImpl, signal: string): void => {
-    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: ConfigImpl, data: DataImpl): void => {
-    startup(config, data)
-    cleanup((exitCode, signal) => {
-        shutdown(config, data, signal)
-    })
-}

package/src/class/log.ts

@@ -1,78 +0,0 @@
-/*
- *  Handles writing log files.
- *  Created On 15 April 2021
- */
-
-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'
-
-import { ConfigImpl, DataImpl } from '../config'
-
-export const close = async (close: boolean, data: DataImpl): Promise<void> => {
-    if (close && (data.error || data.output)) {
-        await data.output.close()
-        await data.error.close()
-    }
-}
-
-export const open = async (config: ConfigImpl): Promise<DataImpl> => {
-    // variable to store data
-    const data: DataImpl = {
-        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
-        await mkdirp(config.logs.dir)
-
-        // open log files
-        data.output = await fs.open(
-            path.join(config.logs.dir, config.logs.output),
-            'a',
-            0o666,
-        )
-
-        data.error = await 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 async (
-    log: string,
-    type: string,
-    config: ConfigImpl,
-    data: DataImpl,
-): Promise<void> => {
-    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!
-    await data[stream].appendFile(log)
-}

package/src/class/renderer.ts

@@ -1,49 +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 { ConfigImpl } from '../config.js'
-import emoji from './variables/emoji.js'
-import time from './variables/time.js'
-import type from './variables/type.js'
-
-export default (typeStr: string, msg: string, config: ConfigImpl): string =>
-    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/src/class/variables/emoji.ts

@@ -1,19 +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: string): string =>
-    emoji.emojify(`:${emojis[type]}:`).trim()

package/src/class/variables/time.ts

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

package/src/class/variables/type.ts

@@ -1,50 +0,0 @@
-/*
- *  This file will render the ":type" variable in the theme.
- *  Created On 12 October 2019
- */
-
-import chalk from 'chalk'
-
-import { ConfigImpl } from '../../config.js'
-
-// bold() will make the text bold
-const bold = (type: string, config: ConfigImpl): string =>
-    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: string, config: ConfigImpl): string => {
-    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: string, config: ConfigImpl): string => {
-    const toTitleCase = (str): string =>
-        str.replace(
-            /\w\S*/g,
-            txt => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase(),
-        )
-
-    const func = {
-        0: (str: string) => str.toUpperCase(),
-        1: (str: string) => str.toLowerCase(),
-        2: (str: string) => toTitleCase(str),
-    }
-
-    return colorize(func[config.theme.typeCase](type), config)
-}
-
-export default (type: string, config: ConfigImpl): string =>
-    casing(type, config)

package/src/class/wrapper.ts

@@ -1,52 +0,0 @@
-/*
- *  A wrapper function that handles all specifics
- *  before passing data to the render function.
- *  Created On 14 April 2021
- */
-
-import { ConfigImpl, DataImpl } from '../config.js'
-import writeLog from './log.js'
-import renderer from './renderer.js'
-
-const getType = (): string =>
-    new Error().stack.split('\n')[3].trim().slice(10).split(' ')[0]
-
-export default ({
-    msg,
-    type,
-    data,
-    config,
-    exitCode,
-    condition,
-}: {
-    type?: string
-    data: DataImpl
-    exitCode?: number
-    config: ConfigImpl
-    msg: string | Error
-    condition?: (config: ConfigImpl) => boolean
-}): void => {
-    // 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/src/config.ts

@@ -1,76 +0,0 @@
-/*
- *  This file will contain code related to loading and storing configuration.
- *  Created On 11 October 2019
- */
-
-import { FileHandle } from 'fs/promises'
-import Joi from 'joi'
-import { DateTime } from 'luxon'
-
-// typeCase enumerator will hold the
-// int values for type string case
-export enum typeCase {
-    'upper',
-    'lower',
-    'title',
-}
-
-// The skeleton which has all possible
-// settings passable to the Logger
-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 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(),
-    }),
-})
-
-export interface DataImpl {
-    output?: FileHandle
-    error?: FileHandle
-    startedOn: DateTime
-}

package/src/itivrutaha.ts

@@ -1,140 +0,0 @@
-/*
- *  Entryfile for itivrutaha logging module.
- *  Created On 10 October 2019
- */
-
-import chalk from 'chalk'
-import merge from 'deepmerge'
-import del 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 { ConfigImpl, 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: ConfigImpl = {
-    // 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 = async (
-    config: ConfigImpl = defaults,
-): Promise<Logger> => {
-    // 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 = await open(config)
-
-    // return a new LoggerClass instance
-    return new Logger(config, data)
-}
-
-const clearLogs = async (logger: Logger): Promise<string[]> =>
-    await del(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,
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-    "compileOnSave": true,
-    "compilerOptions": {
-        "alwaysStrict": true,
-        "charset": "UTF-8",
-        "declaration": true,
-        "esModuleInterop": true,
-        "moduleResolution": "node",
-        "module": "ESNext",
-        "newLine": "LF",
-        "preserveConstEnums": true,
-        "rootDir": "src/",
-        "outDir": "dist/",
-        "target": "ES2015",
-        "incremental": true
-    }
-}