rdme/dist/lib/logger.js

ReadMe's official CLI and GitHub Action.

import * as core from '@actions/core';
import chalk from 'chalk';
import debugModule from 'debug';
import { isGHA, isTest } from './isCI.js';
const debugPackage = debugModule('rdme');
/**
 * Wrapper for debug statements.
 */
function debug(input) {
    /* istanbul ignore next */
    if (isGHA() && !isTest()) {
        if (typeof input === 'object') {
            core.debug(`rdme: ${JSON.stringify(input)}`);
        }
        else {
            core.debug(`rdme: ${input}`);
        }
    }
    return debugPackage(input);
}
/**
 * Wrapper for error statements.
 */
function error(input) {
    /* istanbul ignore next */
    if (isGHA() && !isTest())
        return core.error(input);
    // eslint-disable-next-line no-console
    return console.error(chalk.red(input));
}
/**
 * Wrapper for info/notice statements.
 *
 * @deprecated use the base command's `this.info` method instead.
 */
function info(input, opts = {
    /** whether or not to prefix the statement with this emoji: ℹ️ */
    includeEmojiPrefix: true,
}) {
    /* istanbul ignore next */
    if (isGHA() && !isTest())
        return core.notice(input);
    /* istanbul ignore next */
    if (!opts.includeEmojiPrefix)
        return console.info(input); // eslint-disable-line no-console
    // eslint-disable-next-line no-console
    return console.info(`ℹ️  ${input}`);
}
function oraOptions() {
    const opts = {};
    // Cleans up ora output so it prints nicely alongside debug logs
    /* istanbul ignore next */
    if (debugPackage.enabled)
        opts.isEnabled = false;
    return opts;
}
/**
 * Wrapper for warn statements.
 *
 * @deprecated use the base command's `this.warn` method instead.
 */
function warn(
/**
 * Text that precedes the warning.
 * This is *not* used in the GitHub Actions-formatted warning.
 */
input, prefix = 'Warning!') {
    /* istanbul ignore next */
    if (isGHA() && !isTest())
        return core.warning(input);
    // eslint-disable-next-line no-console
    return console.warn(chalk.yellow(`⚠️  ${prefix} ${input}`));
}
export { debug, error, info, oraOptions, warn };