@gobstones/gobstones-scripts
Version:
Scripts to abstract away build configuration of Gobstones Project's libraries and modules.
35 lines • 1.32 kB
TypeScript
/**
* Returns the gobstones-scripts banner that will be printed in CLI.
*
* @returns The gobstones-script banner.
*/
export declare const banner: () => string;
/**
* Returns the gobstones-scripts welcome message in the CLI.
*
* @returns The welcome message.
*/
export declare const welcome: () => string;
/**
* Display the welcome message of the gobstones-script tool
* and immediately after, the given message.
*
* @param message - The message to display after welcome.
*/
export declare const displayWelcomeForAction: (message: string) => void;
/**
* Run a function and print an error message if it fails.
* The action is expected to be executed and produce an error with a given
* message in some cases. errorsAndMessages matches on those inner messages
* and outputs the associated message to the user in a style with red background.
*
* @param action - A function to be executed and catch on failure.
* @param errorsAndMessages - An object associating inner
* possible error messages as keys and messages to output to the user as values.
*/
export declare const runOrEnd: (action: () => void) => void;
/**
* Print the currently used configuration when the options contain the argument.
*/
export declare const printConfiguration: () => void;
//# sourceMappingURL=cli-helpers.d.ts.map