doc/ale-powershell.txt

   1 ===============================================================================
   2 ALE PowerShell Integration                             *ale-powershell-options*
   3
   4
   5 ===============================================================================
   6 cspell                                                  *ale-powershell-cspell*
   7
   8 See |ale-cspell-options|
   9
  10
  11 ===============================================================================
  12 powershell                                          *ale-powershell-powershell*
  13
  14                                  *ale-options.powershell_powershell_executable*
  15                                        *g:ale_powershell_powershell_executable*
  16                                        *b:ale_powershell_powershell_executable*
  17 powershell_powershell_executable
  18 g:ale_powershell_powershell_executable
  19   Type: |String|
  20   Default: `'pwsh'`
  21
  22   This variable can be changed to use a different executable for powershell.
  23
  24 >
  25   " Use powershell.exe rather than the default pwsh
  26   let g:ale_powershell_powershell_executable = 'powershell.exe'
  27 >
  28
  29 ===============================================================================
  30 psscriptanalyzer                              *ale-powershell-psscriptanalyzer*
  31
  32
  33 -------------------------------------------------------------------------------
  34 Installation
  35
  36 Install PSScriptAnalyzer by any means, so long as it can be automatically
  37 imported in PowerShell.
  38
  39
  40 -------------------------------------------------------------------------------
  41 Options
  42                            *ale-options.powershell_psscriptanalyzer_executable*
  43                                  *g:ale_powershell_psscriptanalyzer_executable*
  44                                  *b:ale_powershell_psscriptanalyzer_executable*
  45 powershell_psscriptanalyzer_executable
  46 g:ale_powershell_psscriptanalyzer_executable
  47   Type: |String|
  48   Default: `'pwsh'`
  49
  50   This variable sets executable used for powershell.
  51
  52   For example, on Windows you could set powershell to be Windows Powershell:
  53 >
  54   let g:ale_powershell_psscriptanalyzer_executable = 'powershell.exe'
  55 <
  56
  57                                *ale-options.powershell_psscriptanalyzer_module*
  58                                      *g:ale_powershell_psscriptanalyzer_module*
  59                                      *b:ale_powershell_psscriptanalyzer_module*
  60 powershell_psscriptanalyzer_module
  61 g:ale_powershell_psscriptanalyzer_module
  62   Type: |String|
  63   Default: `'psscriptanalyzer'`
  64
  65   This variable sets the name of the psscriptanalyzer module.
  66   for psscriptanalyzer invocation.
  67
  68                            *ale-options.powershell_psscriptanalyzer_exclusions*
  69                                  *g:ale_powershell_psscriptanalyzer_exclusions*
  70                                  *b:ale_powershell_psscriptanalyzer_exclusions*
  71 powershell_psscriptanalyzer_exclusions
  72 g:ale_powershell_psscriptanalyzer_exclusions
  73   Type: |String|
  74   Default: `''`
  75
  76   Set this variable to exclude test(s) for psscriptanalyzer
  77   (-ExcludeRule option).  To exclude more than one option, separate them with
  78   commas. >
  79
  80   " Suppress Write-Host and Global vars warnings
  81   let g:ale_powershell_psscriptanalyzer_exclusions =
  82   \  'PSAvoidUsingWriteHost,PSAvoidGlobalVars'
  83 <
  84
  85 ===============================================================================
  86   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: