Skip to content
New issue

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

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

Already on GitHub? # to your account

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

Closed
Adam-it opened this issue Jul 29, 2024 · 13 comments · Fixed by #384
Closed
Assignees
Labels
⭐ enhancement New feature or request 💪 good first issue Good for newcomers 👨‍💻work in progress I am working on it
Milestone

Comments

@Adam-it
Copy link
Member

Adam-it commented Jul 29, 2024

🎯 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

@Adam-it Adam-it added ⭐ enhancement New feature or request 💪 good first issue Good for newcomers 🙏 help wanted Open for contributors labels Jul 29, 2024
@Adam-it Adam-it added this to the v3.X milestone Jul 29, 2024
@DevPio
Copy link
Contributor

DevPio commented Jul 29, 2024

shoot it over to me 😎.

@Adam-it Adam-it added 👨‍💻work in progress I am working on it and removed 🙏 help wanted Open for contributors labels Jul 29, 2024
@Adam-it
Copy link
Member Author

Adam-it commented Jul 29, 2024

shoot it over to me 😎.

Rockstar 🤩

@Adam-it Adam-it modified the milestones: v3.X, v4.X Sep 8, 2024
@Adam-it
Copy link
Member Author

Adam-it commented Sep 24, 2024

@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
Copy link
Contributor

DevPio commented Sep 24, 2024

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
Copy link
Member Author

Adam-it commented Sep 24, 2024

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 😉

@Adam-it
Copy link
Member Author

Adam-it commented Nov 18, 2024

@DevPio how's it going? Could you share some update on this issue? Do you need any help from my side to get you unblocked?
Or if anything changed please do let me know so that we may open it up from someone else which is also perfectly fine 👍.

The CLIActions got a bit more code and functionality so just to clarify we should add the output link in the progress notify only for the following actions
image

not to every action which is out there in this class

@Adam-it
Copy link
Member Author

Adam-it commented Nov 25, 2024

@DevPio any update on this issue? Do you need any additional help from my side to get you unblocked?
If something changed please and you may not commit to this issue please do let me know so that we may open it up for other 👍

@Adam-it
Copy link
Member Author

Adam-it commented Dec 2, 2024

@DevPio ping 👆🙏

@DevPio
Copy link
Contributor

DevPio commented Dec 2, 2024

Hi Adam, feel free to leave the issue open and move on to another one. Unfortunately, I’ve been too busy to work on it. My apologies.

@Adam-it
Copy link
Member Author

Adam-it commented Dec 2, 2024

Hi Adam, feel free to leave the issue open and move on to another one. Unfortunately, I’ve been too busy to work on it. My apologies.

no problem. Thanks for the response

@Adam-it Adam-it added 🙏 help wanted Open for contributors and removed 👨‍💻work in progress I am working on it labels Dec 2, 2024
@nicodecleyre
Copy link
Contributor

Can I work on this one?

@Adam-it Adam-it added 👨‍💻work in progress I am working on it and removed 🙏 help wanted Open for contributors labels Dec 29, 2024
@Adam-it
Copy link
Member Author

Adam-it commented Dec 29, 2024

Can I work on this one?

Sure

Adam-it pushed a commit that referenced this issue Jan 2, 2025
…user guidance, Closes #286 (#384)

## 🎯 Aim

Includes check output window for CLI Actions

## 📷 Result

![image](https://github.com/user-attachments/assets/fa9b81a4-fc55-4436-86ee-3fdd559ba510)

## ✅ What was done

- [X] Added check output window for CLI Actions

## 🔗 Related issue

Closes #286
@Adam-it
Copy link
Member Author

Adam-it commented Jan 2, 2025

And another one! This will also be part of the next pre-release.
Amazing work 👏👏👏

@Adam-it Adam-it closed this as completed Jan 2, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
⭐ enhancement New feature or request 💪 good first issue Good for newcomers 👨‍💻work in progress I am working on it
Projects
None yet
3 participants