Go to repository

Interface CLIGeneralTexts

The general texts that a CLI app uses. This include the description texts that are used as the description of the different parts of the CLI. The name and the versionNumber are expected to be the app name (No translation is used, as the name should be the same through all the app), and the versionNumber should be the version in the major.minor.patch format.

interface CLIGeneralTexts {
    help: string;
    language?: string;
    languageError?: string;
    name: string;
    tool: string;
    version: string;
    versionNumber: string;
}

Properties

help language? languageError? name tool version versionNumber

Properties

help

help: string

A text displayed when showing the application's help

Optional

language

language?: string

The language used by the application

Optional

languageError

languageError?: string

The error message displayed when using a wrong language

name

name: string

The application name

tool

tool: string

Text used by the tool

version

version: string

The text displayed when showing the version of the application

versionNumber

versionNumber: string

The application version number in semVer

Settings

Member Visibility

On This Page

Properties