Skip to content

[heft] Refactor Heft parameter manager. #5204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iclanton merged 1 commit into from
Apr 23, 2025
Merged

[heft] Refactor Heft parameter manager. #5204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
125 changes: 70 additions & 55 deletions apps/heft/src/pluginFramework/HeftParameterManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ export interface IHeftParameterManagerOptions {

export class HeftParameterManager {
private readonly _options: IHeftParameterManagerOptions;
// plugin defintiion => parameter accessors and defaults
// plugin definition => parameter accessors and defaults
private readonly _heftParametersByDefinition: Map<HeftPluginDefinitionBase, IHeftParameters> = new Map();
// plugin definition => Map< parameter long name => applied parameter >
private readonly _parametersByDefinition: Map<HeftPluginDefinitionBase, Map<string, CommandLineParameter>> =
Expand Down Expand Up @@ -240,110 +240,125 @@ export class HeftParameterManager {
/**
* Add the parameters specified by a plugin definition to the command line parameter provider.
* Duplicate parameters are allowed, as long as they have different parameter scopes. In this
* case, the parameter will only be referencable by the CLI argument
* case, the parameter will only be referenceable by the CLI argument
* "--<parameterScope>:<parameterName>". If there is no duplicate parameter, it will also be
* referencable by the CLI argument "--<parameterName>".
* referenceable by the CLI argument "--<parameterName>".
*/
private _addParametersToProvider(
pluginDefinition: HeftPluginDefinitionBase,
commandLineParameterProvider: CommandLineParameterProvider
): void {
const {
pluginName,
pluginPackageName,
pluginParameterScope: parameterScope,
pluginParameters
} = pluginDefinition;
const existingDefinitionWithScope: HeftPluginDefinitionBase | undefined =
this._pluginDefinitionsByScope.get(pluginDefinition.pluginParameterScope);
this._pluginDefinitionsByScope.get(parameterScope);
if (existingDefinitionWithScope && existingDefinitionWithScope !== pluginDefinition) {
const { pluginName: existingScopePluginName, pluginPackageName: existingScopePluginPackageName } =
existingDefinitionWithScope;
throw new Error(
`Plugin ${JSON.stringify(pluginDefinition.pluginName)} in package ` +
`${JSON.stringify(pluginDefinition.pluginPackageName)} specifies the same parameter scope ` +
`${JSON.stringify(pluginDefinition.pluginParameterScope)} as plugin ` +
`${JSON.stringify(existingDefinitionWithScope.pluginName)} from package ` +
`${JSON.stringify(existingDefinitionWithScope.pluginPackageName)}.`
`Plugin ${JSON.stringify(pluginName)} in package ` +
`${JSON.stringify(pluginPackageName)} specifies the same parameter scope ` +
`${JSON.stringify(parameterScope)} as plugin ` +
`${JSON.stringify(existingScopePluginName)} from package ` +
`${JSON.stringify(existingScopePluginPackageName)}.`
);
} else {
this._pluginDefinitionsByScope.set(pluginDefinition.pluginParameterScope, pluginDefinition);
this._pluginDefinitionsByScope.set(parameterScope, pluginDefinition);
}

const definedPluginParametersByName: Map<string, CommandLineParameter> =
this._parametersByDefinition.get(pluginDefinition)!;

for (const parameter of pluginDefinition.pluginParameters) {
for (const parameter of pluginParameters) {
let definedParameter: CommandLineParameter;
const { description, required, longName: parameterLongName, shortName: parameterShortName } = parameter;
switch (parameter.parameterKind) {
case 'choiceList': {
const { alternatives } = parameter;
definedParameter = commandLineParameterProvider.defineChoiceListParameter({
description: parameter.description,
required: parameter.required,
alternatives: parameter.alternatives.map((p: IChoiceParameterAlternativeJson) => p.name),
parameterLongName: parameter.longName,
parameterShortName: parameter.shortName,
parameterScope: pluginDefinition.pluginParameterScope
description,
required,
alternatives: alternatives.map((p: IChoiceParameterAlternativeJson) => p.name),
parameterLongName,
parameterShortName,
parameterScope
});
break;
}
case 'choice': {
const { alternatives, defaultValue } = parameter;
definedParameter = commandLineParameterProvider.defineChoiceParameter({
description: parameter.description,
required: parameter.required,
alternatives: parameter.alternatives.map((p: IChoiceParameterAlternativeJson) => p.name),
defaultValue: parameter.defaultValue,
parameterLongName: parameter.longName,
parameterShortName: parameter.shortName,
parameterScope: pluginDefinition.pluginParameterScope
description,
required,
alternatives: alternatives.map((p: IChoiceParameterAlternativeJson) => p.name),
defaultValue,
parameterLongName,
parameterShortName,
parameterScope
});
break;
}
case 'flag': {
definedParameter = commandLineParameterProvider.defineFlagParameter({
description: parameter.description,
required: parameter.required,
parameterLongName: parameter.longName,
parameterShortName: parameter.shortName,
parameterScope: pluginDefinition.pluginParameterScope
description,
required,
parameterLongName,
parameterShortName,
parameterScope
});
break;
}
case 'integerList': {
const { argumentName } = parameter;
definedParameter = commandLineParameterProvider.defineIntegerListParameter({
description: parameter.description,
required: parameter.required,
argumentName: parameter.argumentName,
parameterLongName: parameter.longName,
parameterShortName: parameter.shortName,
parameterScope: pluginDefinition.pluginParameterScope
description,
required,
argumentName,
parameterLongName,
parameterShortName,
parameterScope
});
break;
}
case 'integer': {
const { argumentName, defaultValue } = parameter;
definedParameter = commandLineParameterProvider.defineIntegerParameter({
description: parameter.description,
required: parameter.required,
argumentName: parameter.argumentName,
defaultValue: parameter.defaultValue,
parameterLongName: parameter.longName,
parameterShortName: parameter.shortName,
parameterScope: pluginDefinition.pluginParameterScope
description,
required,
argumentName,
defaultValue,
parameterLongName,
parameterShortName,
parameterScope
});
break;
}
case 'stringList': {
const { argumentName } = parameter;
definedParameter = commandLineParameterProvider.defineStringListParameter({
description: parameter.description,
required: parameter.required,
argumentName: parameter.argumentName,
parameterLongName: parameter.longName,
parameterShortName: parameter.shortName,
parameterScope: pluginDefinition.pluginParameterScope
description,
required,
argumentName,
parameterLongName,
parameterShortName,
parameterScope
});
break;
}
case 'string': {
const { argumentName, defaultValue } = parameter;
definedParameter = commandLineParameterProvider.defineStringParameter({
description: parameter.description,
required: parameter.required,
argumentName: parameter.argumentName,
defaultValue: parameter.defaultValue,
parameterLongName: parameter.longName,
parameterShortName: parameter.shortName,
parameterScope: pluginDefinition.pluginParameterScope
description,
required,
argumentName,
defaultValue,
parameterLongName,
parameterShortName,
parameterScope
});
break;
}
Expand Down
11 changes: 11 additions & 0 deletions common/changes/@rushstack/heft/parameter-manager-refactor_2025-04-22-04-13.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"comment": "",
"type": "none",
"packageName": "@rushstack/heft"
}
],
"packageName": "@rushstack/heft",
"email": "iclanton@users.noreply.github.com"
}
Loading