Merge branch 'development' into kapilmb/use-should-process-rule

Author: Kapil Borle

CHANGELOG.MD

@@ -1,4 +1,26 @@
-## [1.11.0](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.11.0) - 2017-03-01
+## [unreleased]
+
+## Fixed
+- `PSAlignAssignmentStatement` to align assignment statements in DSC configurations that have *Undefined DSC Resource* parse errors.
+
+## [1.12.0](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.11.1) - 2017-05-09
+
+### Added
+- [PSAlignAssignmentRuleStatement](https://github.com/PowerShell/PSScriptAnalyzer/blob/cca9a2d7ee35be7322f8c5a09b6c500a0a8bd101/RuleDocumentation/AlignAssignmentStatement.md) rule to align assignment statements in property value pairs (#753).
+
+### Fixed
+- `PSAvoidGlobalVars` rule to ignore `$global:lastexitcode` (#752).
+- `PSUseConsistentIndentation` to account for backtick on preceding line (#749).
+- `PSPlaceCloseBrace` to ignore one-line blocks when `NewLineAfter` switch is on (#748).
+
+## [1.11.1](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.11.1) - 2017-04-04
+### Fixed
+- CodeFormatting settings file (#727, #728).
+- Whitelisted aliases comparison in AvoidUsingCmdletAliases rule (#739).
+- PlaceCloseBrace rule behavior for NewLineAfter option (#741).
+- UseConsistentIndentation rule to ignore open brace in magic methods (#744).
+
+## [1.11.0](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.11.0) - 2017-03-01
 ### Added
 - Built-in settings presets to specify settings from command line (#717). Currently, PSSA ships with `PSGallery`, `CodeFormatting`, `DSC`, and other settings presets. All of them can be found in the `Settings/` directory in the module. To use them just pass them as an argument to the `Settings` parameter. For example, if you want to run rules that *powershellgallery* runs, then use the following command.
 ```powershell

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -206,6 +206,16 @@ public SwitchParameter SaveDscDependency
         }
         private bool saveDscDependency;
 #endif // !PSV3
+
+#if DEBUG
+        [Parameter(Mandatory = false)]
+        public SwitchParameter AttachAndDebug
+        {
+            get { return attachAndDebug; }
+            set { attachAndDebug = value; }
+        }
+        private bool attachAndDebug = false;
+#endif
         #endregion Parameters
 
         #region Overrides
@@ -216,6 +226,19 @@ public SwitchParameter SaveDscDependency
         protected override void BeginProcessing()
         {
             // Initialize helper
+#if DEBUG
+            if (attachAndDebug)
+            {
+                if (System.Diagnostics.Debugger.IsAttached)
+                {
+                    System.Diagnostics.Debugger.Break();
+                }
+                else
+                {
+                    System.Diagnostics.Debugger.Launch();
+                }
+            }
+#endif
             Helper.Instance = new Helper(
                 SessionState.InvokeCommand,
                 this);

Engine/PSScriptAnalyzer.psd1

@@ -11,7 +11,7 @@ Author = 'Microsoft Corporation'
 RootModule = 'PSScriptAnalyzer.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.11.0'
+ModuleVersion = '1.12.0'
 
 # ID used to uniquely identify this module
 GUID = 'd6245802-193d-4068-a631-8863a4342a18'
@@ -88,23 +88,12 @@ PrivateData = @{
         IconUri = ''
         ReleaseNotes = @'
 ### Added
-- Built-in settings presets to specify settings from command line (#717). Currently, PSSA ships with `PSGallery`, `CodeFormatting`, `DSC`, and other settings presets. All of them can be found in the `Settings/` directory in the module. To use them just pass them as an argument to the `Settings` parameter. For example, if you want to run rules that *powershellgallery* runs, then use the following command.
-```powershell
-PS> Invoke-ScriptAnalyzer -Path /path/to/your/module -Settings PSGallery
-```
-- Argument completion for built-in settings presets (#717).
-- Argument completion for `IncludeRule` and `ExcludeRule` parameters (#717).
-- Option to `PSCloseBrace` rule to add new line after the brace (#713).
-- Option to `PSCloseBrace` rule to ignore expressions that have open and close braces on the same line (#706).
-- New rule, PSUseConsistentWhitespace, to check for whitespace style around operators and separators (#702).
+- PSAlignAssignmentRuleStatement rule to align assignment statements in property value pairs (#753).
 
 ### Fixed
-- Indentation when pipes precede new lines in a multi-line command expression in `PSUseConsistentIdentation` rule (#705).
-- Handling of SubExpressionAsts (`$(...)`) in `PSUseConsistentIdentation` rule (#700).
-- Performance issues caused by `get-command` cmdlet (#695).
-
-### Changed
-- Settings implementation to decouple it from engine (#717).
+- `PSAvoidGlobalVars` rule to ignore `$global:lastexitcode` (#752).
+- `PSUseConsistentIndentation` to account for backtick on preceding line (#749).
+- `PSPlaceCloseBrace` to ignore one-line blocks when `NewLineAfter` switch is on (#748).
 '@
     }
 }
@@ -121,3 +110,5 @@ PS> Invoke-ScriptAnalyzer -Path /path/to/your/module -Settings PSGallery
 
 
 
+
+

Engine/Settings/CodeFormatting.psd1

@@ -2,8 +2,9 @@
     IncludeRules = @(
         'PSPlaceOpenBrace',
         'PSPlaceCloseBrace',
+        'PSUseConsistentWhitespace',
         'PSUseConsistentIndentation',
-        'PSUseConsistentWhitespace'
+        'PSAlignAssignmentStatement'
     )
 
     Rules = @{
@@ -30,5 +31,10 @@
             CheckSeparator = $true
         }
 
+        PSAlignAssignmentStatement = @{
+            Enable = $true
+            CheckHashtable = $true
+            CheckDSCConfiguration = $true
+        }
     }
 }

Engine/SpecialVars.cs

@@ -164,6 +164,7 @@ internal enum PreferenceVariable
         internal const string Null = "null";
         internal const string True = "true";
         internal const string False = "false";
+        internal const string LastExitCode = "LastExitCode";
 
         internal static readonly string[] OtherInitializedVariables = new string[]
                                                                 {
@@ -184,7 +185,8 @@ internal enum PreferenceVariable
                                                                     pwd,
                                                                     Null,
                                                                     True,
-                                                                    False
+                                                                    False,
+                                                                    LastExitCode
                                                                 };
 
     }

Engine/TokenOperations.cs

@@ -297,6 +297,11 @@ public IEnumerable<Tuple<Token, int>> GetOpenParensWithWhiteSpacesBefore()
             return GetTokenAndPrecedingWhitespace(TokenKind.LParen);
         }
 
+        public static int GetExtentWidth(IScriptExtent extent)
+        {
+            return extent.EndOffset - extent.StartOffset;
+        }
+
         private bool OnSameLine(Token token1, Token token2)
         {
             return token1.Extent.StartLineNumber == token2.Extent.EndLineNumber;

Engine/project.json

@@ -1,6 +1,6 @@
 {
   "name": "Microsoft.Windows.PowerShell.ScriptAnalyzer",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "dependencies": {
 "System.Management.Automation": "1.0.0-alpha12"
     },

RuleDocumentation/AlignAssignmentStatement.md

@@ -0,0 +1,48 @@
+# AlignAssignmentStatement
+
+**Severity Level: Warning**
+
+## Description
+
+Consecutive assignment statements are more readable if they are aligned. By aligned, we imply that the `equal` sign for all the assignment statements should be in the same column.
+
+The rule looks for key (property) value pairs in a hashtable (DSC configuration) to check if they are aligned or not. Consider the following example in which the key value pairs are not aligned.
+
+```powershell
+$hashtable = @{
+    property1 = "value"
+    anotherProperty = "another value"
+}
+```
+
+Alignment in this case would look like the following.
+
+```powershell
+$hashtable = @{
+    property1       = "value"
+    anotherProperty = "another value"
+}
+```
+
+The rule will ignore hashtables in which the assignment statements are on the same line. For example, the rule will ignore `$h = {a = 1; b = 2}`.
+
+## Configuration
+
+```powershell
+    Rules = @{
+        PSAlignAssignmentStatement = @{
+            Enable = $true
+            CheckHashtable = $true
+        }
+    }
+```
+
+### Parameters
+
+#### Enable: bool (Default value is `$false`)
+
+Enable or disable the rule during ScriptAnalyzer invocation.
+
+#### CheckHashtable: bool (Default value is `$false`)
+
+Enforce alignment of assignment statements in a hashtable and in a DSC Configuration. There is only one switch for hasthable and DSC configuration because the property value pairs in a DSC configuration are parsed as key value pairs of a hashtable.

RuleDocumentation/ProvideDefaultParameterValue.md renamed to RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md

@@ -1,4 +1,4 @@
-# ProvideDefaultParameterValue
+# AvoidDefaultValueForMandatoryParameter
 
 **Severity Level: Warning**
 

RuleDocumentation/AvoidDefaultTrueValueSwitchParameter.md renamed to RuleDocumentation/AvoidDefaultValueSwitchParameter.md

@@ -1,4 +1,4 @@
-# AvoidDefaultTrueValueSwitchParameter
+# AvoidDefaultValueSwitchParameter
 
 **Severity Level: Warning**
 

RuleDocumentation/AvoidAlias.md renamed to RuleDocumentation/AvoidUsingCmdletAliases.md

@@ -1,4 +1,4 @@
-# AvoidAlias
+# AvoidUsingCmdletAliases
 
 **Severity Level: Warning**
 

RuleDocumentation/AvoidEmptyCatchBlock.md renamed to RuleDocumentation/AvoidUsingEmptyCatchBlock.md

@@ -1,4 +1,4 @@
-# AvoidEmptyCatchBlock
+# AvoidUsingEmptyCatchBlock
 
 **Severity Level: Warning**
 

RuleDocumentation/MisleadingBacktick.md

@@ -0,0 +1,7 @@
+# MisleadingBacktick
+
+**Severity Level: Warning**
+
+## Description
+
+Checks that lines don't end with a backtick followed by whitespace.

RuleDocumentation/AvoidReservedCharInCmdlet.md renamed to RuleDocumentation/ReservedCmdletChar.md

@@ -1,4 +1,4 @@
-# AvoidReservedCharInCmdlet
+# ReservedCmdletChar
 
 **Severity Level: Error**
 

RuleDocumentation/AvoidReservedParams.md renamed to RuleDocumentation/ReservedParams.md

@@ -1,4 +1,4 @@
-# AvoidReservedParams
+# ReservedParams
 
 **Severity Level: Error**
 

RuleDocumentation/ReturnCorrectTypeDSCFunctions.md renamed to RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md

@@ -1,4 +1,4 @@
-# ReturnCorrectTypeDSCFunctions
+# ReturnCorrectTypesForDSCFunctions
 
 **Severity Level: Information**
 

RuleDocumentation/UseShouldProcessCorrectly.md renamed to RuleDocumentation/ShouldProcess.md

@@ -1,4 +1,4 @@
-# UseShouldProcessCorrectly
+# ShouldProcess
 
 **Severity Level: Warning**
 

RuleDocumentation/UseStandardDSCFunctionsInResource.md renamed to RuleDocumentation/StandardDSCFunctionsInResource.md

@@ -1,4 +1,4 @@
-# UseStandardDSCFunctionsInResource
+# StandardDSCFunctionsInResource
 
 **Severity Level: Error**
 

RuleDocumentation/UseIdenticalMandatoryParametersDSC.md renamed to RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md

@@ -1,4 +1,4 @@
-# UseIdenticalMandatoryParametersDSC
+# UseIdenticalMandatoryParametersForDSC
 
 **Severity Level: Error**
 

RuleDocumentation/UseIdenticalParametersDSC.md renamed to RuleDocumentation/UseIdenticalParametersForDSC.md

@@ -1,4 +1,4 @@
-# UseIdenticalParametersDSC
+# UseIdenticalParametersForDSC
 
 **Severity Level: Error**
 

RuleDocumentation/UseUTF8EncodingForHelpFile.md

@@ -0,0 +1,7 @@
+# UseUTF8EncodingForHelpFile
+
+**Severity Level: Warning**
+
+## Description
+
+Check if help file uses utf8 encoding

RuleDocumentation/ProvideVerboseMessage.md renamed to RuleDocumentation/UseVerboseMessageInDSCResource.md

@@ -1,4 +1,4 @@
-# ProvideVerboseMessage
+# UseVerboseMessageInDSCResource
 
 **Severity Level: Information**