Add Execute Step in createFunction API #3150
Conversation
…prior to openFolderStep
| @@ -64,7 +65,7 @@ export async function createNewProjectInternal(context: IActionContext, options: | |||
| const wizard: AzureWizard<IFunctionWizardContext> = new AzureWizard(wizardContext, { | |||
| title: localize('createNewProject', 'Create new project'), | |||
| promptSteps: [new FolderListStep(), new NewProjectLanguageStep(options.templateId, options.functionSettings), new OpenBehaviorStep()], | |||
| executeSteps: [new OpenFolderStep()] | |||
| ...(optionalExecuteStep !== undefined ? { executeSteps: [optionalExecuteStep, new OpenFolderStep()] } : { executeSteps: [new OpenFolderStep()] }), | |||
There was a problem hiding this comment.
Just do
executeSteps: optionalExecuteStep ? [optionalExecuteStep, new OpenFolderStep()] : [new OpenFolderStep()]
| /** | ||
| * If set, it will include a step that will be executed prior to OpenFolderStep | ||
| */ | ||
| executeStep?: AzureWizardExecuteStep<IActionContext>; |
There was a problem hiding this comment.
I'd suggest something clearer indicating that this is specifically right before the folder is opened. Maybe beforeOpenFolderExecuteStep
There was a problem hiding this comment.
Oh, ok nevermind. Forgot that the order is based on the priority instead. In that case this is fine - although you should update the comment to indicate that.
There was a problem hiding this comment.
This still isn't accurate - it's not guaranteed to be before the OpenFolderStep. I'd just remove that and say executed in the order determined by the priority of the step
There was a problem hiding this comment.
Maybe you could include the priority number of OpenFolderStep so people know to set the priority lower than that (lower in this case is higher priority)
There was a problem hiding this comment.
I was thinking that - but then if the priority is ever changed it's slightly annoying to have to remember to update this comment as well. Maybe do that but also provide a link to the code line so it's easy to verify as well?
|
You should bump the Since older versions of the extension wouldn't support the new option, you can check the user has the right version and alert them to upgrade the extension. Here's an example: https://github.com/microsoft/vscode-azurestaticwebapps/blob/main/src/getExtensionApi.ts#L17-L30 |
|
@nturinski When can we expect a new version of the extension to be published with this change? |
|
We're planning to release in a couple of weeks. |
* add execute step in api to allow for execution of new azure function prior to openFolderStep * address comments * vbump apiVersion * add comment
This additional API property would allow users to execute logic in relation to the azure function project they are creating prior to the OpenFolderStep by setting the priority accordingly.
This will aid in the creation of Azure Function with SQL Bindings as a user will need to create new azure function project and the logic to add SQL connection string to local.settings.json would not run due to the vscode extension host reloading based on the user choosing to
Open in current windoworOpen in new window:This would benefit our users greatly and would be a much-improved user experience as a whole.
Tested this locally via microsoft/azuredatastudio#19293.