@gobstones/gobstones-scripts/src/Tasks/npx.ts

Scripts to abstract away build configuration of Gobstones Project's libraries and modules.

/*
 * *****************************************************************************
 * Copyright (C) National University of Quilmes 2018-2024
 * Gobstones (TM) is a trademark of the National University of Quilmes.
 *
 * This program is free software distributed under the terms of the
 * GNU Affero General Public License version 3.
 * Additional terms added in compliance to section 7 of such license apply.
 *
 * You may read the full license at https://gobstones.github.io/gobstones-guidelines/LICENSE.
 * *****************************************************************************
 */

/**
 * ----------------------------------------------------
 * @module Tasks
 * @author Alan Rodas Bonjour <alanrodas@gmail.com>
 * ----------------------------------------------------
 */

import { isNotDefined } from '../Helpers/isNotDefined';
import { TaskConfigurationError } from '../Helpers/TaskError';

/**
 * Returns the string for the bash command  to run
 * an npx command with the gobstones-script detected configuration.
 *
 * @param action - The npx action to run.
 *
 * @example npx('@11ty/eleventy')
 *
 * @returns The bash command string.
 */
export const npx = (action: string): string => {
    if (isNotDefined(action)) {
        throw new TaskConfigurationError('"npx" expects a defined npx action as argument');
    }
    return `npx ${action}`;
};