ci-scripts/lib/cmd/echo.js

Useful scripts to execute from your CI runner. For example, post to Slack and GitHub when your build completes:

const log = require('../effects/log');

/// `echo` script simply prints a message to standard output. Set
/// message in `--message` param.
///
/// ```shell
/// ci echo --message "Hello world!"
/// ```
const echo = (ci) => {
    /// Using `--eval` parameters get wrapped in template string literals and evaluated.
    /// You can use that to pring useful data.
    ///
    /// ```shell
    /// ci echo --message "Version: \${PROJECT_VERSION}" --eval
    /// ci echo --message "\${JSON.stringify(ci, null, 4)}" --eval
    /// ```
    const {message} = ci.params;

    if (typeof ci.params.message === 'undefined') {
        throw new TypeError('echo command requires a "message" parameter.');
    }

    // eslint-disable-next-line no-console
    log(ci, message);
};

module.exports = echo;