Help and manifest fixes

SeeminglyScience · daviwil · commit aabf092ecb56 · 2017-06-07T20:10:44.000-07:00
- Added online link to markdown help.

- Converted comment based help of Register-EditorCommand and
  UnregisterEditorCommand to markdown.

- Fixed psedit not being exported.

- Added cleanup of generated MAML file to build script.
diff --git a/.gitignore b/.gitignore
@@ -59,3 +59,6 @@ PowerShellEditorServices.sln.ide/edb.chk
 PowerShellEditorServices.sln.ide/edbres00001.jrs
 PowerShellEditorServices.sln.ide/storage.ide
 *.jrs
+
+# Don't include PlatyPS generated MAML
+module/PowerShellEditorServices/Commands/en-US/*-help.xml
diff --git a/PowerShellEditorServices.build.ps1 b/PowerShellEditorServices.build.ps1
@@ -100,6 +100,7 @@ task Clean {
     Remove-Item .\module\PowerShellEditorServices\bin -Recurse -Force -ErrorAction Ignore
     Get-ChildItem -Recurse src\*.nupkg | Remove-Item -Force -ErrorAction Ignore
     Get-ChildItem .\module\PowerShellEditorServices\*.zip | Remove-Item -Force -ErrorAction Ignore
+    Get-ChildItem .\module\PowerShellEditorServices\Commands\en-US\*-help.xml | Remove-Item -Force -ErrorAction Ignore
 }
 
 task GetProductVersion -Before PackageNuGet, PackageModule, UploadArtifacts {
diff --git a/module/PowerShellEditorServices/Commands/PowerShellEditorServices.Commands.psd1 b/module/PowerShellEditorServices/Commands/PowerShellEditorServices.Commands.psd1
@@ -57,7 +57,7 @@ Description = 'Provides internal commands for PowerShell Editor Services that on
 # ScriptsToProcess = @()
 
 # Type files (.ps1xml) to be loaded when importing this module
-# TypesToProcess = @()
+TypesToProcess = @('PowerShellEditorServices.Commands.types.ps1xml')
 
 # Format files (.ps1xml) to be loaded when importing this module
 # FormatsToProcess = @()
@@ -74,7 +74,9 @@ FunctionsToExport = @('Register-EditorCommand',
                       'ConvertFrom-ScriptExtent',
                       'ConvertTo-ScriptExtent',
                       'Get-Token',
-                      'Join-ScriptExtent')
+                      'Join-ScriptExtent',
+                      'Test-ScriptExtent',
+                      'psedit')
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
 CmdletsToExport = @()
diff --git a/module/PowerShellEditorServices/Commands/PowerShellEditorServices.Commands.psm1 b/module/PowerShellEditorServices/Commands/PowerShellEditorServices.Commands.psm1
@@ -3,3 +3,5 @@ Import-LocalizedData -BindingVariable Strings -FileName Strings
 Get-ChildItem -Path $PSScriptRoot\Public\*.ps1 | ForEach-Object {
     . $PSItem.FullName
 }
+
+Export-ModuleMember -Function *-*
diff --git a/module/PowerShellEditorServices/Commands/PowerShellEditorServices.Commands.types.ps1xml b/module/PowerShellEditorServices/Commands/PowerShellEditorServices.Commands.types.ps1xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<Types>
+    <Type>
+        <Name>Microsoft.PowerShell.EditorServices.FullScriptExtent</Name>
+        <Members>
+            <MemberSet>
+                <Name>PSStandardMembers</Name>
+                <Members>
+                    <PropertySet>
+                        <Name>DefaultDisplayPropertySet</Name>
+                        <ReferencedProperties>
+                            <Name>File</Name>
+                            <Name>StartScriptPosition</Name>
+                            <Name>EndScriptPosition</Name>
+                            <Name>StartLineNumber</Name>
+                            <Name>StartColumnNumber</Name>
+                            <Name>EndLineNumber</Name>
+                            <Name>EndColumnNumber</Name>
+                            <Name>StartOffset</Name>
+                            <Name>EndOffset</Name>
+                            <Name>Text</Name>
+                        </ReferencedProperties>
+                    </PropertySet>
+                </Members>
+            </MemberSet>
+        </Members>
+    </Type>
+</Types>
diff --git a/module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1 b/module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1
@@ -1,50 +1,5 @@
 ﻿<#
- .SYNOPSIS
- Registers a command which can be executed in the host editor.
-
- .DESCRIPTION
- Registers a command which can be executed in the host editor.  This
- command will be shown to the user either in a menu or command palette.
- Upon invoking this command, either a function/cmdlet or ScriptBlock will
- be executed depending on whether the -Function or -ScriptBlock parameter
- was used when the command was registered.
-
- This command can be run multiple times for the same command so that its
- details can be updated.  However, re-registration of commands should only
- be used for development purposes, not for dynamic behavior.
-
- .PARAMETER Name
- Specifies a unique name which can be used to identify this command.
- This name is not displayed to the user.
-
- .PARAMETER DisplayName
- Specifies a display name which is displayed to the user.
-
- .PARAMETER Function
- Specifies a function or cmdlet name which will be executed when the user
- invokes this command.  This function may take a parameter called $context
- which will be populated with an EditorContext object containing information
- about the host editor's state at the time the command was executed.
-
- .PARAMETER ScriptBlock
- Specifies a ScriptBlock which will be executed when the user invokes this
- command.  This ScriptBlock may take a parameter called $context
- which will be populated with an EditorContext object containing information
- about the host editor's state at the time the command was executed.
-
- .PARAMETER SuppressOutput
- If provided, causes the output of the editor command to be suppressed when
- it is run.  Errors that occur while running this command will still be
- written to the host.
-
- .EXAMPLE
- PS> Register-EditorCommand -Name "MyModule.MyFunctionCommand" -DisplayName "My function command" -Function Invoke-MyCommand -SuppressOutput
-
- .EXAMPLE
- PS> Register-EditorCommand -Name "MyModule.MyScriptBlockCommand" -DisplayName "My ScriptBlock command" -ScriptBlock { Write-Output "Hello from my command!" }
-
- .LINK
- Unregister-EditorCommand
+.EXTERNALHELP ..\PowerShellEditorServices.Commands-help.xml
 #>
 function Register-EditorCommand {
     [CmdletBinding()]
@@ -100,21 +55,7 @@ function Register-EditorCommand {
 }
 
 <#
- .SYNOPSIS
- Unregisters a command which has already been registered in the host editor.
-
- .DESCRIPTION
- Unregisters a command which has already been registered in the host editor.
- An error will be thrown if the specified Name is unknown.
-
- .PARAMETER Name
- Specifies a unique name which identifies a command which has already been registered.
-
- .EXAMPLE
- PS> Unregister-EditorCommand -Name "MyModule.MyFunctionCommand"
-
- .LINK
- Register-EditorCommand
+.EXTERNALHELP ..\PowerShellEditorServices.Commands-help.xml
 #>
 function Unregister-EditorCommand {
     [CmdletBinding()]
@@ -138,3 +79,4 @@ function psedit {
         $psEditor.Workspace.OpenFile($_.FullName)
     }
 }
+Export-ModuleMember -Function psedit
diff --git a/module/docs/ConvertFrom-ScriptExtent.md b/module/docs/ConvertFrom-ScriptExtent.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/ConvertFrom-ScriptExtent.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/ConvertTo-ScriptExtent.md b/module/docs/ConvertTo-ScriptExtent.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/ConvertTo-ScriptExtent.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/Find-Ast.md b/module/docs/Find-Ast.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/Find-Ast.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/Get-Token.md b/module/docs/Get-Token.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/Get-Token.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/Import-EditorCommand.md b/module/docs/Import-EditorCommand.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/Import-EditorCommand.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/Join-ScriptExtent.md b/module/docs/Join-ScriptExtent.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/Join-ScriptExtent.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/Register-EditorCommand.md b/module/docs/Register-EditorCommand.md
@@ -0,0 +1,153 @@
+---
+external help file: PowerShellEditorServices.Commands-help.xml
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/Register-EditorCommand.md
+schema: 2.0.0
+---
+
+# Register-EditorCommand
+
+## SYNOPSIS
+
+Registers a command which can be executed in the host editor.
+
+## SYNTAX
+
+### Function
+
+```powershell
+Register-EditorCommand -Name <String> -DisplayName <String> -Function <String> [-SuppressOutput]
+```
+
+### ScriptBlock
+
+```powershell
+Register-EditorCommand -Name <String> -DisplayName <String> -ScriptBlock <ScriptBlock> [-SuppressOutput]
+```
+
+## DESCRIPTION
+
+Registers a command which can be executed in the host editor. This
+command will be shown to the user either in a menu or command palette.
+Upon invoking this command, either a function/cmdlet or ScriptBlock will
+be executed depending on whether the -Function or -ScriptBlock parameter
+was used when the command was registered.
+
+This command can be run multiple times for the same command so that its
+details can be updated. However, re-registration of commands should only
+be used for development purposes, not for dynamic behavior.
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+
+```powershell
+Register-EditorCommand -Name "MyModule.MyFunctionCommand" -DisplayName "My function command" -Function Invoke-MyCommand -SuppressOutput
+```
+
+### -------------------------- EXAMPLE 2 --------------------------
+
+```powershell
+Register-EditorCommand -Name "MyModule.MyScriptBlockCommand" -DisplayName "My ScriptBlock command" -ScriptBlock { Write-Output "Hello from my command!" }
+```
+
+## PARAMETERS
+
+### -Name
+
+Specifies a unique name which can be used to identify this command.
+This name is not displayed to the user.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -DisplayName
+
+Specifies a display name which is displayed to the user.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Function
+
+Specifies a function or cmdlet name which will be executed when the user
+invokes this command. This function may take a parameter called $context
+which will be populated with an EditorContext object containing information
+about the host editor's state at the time the command was executed.
+
+```yaml
+Type: String
+Parameter Sets: Function
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ScriptBlock
+
+Specifies a ScriptBlock which will be executed when the user invokes this
+command. This ScriptBlock may take a parameter called $context
+which will be populated with an EditorContext object containing information
+about the host editor's state at the time the command was executed.
+
+```yaml
+Type: ScriptBlock
+Parameter Sets: ScriptBlock
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SuppressOutput
+
+If provided, causes the output of the editor command to be suppressed when
+it is run. Errors that occur while running this command will still be
+written to the host.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[Unregister-EditorCommand](Unregister-EditorCommand.md)
+
diff --git a/module/docs/Set-ScriptExtent.md b/module/docs/Set-ScriptExtent.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/Set-ScriptExtent.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/Test-ScriptExtent.md b/module/docs/Test-ScriptExtent.md
@@ -1,6 +1,6 @@
 ---
 external help file: PowerShellEditorServices.Commands-help.xml
-online version:
+online version: https://github.com/PowerShell/PowerShellEditorServices/tree/master/module/docs/Test-ScriptExtent.md
 schema: 2.0.0
 ---
 
diff --git a/module/docs/Unregister-EditorCommand.md b/module/docs/Unregister-EditorCommand.md

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,7 @@ task Clean {`
`100`	`100`	`Remove-Item .\module\PowerShellEditorServices\bin -Recurse -Force -ErrorAction Ignore`
`101`	`101`	`Get-ChildItem -Recurse src\*.nupkg \| Remove-Item -Force -ErrorAction Ignore`
`102`	`102`	`Get-ChildItem .\module\PowerShellEditorServices\*.zip \| Remove-Item -Force -ErrorAction Ignore`
	`103`	`+ Get-ChildItem .\module\PowerShellEditorServices\Commands\en-US\*-help.xml \| Remove-Item -Force -ErrorAction Ignore`
`103`	`104`	`}`
`104`	`105`
`105`	`106`	`task GetProductVersion -Before PackageNuGet, PackageModule, UploadArtifacts {`
Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,5 @@ Import-LocalizedData -BindingVariable Strings -FileName Strings`
`3`	`3`	`Get-ChildItem -Path $PSScriptRoot\Public\*.ps1 \| ForEach-Object {`
`4`	`4`	`. $PSItem.FullName`
`5`	`5`	`}`
	`6`	`+`
	`7`	`+Export-ModuleMember -Function -`