Merge pull request #1020 from bergmeister/OutputType

Add OutputType attributes to cmdlets to enhance tab completion
PowerShell · Jul 19, 2018 · a54a99c · a54a99c
2 parents dc0b4a3 + 0f7da0e
commit a54a99c
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 0 deletions.
diff --git a/Engine/Commands/GetScriptAnalyzerRuleCommand.cs b/Engine/Commands/GetScriptAnalyzerRuleCommand.cs
@@ -15,6 +15,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
     /// GetScriptAnalyzerRuleCommand: Cmdlet to list all the analyzer rule names and descriptions.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "ScriptAnalyzerRule", HelpUri = "https://go.microsoft.com/fwlink/?LinkId=525913")]
+    [OutputType(typeof(RuleInfo))]
     public class GetScriptAnalyzerRuleCommand : PSCmdlet, IOutputWriter
     {
         #region Parameters

diff --git a/Engine/Commands/InvokeFormatterCommand.cs b/Engine/Commands/InvokeFormatterCommand.cs
@@ -13,6 +13,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
     /// A cmdlet to format a PowerShell script text.
     /// </summary>
     [Cmdlet(VerbsLifecycle.Invoke, "Formatter")]
+    [OutputType(typeof(string))]
     public class InvokeFormatterCommand : PSCmdlet, IOutputWriter
     {
         private const string defaultSettingsPreset = "CodeFormatting";

diff --git a/Engine/Commands/InvokeScriptAnalyzerCommand.cs b/Engine/Commands/InvokeScriptAnalyzerCommand.cs
@@ -24,6 +24,8 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
         DefaultParameterSetName = "File",
         SupportsShouldProcess = true,
         HelpUri = "https://go.microsoft.com/fwlink/?LinkId=525914")]
+    [OutputType(typeof(DiagnosticRecord))]
+    [OutputType(typeof(SuppressedRecord))]
     public class InvokeScriptAnalyzerCommand : PSCmdlet, IOutputWriter
     {
         #region Private variables

diff --git a/docs/markdown/Invoke-Formatter.md b/docs/markdown/Invoke-Formatter.md
@@ -111,3 +111,8 @@ Default value:
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
+
+## OUTPUTS
+
+### System.String
+The formatted string result.