search

pnp / vscode-viva

With the SharePoint Framework Toolkit extension, you can create and manage your SharePoint Framework solutions on your tenant. All actions you need to perform during the development flow are at your fingertips.
https://marketplace.visualstudio.com/items?itemName=m365pnp.viva-connections-toolkit
MIT License
38 stars 17 forks source link

💡 [Feature]: Add 'check output window to follow the progress' message to every CLI Action #286

Open Adam-it opened 2 months ago

Adam-it commented 2 months ago

🎯 Aim of the feature

In deploy action we show the following message image

The 'check [output window]...' part is really helpful as it is easy to transfer to the VS Code extension output and check what it is currently doing and what CLI for Microsoft 365 commands are done under the hood to make this happen image

Unfortunately this was only added to this single action. We should:

  1. recheck the https://github.com/pnp/vscode-viva/blob/main/src/services/CliActions.ts and in every place where we have window.withProgress... add the Check [output window](command:${Commands.showOutputChannel}) to follow the progress. sentence to the loader/progress message

📷 Images (if possible) with expected result

No response

🤔 Additional remarks or comments

No response

DevPio commented 2 months ago

shoot it over to me 😎.

Adam-it commented 2 months ago

shoot it over to me 😎.

Rockstar 🤩

Adam-it commented 2 weeks ago

@DevPio I just added and hacktoberfest label to this issue. If you open a PR for this issue over October it will count towards the hacktoberfest event 🤩

DevPio commented 2 weeks ago

Do you want the functionality to ensure that all CLI command executions automatically display the status in the VS Code output window, along with adding Notifications.info for tracking changes on screen and Notifications.error in case of an error?

Adam-it commented 2 weeks ago

Do you want the functionality to ensure that all CLI command executions automatically display the status in the VS Code output window, along with adding Notifications.info for tracking changes on screen and Notifications.error in case of an error?

it's not about every CLI command execution but every that is done over the CLI actions. when we use the window.withProgress we should also include the way to easily transfer to the output window. Currently we for example have something like 

    await window.withProgress({
      location: ProgressLocation.Notification,
      title: 'Granting API permissions for the current project...',
      cancellable: true
    }, async (progress: Progress<{ message?: string; increment?: number }>) => {
    .....

the issue is about changing this to

     await window.withProgress({
      location: ProgressLocation.Notification,
      title: 'Granting API permissions for the current project. Check [output window](command:${Commands.showOutputChannel}) to follow the progress',
      cancellable: true
    }, async (progress: Progress<{ message?: string; increment?: number }>) => {
    .....

The same way as we already have for the deploy action. That way users in the notify will get the link that will open the output window to show the CLI logs. and it's only that. nothing more 😉