Skip to content
Permalink
Browse files

updated readme

  • Loading branch information...
EdrisT committed May 26, 2019
1 parent 9b28f56 commit d11b8526aad6f1332008c5970400b461de950493
Showing with 10 additions and 2 deletions.
  1. +1 −1 Default.sublime-commands
  2. +4 −1 README.md
  3. +5 −0 messages/install.txt
@@ -1,6 +1,6 @@
[
{
"caption": "Powershell: Fix certain warnings with PSScriptAnalyzer",
"caption": "Powershell: Fix warnings",
"command": "build",
"args": {
"build_system": "Packages/SublimeLinter-contrib-Powershell/PSScriptAnalyzer_AutoFix.sublime-build",
@@ -23,7 +23,10 @@ An example [settings file](https://github.com/EdrisT/SublimeLinter-contrib-Power

2. 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.

3. 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)
3. 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
@@ -16,6 +16,11 @@ The linter will decide which settings to use in the following order:

3. 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.


For more information, please see:
https://github.com/EdrisT/SublimeLinter-contrib-Powershell
https://github.com/PowerShell/PSScriptAnalyzer

0 comments on commit d11b852

Please sign in to comment.
You can’t perform that action at this time.