ci-scripts/lib/cmd/cmd.js

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

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

/// `cmd` command allows you to execute any arbitrary command. It allows you
/// to construct command arguments and environment variables using variables
/// provided by [`cross-ci`](https://github.com/streamich/cross-ci). In your
/// `ci.config.js` create a new command definition, say "release":
///
/// ```js
/// module.exports = {
///   cmd: {
///     release: {
///       params: {
///         command: 'python',
///         args: ({PROJECT_NAME}) => ['./release.py', PROJECT_NAME, 'staging'],
///         env: ({PROJECT_NAME, BUILD_VERSION}) => ({
///           DEPLOY_PATH: `builds/${PROJECT_NAME}/${BUILD_VERSION}`
///         })
///       },
///     }
///   }
/// };
/// ```
///
/// Now you can execute this command.
///
/// ```
/// ci cmd release
/// ```
///
/// Or only print what will this command do, without executing.
///
/// ```
/// ci cmd release --plan
/// ```
const cmd = async (ci) => {
    /// ### Parameters
    ///
    /// - `--command` — command to execute.
    /// - `--args` — array of arguments to supply to command.
    /// - `--env` — a map of environemnt variables to add to the command.
    /// - `--shell` — boolean, specifying whether to execute command in console.
    /// - `--cwd` — current working directory, defaults to `process.cwd()`.
    const {params} = ci;

    // eslint-disable-next-line prefer-const
    let {command, args = [], env = {}, shell} = params;

    if (!command) {
        throw new Error('--command not specified.');
    }

    if (typeof command !== 'string') {
        throw new TypeError('--command must be a string.');
    }

    if (typeof args === 'string') {
        args = [args];
    }

    if (!Array.isArray(args)) {
        throw new TypeError('--args must be an array.');
    }

    if (typeof env !== 'object') {
        throw new TypeError('--env must be a map.');
    }

    const opts = {
        command,
        args,
        env,
        shell: Boolean(shell),
    };

    await exec(ci, opts);
};

module.exports = cmd;