Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apps/heft/src/cli/HeftActionRunner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,8 @@ export class HeftActionRunner {
// executed, and the session should be populated with the executing parameters.
this.#internalHeftSession.parameterManager = this.parameterManager;

this.parameterManager.validateParameters();

initializeHeft(this.#heftConfiguration, terminal, this.parameterManager.defaultParameters.verbose);

const operations: ReadonlySet<Operation<IHeftTaskOperationMetadata, IHeftPhaseOperationMetadata>> =
Expand Down
12 changes: 12 additions & 0 deletions apps/heft/src/configuration/HeftPluginDefinition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,18 @@ export interface IBaseParameterJson {
* If true, then this parameter must be included on the command line.
*/
required?: boolean;
/**
* If false, reject an active parameter when running with `--clean`, before any plugins run or outputs
* are deleted. Defaults to true. A parameter is active when its flag is true, its list is nonempty,
* or its scalar value is defined, including default values.
*/
allowWithClean?: boolean;
/**
* If false, reject an active parameter in watch mode, before any plugins run or outputs are deleted.
* Defaults to true. A parameter is active when its flag is true, its list is nonempty, or its scalar
* value is defined, including default values.
*/
allowInWatchMode?: boolean;
}

/**
Expand Down
56 changes: 56 additions & 0 deletions apps/heft/src/pluginFramework/HeftParameterManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,23 @@ export class HeftParameterManager {
}
}

/**
* Validate effective parameter values after parsing and before executing the action.
*/
public validateParameters(): void {
const defaultParameters: IHeftDefaultParameters = this.defaultParameters;
this.#parametersByDefinition.forEach((parameters, pluginDefinition) => {
pluginDefinition.pluginParameters.forEach((definition) => {
validateParameter(
parameters.get(definition.longName)!,
definition,
pluginDefinition,
defaultParameters
);
});
});
}

/**
* Get the finalized parameters for the specified plugin definition.
*/
Expand Down Expand Up @@ -397,3 +414,42 @@ export class HeftParameterManager {
return parameter as T;
}
}

export function validateParameter(
parameter: CommandLineParameter,
definition: IParameterJson,
pluginDefinition: HeftPluginDefinitionBase,
{ clean, watch }: Pick<IHeftDefaultParameters, 'clean' | 'watch'>
): void {
const disallowedWithClean: boolean = clean && definition.allowWithClean === false;
const disallowedInWatchMode: boolean = watch && definition.allowInWatchMode === false;
if (!disallowedWithClean && !disallowedInWatchMode) {
return;
}

let isActive: boolean;
switch (parameter.kind) {
case CommandLineParameterKind.Flag:
isActive = parameter.value;
break;
case CommandLineParameterKind.ChoiceList:
case CommandLineParameterKind.IntegerList:
case CommandLineParameterKind.StringList:
isActive = parameter.values.length > 0;
break;
default:
isActive = parameter.value !== undefined;
break;
}
if (isActive) {
const parameterName: string = parameter.scopedLongName || parameter.longName;
const mode: string = disallowedWithClean ? '--clean' : 'watch mode';
const remedy: string = disallowedWithClean ? 'without --clean' : 'in a non-watch action';
throw new Error(
`Parameter ${JSON.stringify(parameterName)} from plugin ` +
`${JSON.stringify(pluginDefinition.pluginName)} in package ` +
`${JSON.stringify(pluginDefinition.pluginPackageName)} cannot be used with ${mode}. ` +
`Run ${remedy}, or remove the parameter (including any configured default value).`
);
}
}
Loading
Loading