FULLY-CONSULLY

This library helps your in create console application. It have simple utilites for listen command, output colored line and converting input line to Object command for work with him.

1. Color decorate, screen or line clear (ConsoleWorker, LineBuilder)

import { ConsoleWorker } from "fully-consully";

ConsoleWorker.cls();//clear all console
ConsoleWorker.info('some info');//print text marked blue prefix [i]

import { LineBuilder, STYLE } from "fully-consully";

//building colored line
let someLine = new LineBuilder()
let text = someLine
    .addStyle(STYLE.FGBLUE)
    .addStyle(STYLE.BGBLACK)
    .add('this text have style')
    .add(' but this dont have one')
    .build()

console.log(text)

2. Command parser from line to object (Command)

This module allow parse user command from line console and directing app

user send comand like:

commandname parameterWithoutArgument parametrTwoWithoutArgument -paremetrWithArgument argumentForThisParametr

this command parse to object with fields:

fields | description ----------------------------|----- name: string | commandname execute:(command:Command) | callback execute when invoked this command flags: Flag[] | [parameterWithoutArgument,parametrTwoWithoutArgument] parameters: Parameter[] | [{paremetrWithArgument:argumentForThisParametr}] help: string | some text for user help

import { Command, Flag, Parametr } from "fully-consully";

let lineCommand = 'commandname parameterWithoutArgument parametrTwoWithoutArgument --paremetrWithArgument argumentForThisParametr'
let command = Command.fromLine(lineCommand) //convert object command from string

//Or create command object for output help

let commandForHelp=new Command('namecommand',(cmd)=>{console.log(cmd.name)},'help for this command')
commandForHelp
    .appendFlag(new Flag('parameterWithoutArgument','help string for this'))
    .appendFlag(new Flag('parametrTwoWithoutArgument','help string for this'))
    .appendParameter(new Parametr('paremetrWithArgument',0 /**'default value for this'*/, 'help string for this'))

console.log(commandForHelp.helpStr())//output full help for this command and it arguments

3. Get user command {ConsoleListener}

let listener = new ConsoleListener()
    .appendCommand(new Command('example',(cmd)=>{console.log(cmd.name)}))
    .appendCommand(new Command('nextcommand',(cmd)=>{console.log(cmd.flag[0])}))
    .run()

listener.HELP_COMMAND='help' //print (help) in console for output full helps