SublimeLinter-contrib-Powershell
SublimeLinter plugin for PowerShell
Details
Installs
- Total 7K
- Win 5K
- Mac 750
- Linux 591
Feb 22 | Feb 21 | Feb 20 | Feb 19 | Feb 18 | Feb 17 | Feb 16 | Feb 15 | Feb 14 | Feb 13 | Feb 12 | Feb 11 | Feb 10 | Feb 9 | Feb 8 | Feb 7 | Feb 6 | Feb 5 | Feb 4 | Feb 3 | Feb 2 | Feb 1 | Jan 31 | Jan 30 | Jan 29 | Jan 28 | Jan 27 | Jan 26 | Jan 25 | Jan 24 | Jan 23 | Jan 22 | Jan 21 | Jan 20 | Jan 19 | Jan 18 | Jan 17 | Jan 16 | Jan 15 | Jan 14 | Jan 13 | Jan 12 | Jan 11 | Jan 10 | Jan 9 | Jan 8 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 1 | 1 | 2 | 2 | 3 | 1 | 0 | 0 | 2 | 3 | 2 | 3 | 2 | 3 | 0 | 0 | 3 | 0 | 4 | 3 | 1 | 0 | 4 | 2 | 3 | 1 | 2 | 0 | 0 | 2 | 3 | 1 | 1 | 1 | 0 | 2 | 2 | 2 | 5 | 7 | 0 | 0 | 2 | 2 | 2 |
Mac | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 2 | 1 | 1 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
SublimeLinter-contrib-powershell
This linter plugin for SublimeLinter provides an interface to PSScriptAnalyzer. It will be used with files that have the PowerShell
syntax.
This linter works on Windows PowerShell 3.0 or greater and PowerShell Core 6.2 or greater on Windows/Linux/macOS.
You can check your powershell version with $PSVersionTable.PSVersion
from a powershell prompt.
Installation
SublimeLinter must be installed in order to use this plugin. Please use Package Control to install the linter plugin.
Before installing this plugin, you must ensure that PSScriptAnalyzer is installed on your system and available on powershell startup.
PSScriptAnalyzer can be installed with Install-Module -Name PSScriptAnalyzer
from a powershell prompt, which automatically makes the module available on powershell startup.
Settings
The simplest way to change the ScriptAnalyzer settings is from a settings file.
An example settings file with commented options is located in this plugins root folder. The provided example settings file checks for compatibility with powershell 3.0 and excludes the check for trailing spaces.
The linter will decide which settings to use in the following order:
If a valid PSScriptAnalyzerSettings.psd1 file exists in your project folder, those settings will have precedence over all other settings. This enables you to use different settings for different projects.
If the environment variable
Env:PSScriptAnalyzerSettingsPath
exists in your powershell environment and is populated with the full path to a valid settings file, those settings will be used.If the variable
$GlobalPSScriptAnalyzerSettingsPath
exists in your powershell environment and is populated with the full path to a valid settings file, those settings will be used. This enables you to use global custom settings. For persistency, set this variable in your powershell profile.If no settings file is found in your project folder and the
$GlobalPSScriptAnalyzerSettingsPath
variable is not set, default settings of PSScriptAnalyzer will be used. (all default rules enabled and no compatibility checks)
PSScriptAnalyzer have the ability to automatically fix certain warnings. For example expanding aliases. Even though I believe this functionality is fairly tested, always make sure to back your files before using it.
Type Powershell: Fix warnings
in the command palette to try it out.
SublimeLinter settings
- SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html
- Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html