Skip to content

Latest commit

 

History

History
78 lines (57 loc) · 2.29 KB

README.md

File metadata and controls

78 lines (57 loc) · 2.29 KB
Raw

LSP-PowerShellEditorServices

Convenience plugin to install and run the PowerShellEditorServices language server.

Installation

  1. Install a PowerShell runtime (e.g. you can run powershell.exe (Windows) or pwsh (macOS/Linux) in your terminal).

  2. Install PowerShell package for syntax highlighting.
    Alternatively, you may use Michael Lyons' PowerShell syntax rewrite.

  3. Install LSP from Package Control.

  4. Install LSP-PowerShellEditorServices from Package Control.

Note

The plugin does not distribute but download language server binaries

Configuration

Open configuration file by running Preferences: LSP-PowerShellEditorServices Settings from Command Palette or via Main Menu (Preferences > Package Settings > LSP > Servers > LSP-PowerShellEditorServices).

Global Script Analysis Settings File

"powershell.scriptAnalysis.settingsPath": "PSScriptAnalyzerSettings.psd1"

By default language server looks up script analysis settings in workspace folders, only.

  • A given relative path is resolved with workspace folders as root.
  • An absolute path can be specified to force usage of a certain settings file.

To provide both a global fallback and project specific files ...

  1. specify an absolute path in LSP-PowerShellEditorServices.sublime-settings.

    {
   "settings":
   {
      "powershell.scriptAnalysis.settingsPath": "${packages}/User/PSScriptAnalyzerSettings.psd1",
   },
}

  2. specify a relative path in project specific settings via <My Project>.sublime-project.

    {
   "folders": [
      {
         "path": ".",
      },
   ],
   "settings":
   {
      "LSP":
      {
         "PowerShellEditorServices": {
            "settings": {
               "powershell.scriptAnalysis.settingsPath": "PSScriptAnalyzerSettings.psd1",
            },
         },
      },
   },
}