Documentation for Simbo's Packages
    Preparing search index...

    Module @simbo/cli-output - v1.0.1

    CLI Output

    📦 @simbo/cli-output

    A collection utilities for common CLI messages and output.

    Install @simbo/cli-output from the npm registry:

    npm i [-D] @simbo/cli-output
    

    For a complete API reference, see the documentation.

    import {
    failure,
    hintToHelp,
    line,
    success,
    terminated,
    } from '@simbo/cli-output';

    // Success message with a green "✔":
    console.log(success(`Done.`));

    // Failure message with a red "✖":
    console.log(failure(`Failed.`));

    // Termination message with cause:
    console.log(terminated(`Received SIGINT`));

    // Hint to use "<COMMAND> --help":
    console.log(hintToHelp());

    // Draw a line:
    console.log(line());

    MIT © Simon Lepel

    Functions

    failure
    hintToHelp
    line
    success
    terminated