CLI for Microsoft 365 Tools VSCode Extension

[garrytrinder]

I've recently been using the Azure CLI Tools extension in VSCode, https://marketplace.visualstudio.com/items?itemName=ms-vscode.azurecli which provides intellisense and inline docs on commands for the CLI as well as the ability to execute lines in the integrated terminal directly.

Would people find something similar for the CLI for Microsoft 365 useful?

[garrytrinder]

I've started to revisit this and see that having a presence in VSCode would be certainly beneficial essentially as it would provide a friendly UI integrated into VS Code which calls the CLI behind the scenes for performing its operations.

A few features of the extension have come to mind.

• Language Support
  • Adds a new language to VSCode for CLI for Microsoft 365
  • Add Intellisense completion for scripting
• Context Menu
  • Right click execute single line in integrated Terminal
• Snippets
  • Provide full examples such as Login using Password, Get SharePoint List etc
• Version Check
  • Auto check current version against latest and prompt for upgrade of CLI
• Install CLI comand
  • Command Palette action to help users install CLI without running commands themselves
  • Expanded to list different versions betas and stable
• Upgrade SPFx project command
  • Run upgrade support

Any thoughts? @pnp/cli-for-microsoft-365-maintainers

[waldekmastykarz]

Could we parse the omelette completion file for this purpose?

When you setup completion, it's based on the commands.json file which is generated in the CLIs folder. Intellisense should be built on top of this file so that it's consistent with the completion you get in terminal.

[garrytrinder]

Perfect, that’s the next step in the PoC, let me get something working and I’ll update here 👍🏻

[garrytrinder]

Following todays sync call, an approach that we could take for an early version.

• Bundle Code Tour extension with the CLI extension
• Add command palette actions
  • Install CLI for Microsoft 365
  • Update CLI for Microsoft 365
  • Upgrade SharePoint Framework project
    • Default to Code Tour output when executed as we know this is installed

This would give users the ability to manage the CLI install and upgrade projects without having to write any commands for themselves, whilst not leaving the VS Code interface and in the context of their SharePoint projects.

For auto detection of CLI we would need to raise an initialisation event, this is typically done when opening a specific type of file, as we won't code completion, we would have to provide the commands that don't rely on initialisation.

@pnp/cli-for-microsoft-365-maintainers thoughts?

[waldekmastykarz]

Why do we need autodetection of CLI? Couldn't we check when it's about to be used?

[garrytrinder]

Why do we need autodetection of CLI? Couldn't we check when it's about to be used?

Just for convenience, but yes, I agree, we should perform the check when trying to run the upgrade command and prompt then if the CLI can't be found.

[jfieldersav]

That Sounds great!

…

________________________________ From: Garry Trinder <[email protected]> Sent: Sunday, January 17, 2021 6:36:41 AM To: pnp/cli-microsoft365 <[email protected]> Cc: Subscribed <[email protected]> Subject: [Caution - External Email] Re: [pnp/cli-microsoft365] CLI for Microsoft 365 Tools VSCode Extension (#1638) I've started to revisit this and see that having a presence in VSCode would be certainly beneficial, a few features of the extension have come to mind. * Language Support * Adds a new language to VSCode for CLI for Microsoft 365 * Add Intellisense completion for scripting * Context Menu * Right click execute single line in integrated Terminal * Snippets * Provide full examples such as Login using Password, Get SharePoint List etc * Version Check * Auto check current version against latest and prompt for upgrade of CLI * Install CLI comand * Command Palette action to help users install CLI without running commands themselves * Expanded to list different versions betas and stable Any thoughts? @pnp/cli-for-microsoft-365-maintainers<https://github.com/orgs/pnp/teams/cli-for-microsoft-365-maintainers> — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub<#1638 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ASJ36QJKGHDGG2L4DZKJUP3S2LDUTANCNFSM4NUYUP3A>. Warning: This email originated outside the City of Savannah. Do not reply, click links, or open attachments unless you are certain you recognize the sender’s name, telephone number, and email address. Please report suspicious email to [email protected]<mailto:[email protected]>

[garrytrinder]

Thanks you 👍

Is there anything in the list of features that you would like to see included first or do you any ideas on what we could add to the list?

I'd love to hear your thoughts.