Class CliCoreBase

Base class for building CLIs. By itself can be used for a CLI that does not support the tail command. Tail command uses Node repl class that is not implemented in other JS runtimes such as Bun. CliCoreBase should run in Bun.

Hierarchy (view full)

CliCoreBase
- default

Index

Constructors

constructor

new CliCoreBase(templateProcessor): CliCoreBase
Parameters
- templateProcessor: default
Returns CliCoreBase
- Defined in src/CliCoreBase.ts:40

Properties

`Protected` currentDirectory

currentDirectory: string

`Private` logLevel

logLevel: keyof LogLevel

onInit

onInit: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- Returns void | Promise<void>

`Private` server

server: Server<typeof IncomingMessage, typeof ServerResponse>

`Protected` templateProcessor

templateProcessor: default

Methods

cd

cd(newDirectory): string
Parameters
- newDirectory: string
Returns string
- Defined in src/CliCoreBase.ts:368

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/CliCoreBase.ts:46

color

color(): void
this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, it is not something that is possible to 'see' from the CLI since CLI returns pure JSON which has no concept of terminal colors.

Returns void
- Defined in src/CliCoreBase.ts:445

debug

debug(replCmdInputStr): Promise<any>
Parameters
- replCmdInputStr: string
Returns Promise<any>
- Defined in src/CliCoreBase.ts:325

errors

errors(): Promise<{
[key: JsonPointerString]: any;
}>
Returns Promise<{
[key: JsonPointerString]: any;
}>
- Defined in src/CliCoreBase.ts:333

`Protected` extractArgsInfo

extractArgsInfo(args): {
    format: string;
    jsonPointer: string;
    jsonataExpression: undefined;
    number: number;
} | {
    format: string;
    jsonPointer: string;
    jsonataExpression: string;
    number?: undefined;
}
Parameters
- args: string
Returns {
    format: string;
    jsonPointer: string;
    jsonataExpression: undefined;
    number: number;
} | {
    format: string;
    jsonPointer: string;
    jsonataExpression: string;
    number?: undefined;
}
- Defined in src/CliCoreBase.ts:340

flow

flow(replCmdInputStr): Promise<DataFlowNode[]>
Parameters
- replCmdInputStr: string
Returns Promise<DataFlowNode[]>
- Defined in src/CliCoreBase.ts:297

from

from(args): string[] | JsonPointerStructureArray[]
Parameters
- args: string
Returns string[] | JsonPointerStructureArray[]
- Defined in src/CliCoreBase.ts:281

getTemplateProcessor

getTemplateProcessor(): default
Returns default
- Defined in src/CliCoreBase.ts:449

in

in(): any
Returns any
- Defined in src/CliCoreBase.ts:252

init

init(replCmdInputStr, fromSnapshot?): Promise<any>
This Cli core command may be invoked directly from the REPL init command or from restore command
- fromSnapshot=false, replCmdInoutStr example: -f "example/ex23.json" --tags=["PEACE"] --xf=example/myEnv.json
- fromSnapshot=true, replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json
Parameters
- replCmdInputStr: string
- fromSnapshot: boolean = false
  when set to true, template processor will treat input as a snapshot of a previous templateProcessor state
Returns Promise<any>
- Defined in src/CliCoreBase.ts:152

log

log(level): {
log level: Levels;
}
Parameters
- level: Levels
Returns {
log level: Levels;
}
- log level: Levels
- Defined in src/CliCoreBase.ts:313

note

note(): string
Returns string
- Defined in src/CliCoreBase.ts:321

`Private` openFile

openFile(fname): Promise<any>
Parameters
- fname: string
Returns Promise<any>
- Defined in src/CliCoreBase.ts:212

out

out(replCmdInputStr): null | object
Parameters
- replCmdInputStr: string
Returns null | object
- Defined in src/CliCoreBase.ts:259

plan

plan(): Promise<string[]>
Returns Promise<string[]>
- Defined in src/CliCoreBase.ts:306

restore

restore(replCmdInputStr): Promise<any>
replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json
Parameters
- replCmdInputStr: string
  the command line string that will be parsed into arguments
Returns Promise<any>
- Defined in src/CliCoreBase.ts:137

set

set(args): Promise<{}>
Parameters
- args: string
Returns Promise<{}>
- Defined in src/CliCoreBase.ts:221

state

state(): Record<string, MetaInfo>
Returns Record<string, MetaInfo>
- Defined in src/CliCoreBase.ts:274

svg

svg(replCmdInputStr): string
Parameters
- replCmdInputStr: string
Returns string
- Defined in src/CliCoreBase.ts:381

tail

tail(args): Promise<any>
Parameters
- args: string
Returns Promise<any>
- Defined in src/CliCoreBase.ts:453

to

to(args): string[] | JsonPointerStructureArray[]
Parameters
- args: string
Returns string[] | JsonPointerStructureArray[]
- Defined in src/CliCoreBase.ts:289

`Static` isNodeEnvironment

isNodeEnvironment(): boolean
Returns boolean
- Defined in src/CliCoreBase.ts:104

`Static` minimistArgs

minimistArgs(replCmdInputStr): ParsedArgs
Parameters
- replCmdInputStr: string
Returns ParsedArgs
- Defined in src/CliCoreBase.ts:56

`Static` parseInitArgs

parseInitArgs(replCmdInputStr): {
    --?: string[];
    _: string[];
    ctx: any;
    filepath: any;
    oneshot: any;
    options: any;
    tags: any;
}
Parameters
- replCmdInputStr: string
Returns {
    --?: string[];
    _: string[];
    ctx: any;
    filepath: any;
    oneshot: any;
    options: any;
    tags: any;
}
- Optional --?: string[]
  If opts['--'] is true, populated with everything after the --
- _: string[]
  Contains all the arguments that didn't have an option associated with them
- ctx: any
- filepath: any
- oneshot: any
- options: any
- tags: any
- Defined in src/CliCoreBase.ts:61

`Static` readFileAndParse

readFileAndParse(filepath, importPath?): Promise<any>
Parameters
- filepath: string
- Optional importPath: string
Returns Promise<any>
- Defined in src/CliCoreBase.ts:87

`Static` resolveImportPath

resolveImportPath(filepath, importPath): string
Parameters
- filepath: any
- importPath: any
Returns string
- Defined in src/CliCoreBase.ts:109

Class CliCoreBase

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

templateProcessor: default

Returns CliCoreBase

Properties

Protected currentDirectory

Private logLevel

onInit

Type declaration

Returns void | Promise<void>

Private server

Protected templateProcessor

Methods

cd

Parameters

newDirectory: string

Returns string

close

Returns Promise<void>

color

Returns void

debug

Parameters

replCmdInputStr: string

Returns Promise<any>

errors

Returns Promise<{ [key: JsonPointerString]: any; }>

Protected extractArgsInfo

Parameters

args: string

Returns { format: string; jsonPointer: string; jsonataExpression: undefined; number: number; } | { format: string; jsonPointer: string; jsonataExpression: string; number?: undefined; }

flow

Parameters

replCmdInputStr: string

Returns Promise<DataFlowNode[]>

from

Parameters

args: string

Returns string[] | JsonPointerStructureArray[]

getTemplateProcessor

Returns default

in

Returns any

init

Parameters

replCmdInputStr: string

fromSnapshot: boolean = false

Returns Promise<any>

log

Parameters

level: Levels

Returns { log level: Levels; }

log level: Levels

note

Returns string

Private openFile

Parameters

fname: string

Returns Promise<any>

out

Parameters

replCmdInputStr: string

Returns null | object

plan

Returns Promise<string[]>

restore

Parameters

replCmdInputStr: string

Returns Promise<any>

set

Parameters

args: string

Returns Promise<{}>

`Protected` currentDirectory

`Private` logLevel

`Private` server

`Protected` templateProcessor

Returns Promise<{
[key: JsonPointerString]: any;
}>

`Protected` extractArgsInfo

Returns {
format: string;
jsonPointer: string;
jsonataExpression: undefined;
number: number;
} | {
format: string;
jsonPointer: string;
jsonataExpression: string;
number?: undefined;
}

Returns {
log level: Levels;
}

`Private` openFile

`Static` isNodeEnvironment

`Static` minimistArgs

`Static` parseInitArgs

Returns {
--?: string[];
_: string[];
ctx: any;
filepath: any;
oneshot: any;
options: any;
tags: any;
}

`Optional` --?: string[]

`Static` readFileAndParse

`Optional` importPath: string

`Static` resolveImportPath