add formatting tests

Author: TylerLeonhardt

test/Pester/EditorServices.Integration.Tests.ps1

@@ -55,6 +55,33 @@ Data:
     throw $msg
 }
 
+function New-TestFile
+{
+    param(
+        [Parameter(Mandatory)]
+        [string]
+        $Script
+    )
+
+    $file = Set-Content -Path (Join-Path $TestDrive "$([System.IO.Path]::GetRandomFileName()).ps1") -Value $Script -PassThru -Force
+
+    $request = Send-LspDidOpenTextDocumentRequest -Client $client `
+        -Uri ([Uri]::new($file.PSPath).AbsoluteUri) `
+        -Text ($file[0].ToString())
+
+    # To give PSScriptAnalyzer a chance to run.
+    Start-Sleep 1
+
+    # There's no response for this message, but we need to call Get-LspResponse
+    # to increment the counter.
+    Get-LspResponse -Client $client -Id $request.Id | Out-Null
+
+    # Throw out any notifications from the first PSScriptAnalyzer run.
+    Get-LspNotification -Client $client | Out-Null
+
+    $file.PSPath
+}
+
 Describe "Loading and running PowerShellEditorServices" {
     BeforeAll {
         Import-Module -Force "$PSScriptRoot/../../module/PowerShellEditorServices"
@@ -89,21 +116,12 @@ Describe "Loading and running PowerShellEditorServices" {
     }
 
     It "Can handle WorkspaceSymbol request" {
-        $script = "
+        New-TestFile -Script "
 function Get-Foo {
     Write-Host 'hello'
 }
 "
 
-        $file = Set-Content -Path (Join-Path $TestDrive "$([System.IO.Path]::GetRandomFileName()).ps1") -Value $script -PassThru -Force
-        $request = Send-LspDidOpenTextDocumentRequest -Client $client `
-            -Uri ([Uri]::new($file.PSPath).AbsoluteUri) `
-            -Text ($file[0].ToString())
-
-        # There's no response for this message, but we need to call Get-LspResponse
-        # to increment the counter.
-        Get-LspResponse -Client $client -Id $request.Id | Out-Null
-
         $request = Send-LspRequest -Client $client -Method "workspace/symbol" -Parameters @{
             query = ""
         }
@@ -141,19 +159,7 @@ function Get-Foo {
     }
 
     It "Can get Diagnostics after changing settings" {
-        $script = 'gci | % { $_ }'
-        $file = Set-Content -Path (Join-Path $TestDrive "$([System.IO.Path]::GetRandomFileName()).ps1") -Value $script -PassThru -Force
-
-        $request = Send-LspDidOpenTextDocumentRequest -Client $client `
-            -Uri ([Uri]::new($file.PSPath).AbsoluteUri) `
-            -Text ($file[0].ToString())
-
-        # There's no response for this message, but we need to call Get-LspResponse
-        # to increment the counter.
-        Get-LspResponse -Client $client -Id $request.Id | Out-Null
-
-        # Throw out any notifications from the first PSScriptAnalyzer run.
-        Get-LspNotification -Client $client | Out-Null
+        $file = New-TestFile -Script 'gci | % { $_ }'
 
         $request = Send-LspDidChangeConfigurationRequest -Client $client -Settings @{
             PowerShell = @{
@@ -172,32 +178,17 @@ function Get-Foo {
     }
 
     It "Can handle folding request" {
-        $script = 'gci | % {
+        $filePath = New-TestFile -Script 'gci | % {
 $_
 
 @"
     $_
 "@
 }'
 
-        $file = Set-Content -Path (Join-Path $TestDrive "$([System.IO.Path]::GetRandomFileName()).ps1") -Value $script -PassThru -Force
-
-        $request = Send-LspDidOpenTextDocumentRequest -Client $client `
-            -Uri ([Uri]::new($file.PSPath).AbsoluteUri) `
-            -Text ($file[0].ToString())
-
-        # There's no response for this message, but we need to call Get-LspResponse
-        # to increment the counter.
-        Get-LspResponse -Client $client -Id $request.Id | Out-Null
-
-        # Throw out any notifications from the first PSScriptAnalyzer run.
-        Get-LspNotification -Client $client | Out-Null
-
-
-
         $request = Send-LspRequest -Client $client -Method "textDocument/foldingRange" -Parameters ([Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.FoldingRangeParams] @{
             TextDocument = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.TextDocumentIdentifier] @{
-                Uri = ([Uri]::new($file.PSPath).AbsoluteUri)
+                Uri = ([Uri]::new($filePath).AbsoluteUri)
             }
         })
 
@@ -215,6 +206,52 @@ $_
         $sortedResults[1].endCharacter | Should -Be 2
     }
 
+    It "can handle a normal formatting request" {
+        $filePath = New-TestFile -Script '
+gci | % {
+Get-Process
+}
+
+'
+
+        $request = Send-LspFormattingRequest -Client $client `
+            -Uri ([Uri]::new($filePath).AbsoluteUri)
+
+        $response = Get-LspResponse -Client $client -Id $request.Id
+
+        # If we have a tab, formatting ran.
+        $response.Result.newText.Contains("`t") | Should -BeTrue -Because "We expect a tab."
+    }
+
+    It "can handle a range formatting request" {
+        $filePath = New-TestFile -Script '
+gci | % {
+Get-Process
+}
+
+'
+
+        $range = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.Range]@{
+            Start = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.Position]@{
+                Line = 2
+                Character = 0
+            }
+            End  = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.Position]@{
+                Line = 3
+                Character = 0
+            }
+        }
+
+        $request = Send-LspRangeFormattingRequest -Client $client `
+            -Uri ([Uri]::new($filePath).AbsoluteUri) `
+            -Range $range
+
+        $response = Get-LspResponse -Client $client -Id $request.Id
+
+        # If we have a tab, formatting ran.
+        $response.Result.newText.Contains("`t") | Should -BeTrue -Because "We expect a tab."
+    }
+
     # This test MUST be last
     It "Shuts down the process properly" {
         $request = Send-LspShutdownRequest -Client $client

tools/PsesPsClient/PsesPsClient.psd1

@@ -76,6 +76,8 @@ FunctionsToExport = @(
     'Send-LspInitializeRequest',
     'Send-LspDidOpenTextDocumentRequest',
     'Send-LspDidChangeConfigurationRequest',
+    'Send-LspFormattingRequest',
+    'Send-LspRangeFormattingRequest',
     'Send-LspShutdownRequest',
     'Get-LspNotification',
     'Get-LspResponse'

tools/PsesPsClient/PsesPsClient.psm1

@@ -319,6 +319,79 @@ function Send-LspDidChangeConfigurationRequest
     $result
 }
 
+function Send-LspFormattingRequest
+{
+    [OutputType([PsesPsClient.LspRequest])]
+    param(
+        [Parameter(Position = 0, Mandatory)]
+        [PsesPsClient.PsesLspClient]
+        $Client,
+
+        [Parameter(Mandatory)]
+        [string]
+        $Uri,
+
+        [Parameter()]
+        [int]
+        $TabSize = 4,
+
+        [Parameter()]
+        [switch]
+        $InsertSpaces
+    )
+
+    $params = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.DocumentFormattingParams]@{
+        TextDocument = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.TextDocumentIdentifier]@{
+            Uri = $Uri
+        }
+        options = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.FormattingOptions]@{
+            TabSize = $TabSize
+            InsertSpaces = $InsertSpaces.IsPresent
+        }
+    }
+
+    return Send-LspRequest -Client $Client -Method 'textDocument/formatting' -Parameters $params
+}
+
+function Send-LspRangeFormattingRequest
+{
+    [OutputType([PsesPsClient.LspRequest])]
+    param(
+        [Parameter(Position = 0, Mandatory)]
+        [PsesPsClient.PsesLspClient]
+        $Client,
+
+        [Parameter(Mandatory)]
+        [string]
+        $Uri,
+
+        [Parameter(Mandatory)]
+        [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.Range]
+        $Range,
+
+        [Parameter()]
+        [int]
+        $TabSize = 4,
+
+        [Parameter()]
+        [switch]
+        $InsertSpaces
+    )
+
+    $params = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.DocumentRangeFormattingParams]@{
+        TextDocument = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.TextDocumentIdentifier]@{
+            Uri = $Uri
+        }
+        Range = $Range
+        options = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.FormattingOptions]@{
+            TabSize = $TabSize
+            InsertSpaces = $InsertSpaces.IsPresent
+        }
+    }
+
+    return Send-LspRequest -Client $Client -Method 'textDocument/rangeFormatting' -Parameters $params
+}
+
 function Send-LspShutdownRequest
 {
     [OutputType([PsesPsClient.LspRequest])]