Add LinkEditorServices task for developers (#3623)

This allows developers to use a symbolic link to their PowerShell Editor
Services build instead of copying it, resulting in much faster extension
build times.

Author: andyleejordan

docs/development.md

@@ -38,6 +38,11 @@ This will compile the TypeScript files in the project to JavaScript files.
 Invoke-Build Build
 ```
 
+As a developer, you may want to use `Invoke-Build LinkEditorServices` to setup a symbolic
+link to its modules instead of copying the files. This will mean the built extension will
+always have the latest version of your PowerShell Editor Services build, but this cannot
+be used to package the extension into a VSIX. So it is a manual step.
+
 ### Launching the extension
 
 #### From Visual Studio Code

modules/README.md

@@ -39,7 +39,7 @@ task Restore -If { !(Test-Path "$PSScriptRoot/node_modules") } {
 
 task Clean {
     Write-Host "`n### Cleaning vscode-powershell`n" -ForegroundColor Green
-    Remove-Item ./modules -Exclude "README.md" -Recurse -Force -ErrorAction Ignore
+    Remove-Item ./modules -Recurse -Force -ErrorAction Ignore
     Remove-Item ./out -Recurse -Force -ErrorAction Ignore
     Remove-Item ./node_modules -Recurse -Force -ErrorAction Ignore
 }
@@ -57,9 +57,15 @@ task BuildEditorServices -If (Get-EditorServicesPath) {
     Invoke-Build Build (Get-EditorServicesPath)
 }
 
-task CopyEditorServices -If { !(Test-Path ./modules/PowerShellEditorServices) -and (Get-EditorServicesPath) } BuildEditorServices, {
-    Write-Host "`n### Copying PowerShellEditorServices module files" -ForegroundColor Green
-    Copy-Item -Recurse -Force "$(Split-Path (Get-EditorServicesPath))/module/*" ./modules
+task LinkEditorServices -If (Get-EditorServicesPath) BuildEditorServices, {
+    Write-Host "`n### For developer use only! Creating symbolic link to PSES" -ForegroundColor Green
+    Remove-Item ./modules -Recurse -Force -ErrorAction Ignore
+    New-Item -ItemType SymbolicLink -Path ./modules -Target "$(Split-Path (Get-EditorServicesPath))/module"
+}
+
+task CopyEditorServices -If { !(Test-Path ./modules) -and (Get-EditorServicesPath) } BuildEditorServices, {
+    Write-Host "`n### Copying PSES" -ForegroundColor Green
+    Copy-Item -Recurse -Force "$(Split-Path (Get-EditorServicesPath))/module" ./modules
 }
 
 task Build CopyEditorServices, Restore, {
@@ -111,7 +117,9 @@ task UpdateReadme -If { $script:IsPreviewExtension } {
 }
 
 task Package UpdateReadme, Build, {
-    assert { Test-Path ./modules/PowerShellEditorServices }
+    assert (Test-Path ./modules/PowerShellEditorServices)
+    assert ((Get-Item ./modules).LinkType -ne "SymbolicLink") "Packaging requires a copy of PSES, not a symlink!"
+
     Write-Host "`n### Packaging $($script:PackageJson.name)-$($script:PackageJson.version).vsix`n" -ForegroundColor Green
     exec { & npm run package }
 }