// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. import * as path from 'node:path'; import type { HeftConfiguration } from '../configuration/HeftConfiguration'; import type { IHeftTaskPlugin } from '../pluginFramework/IHeftPlugin'; import type { IHeftTaskSession, IHeftTaskRunHookOptions } from '../pluginFramework/HeftTaskSession'; interface IRunScriptPluginOptions { scriptPath: string; scriptOptions: Record; } /** * Options provided to scripts that are run using the RunScriptPlugin. * * @beta */ export interface IRunScriptOptions { heftTaskSession: IHeftTaskSession; heftConfiguration: HeftConfiguration; runOptions: IHeftTaskRunHookOptions; scriptOptions: Record; } /** * Interface used by scripts that are run by the RunScriptPlugin. * * @beta */ export interface IRunScript { /** * The method that is called by the RunScriptPlugin to run the script. */ runAsync: (options: IRunScriptOptions) => Promise; } const PLUGIN_NAME: 'run-script-plugin' = 'run-script-plugin'; export default class RunScriptPlugin implements IHeftTaskPlugin { public apply( heftTaskSession: IHeftTaskSession, heftConfiguration: HeftConfiguration, pluginOptions: IRunScriptPluginOptions ): void { heftTaskSession.hooks.run.tapPromise(PLUGIN_NAME, async (runOptions: IHeftTaskRunHookOptions) => { await this.#runScriptAsync(heftTaskSession, heftConfiguration, pluginOptions, runOptions); }); } async #runScriptAsync( heftTaskSession: IHeftTaskSession, heftConfiguration: HeftConfiguration, pluginOptions: IRunScriptPluginOptions, runOptions: IHeftTaskRunHookOptions ): Promise { const resolvedModulePath: string = path.resolve( heftConfiguration.buildFolderPath, pluginOptions.scriptPath ); const runScript: IRunScript = await import(resolvedModulePath); if (!runScript.runAsync) { throw new Error( `The script at ${JSON.stringify(resolvedModulePath)} doesn\'t export a "runAsync" function.` ); } const runScriptOptions: IRunScriptOptions = { heftTaskSession, heftConfiguration, runOptions, scriptOptions: pluginOptions.scriptOptions }; await runScript.runAsync(runScriptOptions); } }