| Bram Moolenaar | 4d8f476 | 2021-06-27 15:18:56 +0200 | [diff] [blame] | 1 | *ft_ps1.txt* A Windows PowerShell syntax plugin for Vim |
| Bram Moolenaar | 130cbfc | 2021-04-07 21:07:20 +0200 | [diff] [blame] | 2 | |
| 3 | Author: Peter Provost <https://www.github.com/PProvost> |
| 4 | License: Apache 2.0 |
| 5 | URL: https://github.com/PProvost/vim-ps1 |
| 6 | |
| 7 | INTRODUCTION *ps1-syntax* |
| 8 | |
| 9 | This plugin provides Vim syntax, indent and filetype detection for Windows |
| 10 | PowerShell scripts, modules, and XML configuration files. |
| 11 | |
| 12 | |
| 13 | ABOUT *ps1-about* |
| 14 | |
| 15 | Grab the latest version or report a bug on GitHub: |
| 16 | |
| 17 | https://github.com/PProvost/vim-ps1 |
| 18 | |
| 19 | |
| 20 | FOLDING *ps1-folding* |
| 21 | |
| 22 | The ps1 syntax file provides syntax folding (see |:syn-fold|) for script blocks |
| 23 | and digital signatures in scripts. |
| 24 | |
| 25 | When 'foldmethod' is set to "syntax" then function script blocks will be |
| 26 | folded unless you use the following in your .vimrc or before opening a script: > |
| 27 | |
| 28 | :let g:ps1_nofold_blocks = 1 |
| 29 | < |
| 30 | Digital signatures in scripts will also be folded unless you use: > |
| 31 | |
| 32 | :let g:ps1_nofold_sig = 1 |
| 33 | < |
| 34 | Note: syntax folding might slow down syntax highlighting significantly, |
| 35 | especially for large files. |
| 36 | |
| 37 | |
| 38 | COMPILER *ps1-compiler* |
| 39 | |
| 40 | The powershell `:compiler` script configures |:make| to execute the script in |
| 41 | PowerShell. |
| 42 | |
| 43 | It tries to pick a smart default PowerShell command: `pwsh` if available and |
| 44 | `powershell` otherwise, but you can customize the command: > |
| 45 | |
| 46 | :let g:ps1_makeprg_cmd = '/path/to/pwsh' |
| 47 | < |
| 48 | To configure whether to show the exception type information: > |
| 49 | |
| 50 | :let g:ps1_efm_show_error_categories = 1 |
| 51 | < |
| 52 | |
| 53 | KEYWORD LOOKUP *ps1-keyword* |
| 54 | |
| 55 | To look up keywords using PowerShell's Get-Help, press the |K| key. For more |
| 56 | convenient paging, the pager `less` should be installed, which is included in |
| 57 | many Linux distributions and in macOS. |
| 58 | |
| 59 | Many other distributions are available for Windows like |
| 60 | https://chocolatey.org/packages/less/. Make sure `less` is in a directory |
| 61 | listed in the `PATH` environment variable, which chocolatey above does. |
| 62 | |
| 63 | ------------------------------------------------------------------------------ |
| 64 | vim:ft=help: |