sv443 / jslib-npm

This npm package makes coding a bit faster by providing many advanced pre-built functions

This project now has a new home - https://github.com/Sv443/SvCoreLib is a continuation of this library

JSLib (npm) by Sv443

A multi-purpose, lightweight and dependency-free JavaScript library that makes coding faster by providing many easy to use functions and classes

Installation:

Enter this in your command line to download JSLib:

npm i svjsl

Then, import it in your script like this:

const jsl = require("svjsl");

These are some of the features JSLib offers:

> Create a dynamic, interactive menu prompt directly in the command line:

> Or create a progress bar:

> Other features include:

• Download files from the internet
• Generate random numbers based on a seed (same input seed = same numbers every time)
• Transform numbers to other numerical ranges
• Add some color to your console output
• Generate UUIDs with many pre-built numerical systems and even custom ones

...and many more! You can check out the full list here.

> > You can find the full JSLib documentation here < <

If you need any help, feel free to join my Discord server and I will help you as soon as possible:

---

Made with ❤️ by Sv443
Support me on Patreon, Ko-fi or PayPal

jslib-npm's Issues

Use other time measurement system for ping() since the perf_hooks way of doing it was deprecated

[Feature] jsl.reserialize() to serialize and deserialize a JSON object

This can be useful for copying JSON-compatible objects by value without copying the reference to the original variable.

Script doesn't work at all

examples.js is being used in the require("svjsl") instead of index.js

[Feature] Pause function that waits for user keypress

/**
 * Waits for the user to press a key and then calls the function passed in `callFunction`
 * @param {Function} callFunction
 */
function pauseThenCall(callFunction, text)
{
    process.stdout.write(`${text} `);
    process.stdin.resume();

    let keypressEvent = chunk => {
        if(process._jslPtcListenerAttached)
        {
            process.stdin.pause();
            removeKeypressEvent();

            // CTRL+C has to exit the process:
            if(chunk && chunk.match(/\u0003/gmu)) //eslint-disable-line no-control-regex
                return process.exit(0);

            return callFunction();
        }
    };

    let removeKeypressEvent = () => {
        process.stdin.removeListener("keypress", keypressEvent);
        process._jslPtcListenerAttached = false;
    };

    process.stdin.on("keypress", keypressEvent);
    process._jslPtcListenerAttached = true;
}

[Bug] Still some events in jsl.pause() that aren't unregistered

The "error" event is not unregistered, leading to a memory leak error:

See also #38

Function to recursively read directories and subdirectories

Something like var foo = jsl.readDirRecursiveSync("./folder")
and jsl.readDirRecursive("./folder"): Promise<String>

[Feature] Make the MenuPrompt class translatable / localizable

Example:

let mp = new jsl.MenuPrompt();

if(lang == "de")
    mp.locale.hello_world = "Hallo, Welt!";
else
    mp.locale.hello_world = "Hello, World!";

mp.addMenu(...);
mp.open();

Progress bar class

Code:

/**
 * Creates a dynamic progress bar with a percentage and custom message display
 * @param {Number} timesToUpdate How many times you will call ProgressBar.next() in total - example: 4 means you will need to call ProgressBar.next() exactly four times to reach 100% progress
 * @param {String} [initialMessage=""] Initial message that appears at 0% progress
 * @since 1.7.0
 */
const ProgressBar = class {
    constructor(timesToUpdate, initialMessage) {
        if(initialMessage == undefined) initialMessage = "";
        this.timesToUpdate = timesToUpdate;
        this.iteration = 1;
        this.progress = 0.0;
        this.progressDisplay = "";
        this.filledChar = "■";
        this.blankChar = "─";
        this.finishFunction = undefined;

        for(let i = 0; i < this.timesToUpdate; i++) this.progressDisplay += this.blankChar;

        this._update(initialMessage);
    }

    /**
     * Increment the progress bar. The amount of these functions should be known at the point of initially creating the ProgressBar object.
     * @param {String} message Message that should be displayed
     */
    next(message) { // increments the progress bar
        this.progress = (1 / this.timesToUpdate) * this.iteration;

        let pt = "";
        for(let i = 0; i < this.iteration; i++) pt += this.filledChar;
        this.progressDisplay = pt + this.progressDisplay.substring(this.iteration);
        
        this._update(message);
        this.iteration++;
    }

    _update(message) { // private method to update the console message
        if(this.iteration <= this.timesToUpdate) {
            if(message != "" && message != undefined) message = "- " + message;
            process.stdout.cursorTo(0);
            process.stdout.clearLine();
            process.stdout.write(`${(this.progress != 1.0 ? "\x1b[33m" : "\x1b[32m")}\x1b[1m${Math.round(this.progress * 100)}%\x1b[0m ${(Math.round(this.progress * 100) < 10 ? "  " : (Math.round(this.progress * 100) < 100 ? " " : ""))}[${this.progressDisplay.replace(new RegExp(this.filledChar, "gm"), "\x1b[32m\x1b[1m" + this.filledChar + "\x1b[0m")}] ${message}${(this.progress != 1.0 ? "" : "\n")}`);
            if(this.progress == 1.0 && this.finishFunction != undefined) this.finishFunction();
        }
    }

    /**
     * Executes a function once the progress reaches 100%
     * @param {Function} callback Function
     */
    onFinish(callback) {
        if(typeof callback != "function" || callback == undefined || callback == null) throw new Error("Wrong arguments provided for ProgressBar.onFinish() - (expected: \"Function\", got: \"" + typeof callback + "\")");
        this.finishFunction = callback;
    }

    /**
     * Get the current progress as a float value
     * @returns {Float}
     */
    getProgress() {
        return this.progress;
    }

    /**
     * Get the amount of increments that are still needed to reach 100% progress
     * @returns {Number}
     */
    getRemainingIncrements() {
        return (this.timesToUpdate - this.iteration >= 0 ? this.timesToUpdate - this.iteration : 0);
    }
}

Usage:

var pb = new ProgressBar(7, "Initializing...");
var ct = 0;

setInterval(()=>{
    pb.next("SomeMessage" + (ct + 1));
    ct++;
}, 1000);

pb.onFinish(()=>process.exit(0));

Add HTTP / HTTPS listener to listen for requests

[Feature] Add option "autoSubmit" to make having to press Enter optional

If option is set to true, ↵ doesn't have to be pressed to submit the value.
Default is false.

[Bug] npmignore file is missing some entries

• tools/
• .editorconfig
• package-gpr.json
• .vscode/

Update the documentation to be better readable and to include 1.8.0's features

[Feature] Instead of having one parameter, jsl.unused() should use a rest parameter

Rest parameter MDN reference

Example usage:

jsl.unused(var1, var2, var3);

Instead of:

jsl.unused([var1, var2, var3]);

Add counterpart of noShutdown()

Create function that re-enables the shutdown

[Bug] Fix typedefs for MenuPrompt

[Bug] The JSDoc documentation for jsl.seededRNG.generateSeededNumbers is wrong

Line 4 and 5 should use @prop instead of @param

jsl.settings doesn't work correctly

Sometimes returns "undefined"

[Bug] Add documentation for runUnitTests()

[Bug] Set stdin rawMode to true in MenuPrompt

process.stdin.setRawMode(true);

[Feature] Function that removes duplicates from an array

/**
 * Removes duplicate items in an array
 * @param {Array<*>} array An array with any values that can be compared with the [strict equality comparison](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Equality_comparisons_and_sameness)
 * @returns {Array<*>}
 */
function removeDuplicates(array) {
    return array.filter((a, b) => array.indexOf(a) === b);
}

[Bug] "jsl.pause()" doesn't unregister events -> leads to "stacking" line breaks

If jsl.pause() is used multiple times in the same process, due to the process.stdin.on("data") event not being unregistered, the callback and line breaks will be called multiple times, increasing by one each time jsl.pause() is used.
This might also result in the wrong callbacks being executed at the wrong time, causing bugs that are horrible to debug.

Example code:

let allFlags = ["nsfw", "religious", "political", "racist", "sexist"];

let flagIteration = idx => {
    if(idx >= allFlags.length)
        return flagIterFinished();
    else
    {
        jsl.pause(`Is this joke ${allFlags[idx]}? (y/N):`).then(key => {
            if(key.toLowerCase() == "y")
                joke["flags"][allFlags[idx]] = true;
            else joke["flags"][allFlags[idx]] = false;

            return flagIteration(++idx);
        }).catch(err => {
            console.error(`Error: ${err}`);
            return process.exit(1);
        });
    }
};

flagIteration(0);

Results in:

[Feature] jsl.randomItem() to get a random item of an array

[Feature] Function "jsl.inDebugger()" to see if the process is running in a debugger

function inDebugger()
{
    return (typeof v8debug === "object" || /--debug|--inspect/.test(process.execArgv.join(" ")))
}

[Bug] Remove signal "SIGKILL" from jsl.softShutdown()

SIGKILL has never worked but TIL that it throws an actual error on Linux but no other OSes.
See also: nodejs/node-v0.x-archive#6339 (comment)
Or: https://nodejs.org/api/process.html#process_signal_events

Add ping() function to ping URLs and return a status code

ping(URL, timeout) -> returns statusCode (200, 404, 401, ...)

Function to make Array readable

jsl.readableArray(array, separators, lastSeparator)

var array = [1, 2, 3, 4, 5, 6];
jsl.readableArray(array, ", ", "and") // returns "1, 2, 3, 4, 5 and 6"

[Bug] Directory not found in jsl.runUnitTests()

[Feature] Improve handling of two separate "package.json" files (for GPR and NPM)

Instead of having to update both files separately, just have a script generate the GPR-compatible package.json file automatically just before publishing the package to GPR.

1. Rename "package.json" to "package-npm.json"
2. Set the needed properties for GPR to accept the publish:

   • "publishConfig": {
         "registry": "https://npm.pkg.github.com/@Sv443"
     }

   • "name": "@sv443/svjsl"

3. Write the modified properties to "package.json"

ping() - parse out http_version, host and path attributes automatically and only have URL

ping("https", "www.google.com", "/") would turn into ping("https://www.google.com/")

[Bug] Unstranslatable text in MenuPrompt()

Line 173: "Exit"