jinju v0.0.1-beta.0

Opinionated Node CLI Toolkit

API

Jump to:

• celebrate
• debug
• fail
• spinner
• success
• warn

Celebrate

celebrate(message: string, context?: string)

Renders a celebration message, with optional context. If context is provided it is rendered dimmer than the message.

💡 Much like success, it can be used as a different type of positive message, like completing the process.

Example

import { celebrate } from 'jinju';

celebrate('Complete!');

celebrate('Complete!', 'On server A');

Debug

debug(message: string)

Renders a debug message.

💡 Provides additional information without distracting from the core message output.

Example

Debug is enabled by default.

import { debug } from 'jinju';

debug('Found record');

You can disable debug message by setting the config's debug value to false. In the example below the debug message will not be output.

import { config, debug } from 'jinju';

config.debug = false;

debug('Found record');

Fail

fail(message: string, context?: string)

Renders a failure message, with optional context. If context is provided it is rendered dimmer than the message.

💡 Can be used to indicate a failure or error.

Example

import { fail } from 'jinju';

fail('Could not read file');

fail('Could not read file', './config.json');

Spinner

Returns a spinner instance.

💡 Showing feedback during asynchronous processes.

spinner.start(message: string)

Starts the spinner with the provided message.

spinner.text

Can be used to update the spinner's message.

spinner.stop()

Stops the spinner and removes it from the output.

Note If you don't call spinner.stop(), the process will not end until explicitly exited.

Example

import { spinner } from 'jinju';

spinner.start('Running some process');

await someProcess();

spinner.text = 'Running another process';

await anotherProcess();

spinner.stop();

Success

success(message: string, context?: string)

Renders a success message, with optional context. If context is provided it is rendered dimmer than the message.

💡 Can be used to indicate an action has resolved as expected.

Example

import { success } from 'jinju';

success('Connected to server');

success('Connected to server', 'https://a.server.com');

Warn

warn(message: string, context?: string)

Renders a warning message, with optional context. If context is provided it is rendered dimmer than the message.

💡 Can be used to provide awareness to a non-ideal resolution.

Example

import { success } from 'jinju';

success('Connected to server');

success('Connected to server', 'https://a.server.com');