europa-build/lib/cjs/script/ScriptRunner.d.ts

Tool for generating and maintaining Europa plugins and presets

import { LoggableOptions } from "../logger/Logger";
declare const _logger: unique symbol;
declare const _providers: unique symbol;
/**
 * A runner for scripts that relate to generated plugin and preset packages.
 */
export declare class ScriptRunner {
    private readonly [_logger];
    private readonly [_providers];
    /**
     * Creates an instance of {@link ScriptRunner} using the `options` provided.
     *
     * @param [options] - The options to be used.
     */
    constructor(options?: ScriptRunnerOptions);
    /**
     * Returns the names of all available scripts.
     *
     * @return The available script names.
     */
    getScriptNames(): string[];
    /**
     * Runs the script with the specified name using the `options` provided.
     *
     * @param scriptName - The name of the script to run.
     * @param [options] - The options to be used.
     * @throws If no script could be found for `scriptName` or if any error occurs while running the script.
     */
    run(scriptName: string, options?: ScriptRunnerRunOptions): Promise<void>;
}
/**
 * The options used by {@link ScriptRunner}.
 */
export declare type ScriptRunnerOptions = LoggableOptions;
/**
 * The options used by {@link ScriptRunner#run}.
 */
export declare type ScriptRunnerRunOptions = {
    /**
     * The current working directory to be used to resolve relative file paths. Defaults to the current working directory.
     */
    readonly cwd?: string;
};
export {};