-
Notifications
You must be signed in to change notification settings - Fork 500
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create community_snippets.md for user created snippets (#1246)
* Create community_snippets.md * addsnip-and-table
- Loading branch information
1 parent
a13bc67
commit 930c33d
Showing
1 changed file
with
124 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# Awesome VSCode Snippets for PowerShell | ||
|
||
> A curated list of awesome vscode snippets for PowerShell. | ||
*Inspired by the [awesome](https://github.com/sindresorhus/awesome) lists, focusing on PowerShell snippets in VSCode* | ||
|
||
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re) | ||
|
||
## What are snippets | ||
|
||
Code snippets are templates that make it easier to enter repeating code patterns, such as loops or conditional-statements. Check out the [VSCode documentation on snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets). It provides an overview and instructions on how to author snippets. It's really simple - just a little bit of JSON. | ||
|
||
_To contribute, check out our [guide here](#contributing)._ | ||
|
||
## Table of contents | ||
|
||
| Table of Contents | | ||
|:-----------------:| | ||
| [PSCustomObject](#pscustomobject): _A simple PSCustomObject by @brettmillerb_ | | ||
|
||
## Snippets | ||
|
||
### PSCustomObject | ||
|
||
A simple PSCustomObject by @brettmillerb. It has 4 properties that you can tab through to quickly fill in. | ||
|
||
#### Snippet | ||
|
||
```json | ||
"PSCustomObject": { | ||
"prefix": "PSCustomObject", | ||
"body": [ | ||
"[PSCustomObject]@{\r", | ||
"\t${item1} = ${Property1}\r", | ||
"\t${item2} = ${Property2}\r", | ||
"\t${item3} = ${Property3}\r", | ||
"\t${item4} = ${Property4}\r", | ||
"}" | ||
], | ||
"description": "Creates a PSCustomObject" | ||
} | ||
``` | ||
|
||
## Contributing | ||
|
||
If you'd like to add a snippet to this list, [open a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) with the following changes: | ||
|
||
### Table of context | ||
|
||
You need to add an item to the table of context. The addition should follow the *alpha ordering* of the list. | ||
The ToC item template looks like this: | ||
|
||
```md | ||
| [Name of snippet](link to header of your snippet): _some short description_ | | ||
``` | ||
|
||
An example looks like this (NOTE: all lowercase link): | ||
|
||
```md | ||
| [PSCustomObject](#pscustomobject): _A simple PSCustomObject_ | | ||
``` | ||
|
||
which will show up in the ToC like this: | ||
|
||
| Table of Contents | | ||
|:-----------------:| | ||
| [PSCustomObject](#pscustomobject): _A simple PSCustomObject_ | | ||
|
||
### Body | ||
|
||
You need to also add an item to the body in alpha order. The body item template looks like this: | ||
|
||
### Name of snippet | ||
|
||
Enter your description here. It can be the same as the ToC or a longer version. | ||
|
||
#### Snippet | ||
|
||
```json | ||
{ | ||
"Put your":"snippet here", | ||
"indent it":"properly" | ||
} | ||
``` | ||
|
||
An example looks like this: | ||
|
||
### PSCustomObject | ||
|
||
A simple PSCustomObject. | ||
|
||
#### Snippet | ||
|
||
```json | ||
"PSCustomObject": { | ||
"prefix": "PSCustomObject", | ||
"body": [ | ||
"[PSCustomObject]@{", | ||
"\t${1:Name} = ${2:Value}", | ||
"}" | ||
], | ||
"description": "Creates a PSCustomObject" | ||
} | ||
``` | ||
|
||
which will show up in the body like this: | ||
|
||
### PSCustomObject | ||
|
||
A simple PSCustomObject. Note, this snippet ships with the PowerShell extension. | ||
|
||
#### Snippet | ||
|
||
```json | ||
"PSCustomObject": { | ||
"prefix": "PSCustomObject", | ||
"body": [ | ||
"[PSCustomObject]@{", | ||
"\t${1:Name} = ${2:Value}", | ||
"}" | ||
], | ||
"description": "Creates a PSCustomObject" | ||
} | ||
``` |