Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pnp/vscode-pnp-powershell

With the PnP PowerShell VS Code extension, you can quickly learn, code and create scripts that use PnP PowerShell commands.
https://github.com/pnp/vscode-pnp-powershell

m365 m365dev pnp-powershell powershell

Last synced: 2 months ago
JSON representation

With the PnP PowerShell VS Code extension, you can quickly learn, code and create scripts that use PnP PowerShell commands.

Host: GitHub
URL: https://github.com/pnp/vscode-pnp-powershell
Owner: pnp
License: mit
Created: 2024-05-07T00:40:53.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-10-27T21:05:54.000Z (3 months ago)
Last Synced: 2024-10-28T01:11:13.371Z (3 months ago)
Topics: m365, m365dev, pnp-powershell, powershell
Language: HTML
Homepage: https://marketplace.visualstudio.com/items?itemName=adamwojcikit.pnp-powershell-extension
Size: 13.4 MB
Stars: 4
Watchers: 12
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Support: SUPPORT.md

Awesome Lists containing this project

README

PnP PowerShell extension

This extension will boost your productivity when creating scripts that use PnP PowerShell. Currently, the extension provides:

- embedded documentation
- samples powered by PnP Script Sample Gallery
- snippets with all possible PnP PowerShell commands

Please check [PnP PowerShell docs](https://pnp.github.io/powershell/) for more information.

![samples](./assets/images/main.png)

## ✨ Capabilities

### 1️⃣ Script samples gallery

Using `PnP PS: Open samples gallery` command, or the 'Samples' button from the controls above the command list, you may open the gallery with all available script samples. Currently, the samples shown are retrieved from the [PnP script samples repository](https://github.com/pnp/script-samples). From the samples gallery you may go to the sample location or create a new tab (file) in the editor prefilled with the PnP PowerShell script. It is possible to search for samples by:

- title
- authors
- commands used in samples

![samples](./assets/images/samplesCommand.gif)

### 2️⃣ Docs

This functionality provides PnP PowerShell docs view for all commands inside VS Code. No more context switching between the code editor and browser. It is possible to go to docs original website location and also open the sample gallery showing all samples using that command.

![docs](./assets/images/howDocsWork.gif)

It is also possible to use the command `PnP PS: Open docs for command` to open the docs for a specific command.

![docs](./assets/images/docsCommand.gif)

### 3️⃣ Command list tree view

![docs](./assets/images/treeViewIcon.png)

The command list also has the functionality to group commands view by command name verb

![docs](./assets/images/treeView.png)

### 4️⃣ Snippets

The extensions help to quickly find the correct PnP PowerShell command and use it thanks to code snippets. The command is added along with all required parameters. It is possible to quickly move between parameters using 'Tab' key. Each snippet has a description which may be found in the docs which is a great help to quickly understand the commands functionality.

![snippetsList](./assets/images/snippets.gif)

In order to use snippets please type part of a PnP PowerShell command and press enter or tab. The command will be automatically added to the code along with all required parameters. You may also use 'Ctrl + Space' (Windows, Linux) or 'Cmd + Space' (macOS) to activate snippets from within the editor.

![snippetsList](./assets/images/snippetsList.png)

It is also possible to use the command `Insert Snippet` in VS Code to see the full list

![snippetsList](./assets/images/listOfCommandsFromToolbar.png)

### 5️⃣ Transition to PnP PowerShell Docs website

The extension provides many ways to go to the PnP PowerShell Docs web page or GitHub repository.

![docs](./assets/images/webPageButtons.png)

## 🤖 Commands

The extension provides the following commands:

| command | description |
|----------|:-------------:|
| PnP PS: Open samples gallery | Opens up the sample gallery |
| PnP PS: Open docs for command | Search for a command doc file. The command may also be prefilled by the selected PnP PowerShell command |

![commands](./assets/images/commands.png)

## 🙋 Support

This project is a community lead extension provided by the [Microsoft 365 and Power Platform Community](https://aka.ms/m365/community) members. Questions, problems, or feedback is more than welcome. Please create an issue in the extension repository [issue list](https://github.com/pnp/vscode-pnp-powershell/issues).

## 👍 Community

Are you building experiences for Microsoft 365? - Everyone is welcome to join our [Microsoft 365 and Power Platform Community](https://aka.ms/m365/community) efforts with community calls, samples and guidance. Join our [weekly community calls](https://aka.ms/m365/calls) for Microsoft 365 and Power Platform topics or engage with us on [Discord](https://aka.ms/community/discord). Everyone is welcome 🧡

## 🧾 Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## 😍 "Sharing is Caring"

## 🔑 License

[MIT License](https://github.com/pnp/vscode-pnp-powershell/blob/main/LICENSE.md)

## ⚠️ Disclaimer

**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**