Example of how to create a .net core cmdlet with Visual Studio by anmenaga · Pull Request #5096 · PowerShell/PowerShell

anmenaga · 2017-10-12T19:37:17Z

Adding PowerShell/docs/cmdlet-example/README.md that describes how to create a .net core cmdlet with Visual Studio.

anmenaga · 2017-10-12T19:40:39Z

Review shows urls instead of images;
Here is how it looks like with the images:
https://github.com/anmenaga/PowerShell/blob/CmdletExample/docs/cmdlet-example/README.md

SteveL-MSFT · 2017-10-12T19:48:09Z

+
+This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.
+
+We will use free Visual Studio Community 2017 that can be downloaded from [https://www.visualstudio.com/downloads](https://www.visualstudio.com/downloads)


You can just make 'Visual Studio Community 2017' the link instead of making the hyperlink text the hyperlink

SteveL-MSFT · 2017-10-12T19:48:39Z

+1. When installing Visual Studio 2017 select `.NET Core cross-platform development` under `Other Toolsets`
+![1](https://user-images.githubusercontent.com/11860095/31471799-7ca192f4-ae9f-11e7-9731-03fb24ba949c.png)
+
+2. Create new C# project `SendGreeting` of type `Class Library (.NET Core)`


I believe the markdown rules are to use 1. for each item in the numbered list and the renderer takes care of incrementing

I've checked - both syntaxes can be used.
Tried to use '1.' for all items, but got across formatting issues and number list getting broken after code section. Not worth the time spent on changing this.

SteveL-MSFT · 2017-10-12T19:51:34Z

+We will use free Visual Studio Community 2017 that can be downloaded from [https://www.visualstudio.com/downloads](https://www.visualstudio.com/downloads)
+
+1. When installing Visual Studio 2017 select `.NET Core cross-platform development` under `Other Toolsets`
+![1](https://user-images.githubusercontent.com/11860095/31471799-7ca192f4-ae9f-11e7-9731-03fb24ba949c.png)


These images should have proper file names and checked into this folder so it's self contained

Ironically, I was specifically trying to avoid that. :)
Updated.

SteveL-MSFT · 2017-10-12T19:53:33Z

+5. Build solution (F6); The `Output` window will print the location of generated cmdlet DLL:
+![6](https://user-images.githubusercontent.com/11860095/31471804-7d1a66f2-ae9f-11e7-93c2-df72fb43da81.png)
+
+6. Start PowerShell Core, run `Import-Module` on DLL path from previous step and run cmdlet:


You should show that this cmdlet should also work with Windows PowerShell v3+ (although I believe we have a problem right now with .Net Std shims now being available for .Net 4.6.x)

Like you said, right now its not working.

Update: it actually does work with .Net 4.7.1 on WindowsPS on Win10, but some instructions have to be different for cmdlet built for PowerShell Standard.

SteveL-MSFT · 2017-10-12T23:39:53Z

@anmenaga updated your description, I believe this should also address #4809

daxian-dbw · 2017-10-13T23:43:52Z

+In `Solution Explorer` right click on project `Dependencies` and select `Manage NuGet Packages...`
+In the top-right corner of the package manager click on the small `Settings` sprocket icon that is to the right from `Package source` dropdown.
+By default, there will be only `nuget.org` package source in `Available package sources` list.
+Add another package source with name `powershell-core` and source `https://powershell.myget.org/F/powershell-core/api/v3/index.json`


For issue #4809, you need to use the package PowerShellStandard.Library instead.

Already updated. :)
Added a separate list of steps for PowerShell Standard.

Got it, thanks.

daxian-dbw · 2017-10-18T04:24:00Z

Please add this file to the docsToTest list in markdown.tests.ps1, so that the test can validate the markdown syntax of this file.

The .spelling file needs to be updated. Please see the failure in Travis-CI build.

daxian-dbw · 2017-10-18T04:30:29Z

@@ -0,0 +1,118 @@
+# Building a C# Cmdlet for PowerShell Core


It's better to say "with Visual Studio 2017", to differentiate from #5117

daxian-dbw · 2017-10-18T04:31:57Z

@@ -0,0 +1,118 @@
+# Building a C# Cmdlet for PowerShell Core
+
+This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.


Please don't use README.md, instead use a file name like visual-studio-simple-example.md.

daxian-dbw · 2017-10-18T04:32:40Z

+
+This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.
+
+We will use free [Visual Studio Community 2017](https://www.visualstudio.com/downloads).


use free

Maybe use the free?

daxian-dbw · 2017-10-18T04:47:54Z

+![Step8](./Images/Step8.png)
+
+
+# Building a C# Cmdlet for PowerShell Standard 3.0


You cannot have 2 top-level titles in one markdown file. The markdown test will report an error on this. So you need to re-organize the hierarchy of the content.

changed by adding 1 master TOC-type section in the start of the doc with links to 2 subsections.

…o CmdletExample

anmenaga · 2017-10-19T22:14:19Z

Added this doc to markdown.tests.ps1; tests pass.
.spelling file updated.

anmenaga · 2017-10-19T22:16:38Z

@SteveL-MSFT @daxian-dbw Feedback addressed; please review.
https://github.com/anmenaga/PowerShell/blob/CmdletExample/docs/cmdlet-example/visual-studio-simple-example.md

daxian-dbw · 2017-10-19T23:14:54Z

+By default, there will be only `nuget.org` package source in `Available package sources` list.
+Add another package source with name `powershell-core` and source `https://powershell.myget.org/F/powershell-core/api/v3/index.json`
+![Step3](./Images/Step3.png)
+In the package manager select new `powershell-core` in `Package source` dropdown, select `Browse` tab, type in `System.Management.Automation` in the search and select `Include prerelease`.


This line is rendered to the same line of the image. Should be in a new line.

daxian-dbw · 2017-10-19T23:16:03Z

+1. Create new C# project `SendGreetingStd` of type `Class Library (.NET Standard)`
+  ![StdImage21](./Images/Std21.png)
+On project properties verify that `Target framework` is `.NET Standard 2.0`:
+![StdImage22](./Images/Std22.png)


This image is rendered to the same line as the above text. Should be in new line.

daxian-dbw · 2017-10-19T23:17:18Z

+  ![StdImage5](./Images/Std5.png)
+
+1. Now cmdlet can be run on systems supported by PowerShell Standard; for example:
+  On PowerShell Core on Windows:


Is this line supposed to be on a newline? It's rendered in the same line as above text.

SteveL-MSFT · 2017-10-20T02:06:19Z

+
+## Building a C# Cmdlet for PowerShell Core with Visual Studio
+
+This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.


I think it's worth explicitly saying something like:

Targeting for PowerShell Core means that the cmdlet may not work against Windows PowerShell if you take dependencies on new APIs introduced in PowerShell Core.

Good point; updated.

SteveL-MSFT · 2017-10-20T02:07:20Z

+
+## Building a C# Cmdlet for PowerShell Standard 3.0 with Visual Studio
+
+Steps below show how to build your own C# cmdlet for PowerShell Standard 3.0 with Visual Studio.


I think it's worth adding explicitly:

Targeting PowerShell Standard 3.0 means that the same module will work against PowerShell Core as well as Windows PowerShell v3 and newer, however, you are limited to a subset of the available PowerShell APIs.

anmenaga · 2017-10-20T22:46:14Z

@SteveL-MSFT @daxian-dbw PR updated, please review again. Thanks.
https://github.com/anmenaga/PowerShell/blob/CmdletExample/docs/cmdlet-example/visual-studio-simple-example.md

Andrew added 3 commits October 11, 2017 17:14

Example of how to create a PS core cmdlet with Visual Studio

d93c86b

updates 1

48e1184

updates 2

58e27c4

anmenaga requested a review from SteveL-MSFT October 12, 2017 19:37

SteveL-MSFT requested changes Oct 12, 2017

View reviewed changes

SteveL-MSFT requested review from daxian-dbw and joeyaiello October 12, 2017 19:53

SteveL-MSFT assigned daxian-dbw Oct 12, 2017

Andrew added 10 commits October 13, 2017 14:03

PR fedback

b1f08bb

updates 3

51bee66

updates 4

0e613cd

updates 5

de93769

updates 6

1d1f5ef

updates 7

71377fd

updates 8

724b357

Added PowerShell Standard instructions

dcf58c6

Fixed images links

48c3440

Fixed images links 2

9a0dd5b

daxian-dbw reviewed Oct 13, 2017

View reviewed changes

daxian-dbw mentioned this pull request Oct 14, 2017

How to create cmdlet w/dotnet CLI #5117

Merged

daxian-dbw requested changes Oct 18, 2017

View reviewed changes

Andrew added 6 commits October 19, 2017 13:05

Merge branch 'master' of https://github.com/PowerShell/PowerShell int…

126ac29

…o CmdletExample

Updades 9

8c47e0f

Updades 10

9004a23

Updades 11

3bb22dc

Updades 12

3f3af8a

Updades MD032

81e20f5

daxian-dbw requested changes Oct 19, 2017

View reviewed changes

Andrew added 6 commits October 19, 2017 16:32

Updades 13

6837684

Updates 14

13e353d

Updates 15

a352522

Updates 16

08d6a27

Updates 16

0b0910b

Updates 17

7af3038

SteveL-MSFT requested changes Oct 20, 2017

View reviewed changes

Andrew added 3 commits October 20, 2017 13:30

Updates 18

583b159

Updates 19

d673d44

Updates 20

0407372

SteveL-MSFT approved these changes Oct 20, 2017

View reviewed changes

daxian-dbw approved these changes Oct 23, 2017

View reviewed changes

daxian-dbw merged commit e0af4d9 into PowerShell:master Oct 23, 2017

anmenaga deleted the CmdletExample branch October 31, 2018 21:19


		This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.

		We will use free Visual Studio Community 2017 that can be downloaded from [https://www.visualstudio.com/downloads](https://www.visualstudio.com/downloads)

		@@ -0,0 +1,118 @@
		# Building a C# Cmdlet for PowerShell Core

		This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.


		This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.

		We will use free [Visual Studio Community 2017](https://www.visualstudio.com/downloads).

		![Step8](./Images/Step8.png)


		# Building a C# Cmdlet for PowerShell Standard 3.0


		## Building a C# Cmdlet for PowerShell Core with Visual Studio

		This demonstrates how to build your own C# cmdlet for PowerShell Core with Visual Studio.


		## Building a C# Cmdlet for PowerShell Standard 3.0 with Visual Studio

		Steps below show how to build your own C# cmdlet for PowerShell Standard 3.0 with Visual Studio.

Conversation

anmenaga commented Oct 12, 2017 • edited by SteveL-MSFT Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anmenaga commented Oct 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT commented Oct 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daxian-dbw commented Oct 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anmenaga commented Oct 19, 2017

Uh oh!

anmenaga commented Oct 19, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anmenaga commented Oct 20, 2017

Uh oh!

Reviewers

Assignees

Labels

anmenaga commented Oct 12, 2017 •

edited by SteveL-MSFT

Loading

daxian-dbw commented Oct 18, 2017 •

edited

Loading