dslog v1.1.6

How To Start

Start a new node project and install typescrit and dslog.

  npm init
  npm i --save-dev typescript tslib @types/node
  npm i --save dslog

In your typescript config file set the types to be.

{
    "types": ["node", "tslib", "dslog"]
}

And then you can simply require the dslog object and define it as DSLogger.

See the code bellow to get started quickly.

Starter Code

const dsLog: DSLogger = require("dslog");
(async () => {
    dsLog
        //Define the program
        .defineSplashScreen(() => {
            dsLog
                .newScreen()
                .show(dsLog.getString("star"), "Raw")
                .logProgramTitle()
                .sleep(500);
        })
        .defineProgramTitle("[ DS TESTING ]")
        .defineHelpText("This is an easy command line tool.")
        //Add command line args
        .addParam({
            flag: "a",
            name: "auto",
            desc: "Auto parse",
            type: "boolean",
            required: false,
            valueNeeded: true,
        })
        .addParam({
            flag: "b",
            name: "batch",
            desc: "Auto batch",
            type: "string",
            required: false,
            valueNeeded: true,
        })
        .addParam({
            flag: "c",
            name: "cache",
            desc: "Auto cache",
            type: "number",
            required: false,
            valueNeeded: false,
        })
        .newScreen();
    //Get command line args
    (await dsLog.initProgramInput())
        //Check if they are set
        .ifParamIsset("a", (value: any, args: any) => {
            dsLog.showSleep(value, "Info");
        })
        .ifParamIsset("b", (value: any, args: any) => {
            dsLog.showSleep(value, "Info");
        })
        .ifParamIsset("c", (value: any, args: any) => {
            dsLog.showSleep(value, "Info");
        })
        .newScreen()
        .RAW.show(dsLog.getParam("a"))
        .show(dsLog.getParam("b"))
        .show(dsLog.getParam("c"))
        .sleep(1000)
        //Start a new screen
        .splashScreen()
        .BLINK.showSleep("BLINK")
        .INFO.showSleep("Some Info.")
        .GOOD.showSleep("Everything is fine.")
        .ERROR.showSleep("Everything is not fine.")
        .WARNING.showSleep("Something may be wrong.")
        .CLEAR.newScreen()
        //Add a progress and service bar
        .newProgressBar("test");
    await dsLog.incrementProgressBar("test", 100);
    dsLog.newServiceBar("test");
    (await dsLog.asyncSleep(3000))
        .destroyServiceBar("test")
        .newScreen()
        .showSleep("All good.", "Raw")
        .newScreen()
        //Get users input
        .show("Starting user input", "Info")
        .ask("enter name", "name", "string")
        .ask("enter num", "num", "number");
    (await dsLog.startPrompt())
        .showSleep(dsLog.getInput("name"), "Info")
        .restartPrompt()
        .ask("enter email", "email", "email")
        .ask("enter password", "pass", "password")
        .fail(true, "Password is not correct.", 3, () => {
            process.exit(0);
        })
        .ask("enter comment", "comment", "string");
    (await dsLog.startPrompt()).showSleep(dsLog.getInput("comment"), "Info");
})();

Documentation

Table Of Contents

• Program Params
• Show and Log Functions
  • Show vs Log
• User Input Functions
• User Keyboard Event Functions
• Progress Bar
• Service Bar
• Stylize Functions
• Groups
• Debug
• Directives
• Define and Get Functions
• Row and Collumn Functions
• Sleep Functions
• Do and Service Functions
• Other Functions

If you use this as a node module it will auto require "readline" which is built into node.

If you need to access readline later you can grab it from the dslog object.

Program Params

Functions related to getting command line input for the program.

dsLog
    .addParam({
        flag: "a",
        name: "auto",
        desc: "Auto parse",
        type: "string[]",
        required: false,
        valueNeeded: true,
    })
    .addParam({
        flag: "b",
        name: "batch",
        desc: "Batch parse",
        type: "boolean",
        required: false,
        valueNeeded: true,
    });
(await dsLog.initProgramInput())
    .ifParamIsset("a", (value: any, args: any) => {
        dsLog.logSleep(value);
    })
    .ifParamIsset("b", (value: any, args: any) => {
        dsLog.logSleep(value);
    })
    .logSleep(dsLog.getParam("b"));

Param Types

Param Object

Functions

Show and Log Functions

Functions related to logging to the console.

dsLog
    .defineSleepTime(300)
    .INFO.logSleep(["Info 1", "Info 2", { cool: "This is cool" }])
    .WARNING.logSleep(["Warning 1", "Warning 2"])
    .RAW.logTable({ someData: ["1", "2", "4"] })
    .GOOD.defineSleepTime(100)
    .logSleep(["It", "is", "all", "good"]).CLEAR;

Message Types

Functions

Show vs Log

Log functions just log the message without setting the console cursor. While show functions set the cursor then show the message. This can be usefull to show content at a specific row. Thoe normal log functions will work just for basic program outoput. Also, please note before using the show function it is best to clear the screen. And the progress bar and service bar use show functions not log functions right now. This is so you can have multiple of them and keep track of them.

User Input Functions

Functions related to getting the user's input.

dsLog
    .defineValidator(
        "custom",
        async (input: string | string[]) => {
            if (Array.isArray(input)) return false;
            let yes = ["yes", "y"];
            if (yes.indexOf(input) > -1) {
                return true;
            }
            return false;
        },
        "yes"
    )
    .ask("What is your name?", "name", "string")
    .fail(true, "Please re-enter your name.")
    .ask("What is your email?", "name", "email")
    .fail(true, "Please re-enter your email.")
    .ask("Do you agree to the terms?", "terms", "custom", "yes")
    .fail(true, "Are you sure? Please re-enter:", 2, () => {
        dsLog.BR.R.logSleep("Exiting...").exit();
    });
(await dsLog.startPrompt()).BRIGHT.BLUE.logSleep([
    "Your name is:",
    dsLog.getInput("name"),
]);

Question Types

Functions

User Keyboard Event Functions

User Input Keys

User Input Watch Object

Functions

dsLog
    .startUserInputCaptcher()
    .onUserInputKey("up", {
        run: () => {
            dsLog.INFO.log("up");
        },
    })
    .onUserInputKey("down", {
        run: () => {
            dsLog.INFO.log("down");
        },
    })
    .onUserInputKey("left", {
        run: () => {
            dsLog.INFO.log("left");
        },
    })
    .onUserInputKey("right", {
        run: () => {
            dsLog.INFO.log("right");
        },
    });

Progress Bar

Functions and types related to making a progress bar.

Progress Bar Style

Functions

Service Bar

Functions and types related to creating a service bar.

Progres Bar Style

Functions

Stylize Functions

Functions and types related to stylizing text.

Console Colors

Style Object

All properties are optional. | Name | Description | | ----------- | ------------------------------------------------------------------------------------ | | fg | Foreground color. Must be a ConsoleColor. | | bg | Background color. Must be a ConsoleColor. | | bright | Makes the colors bright. | | dim | Makes the colors dim. | | underscore| Makes the text underscored. | | blink | Makes the text blink | | reverse | Inverts the foreground and background colors. | | hidden | Makes the text hidden. |

Style Functions

Style Short Codes

The functions themselves will just return stylized text made from the chain. If you use the style alias it will set the style for the next set of outputs.

The example below will show a message with a bright red background and white text and then a bright blue background and white text. Notice that the style must be cleared in-between the messages. This is so you can just re-use the same style if you want.

dsLog
    .newScreen()
    .BR.W.RBG.showSleep("Error Message")
    .ERROR.showSleep(["Error Message", "Error Message 1", "Error Message 2"])
    .CLEAR.BR.W.BBG.showSleep("Info Message")
    .INFO.showSleep("Info Message 1")
    .showSleep("This will be the same style")
    .CLEAR.showSleep("This will not be.");

List of All Functions

Groups

Directives

Functions

Debug

Functions

    dsLog
        .debug()
        .DEBUG.logSleep(["This messages will log", "when debug is true"])
        .DEBUG.TRACE.log(["This message will be logged with console.trace."])
        .TRACE.TIME.sleep(2000).TIMEEND.DIE;

Directives

Directives are all cap vars in the class that will do things if you get them. In the style section each color and output style has it's own directive which can be called to stylize the next output. Every directive will just return DSLogger so you can chain them together.

Below are other directives and their uses.

dsLog.NS.BR.W.logSleep([
    "This will clear the screen",
    "log bright white text ",
    "and then stop",
]).NL.EXIT;

Define and Get Functions

Functions related to setting default strings, screens, and validation. This is for full customization of the program.

Strings

Built in strings. | Name | Description | | ----------- | ------------------------------------------------------------------------------------ | | title | Title of the program. | | helpText | Text used for the help screen. | | star | Star art. | | seperator| The seperator displayed when using logSeperator() | | questionStart | The string that appears at the start of a question. | | questionDelimiter | The string that appears at the end of a question. | | reAskStart | The string that appears at the start of a re-ask. | | reAskText | The string that appears as the default for a re-ask. | | reAskDelimiter | The string that appears at the end of a re-ask. |

QuestionDisplayTypes

Defined styles for the question outputs. | Name | Description | | ----------- | ------------------------------------------------------------------------------------ | | question-star | Style for question start string. | | question | Style for questions. | | delimiter | Style for question delimiter. | | re-ask-start| Style for re-ask start | | re-ask | Style for re-ask. | | re-ask-delimiter | Style for re-ask delimiter |

Screens

Built in screens. | Name | Description | | ----------- | ------------------------------------------------------------------------------------ | | splash | The program splash screen. | | programInitError | Program init error screen. | | helpScreen | A userful help screen generated from the program params. | | crash | A crash screen. | | done | A screen to show when the program is done. | | noInput | a screen to show when the program runs with no input. |

Functions

Row and Collumn Functions

Functions related to the output row.

Sleep Functions

Functions used to make the program sleep.

Do and Service Functions

Used for running a function in the command chain or starting a service. A service is just some code that runs on an interval.

dsLog
    .defineSleepTime(200)
    .do(() => {
        dsLog.BRIGHT.GREEN.logSleep(["do", "some", "stuff"]).CLEAR;
    })
    .newService("service-1", {
        interval: 2000,
        run: (args: any) => {
            args.count++;
            dsLog.NEWSCREEN.DIM.MAGENTA.UNDERLINE.logSleep(
                `RAN : ${args.count} TIMES`
            ).CLEAR.DIM.CYAN.logSleep(["running", "the", "service"]);
        },
        args: { count: 0 },
    });

Other Functions

Other usefull functions.