Change configuration to settings

Author: Quoc Truong

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -174,13 +174,13 @@ public SwitchParameter SuppressedOnly
         [Alias("Profile")]
         [Parameter(Mandatory = false)]
         [ValidateNotNull]
-        public object Configuration
+        public object Settings
         {
-            get { return configuration; }
-            set { configuration = value; }
+            get { return settings; }
+            set { settings = value; }
         }
 
-        private object configuration;
+        private object settings;
 
         private bool stopProcessing;
 
@@ -196,7 +196,7 @@ protected override void BeginProcessing()
             string[] rulePaths = Helper.ProcessCustomRulePaths(customRulePath,
                 this.SessionState, recurseCustomRulePath);
 
-            if (!ScriptAnalyzer.Instance.ParseProfile(this.configuration, this.SessionState.Path, this))
+            if (!ScriptAnalyzer.Instance.ParseProfile(this.settings, this.SessionState.Path, this))
             {
                 stopProcessing = true;
                 return;

Engine/Strings.Designer.cs

@@ -193,16 +193,16 @@
     <value>Cannot find any DiagnosticRecord with the Rule Suppression ID {0}.</value>
   </data>
   <data name="WrongKey" xml:space="preserve">
-    <value>{0} is not a valid key in the configuration hashtable: line {1} column {2} in file {3}. Valid keys are ExcludeRules, IncludeRules and Severity.</value>
+    <value>{0} is not a valid key in the settings hashtable: line {1} column {2} in file {3}. Valid keys are ExcludeRules, IncludeRules and Severity.</value>
   </data>
   <data name="WrongKeyFormat" xml:space="preserve">
-    <value>Key in the configuration hashtable should be a string: line {0} column {1} in file {2}</value>
+    <value>Key in the settings hashtable should be a string: line {0} column {1} in file {2}</value>
   </data>
   <data name="WrongValueFormat" xml:space="preserve">
-    <value>Value in the configuration hashtable should be a string or an array of strings: line {0} column {1} in file {2}</value>
+    <value>Value in the settings hashtable should be a string or an array of strings: line {0} column {1} in file {2}</value>
   </data>
   <data name="InvalidProfile" xml:space="preserve">
-    <value>Profile file '{0}' is invalid because it does not contain a hashtable.</value>
+    <value>Settings file '{0}' is invalid because it does not contain a hashtable.</value>
   </data>
   <data name="ParseErrorFormatForScriptDefinition" xml:space="preserve">
     <value>Parse error in script definition:  {0} at line {1} column {2}.</value>
@@ -217,30 +217,30 @@
     <value>Analyzing Script Definition.</value>
   </data>
   <data name="ConfigurationFileHasNoHashTable" xml:space="preserve">
-    <value>ConfigurationFileHasNoHashTable</value>
+    <value>SettingsFileHasNoHashTable</value>
   </data>
   <data name="ConfigurationFileNotFound" xml:space="preserve">
-    <value>ConfigurationFileNotFound</value>
+    <value>SettingsFileNotFound</value>
   </data>
   <data name="ConfigurationKeyNotAString" xml:space="preserve">
-    <value>ConfigurationKeyNotAString</value>
+    <value>SettingsKeyNotAString</value>
   </data>
   <data name="ConfigurationValueNotAString" xml:space="preserve">
-    <value>ConfigurationValueNotAString</value>
+    <value>SettingsValueNotAString</value>
   </data>
   <data name="ConfigurationValueWrongFormat" xml:space="preserve">
-    <value>ConfigurationValueWrongFormat</value>
+    <value>SettingsValueWrongFormat</value>
   </data>
   <data name="WrongConfigurationKey" xml:space="preserve">
-    <value>WrongConfigurationKey</value>
+    <value>WrongSettingsKey</value>
   </data>
   <data name="KeyNotString" xml:space="preserve">
-    <value>Key {0} in the configuration is not a string.</value>
+    <value>Key {0} in the settings is not a string.</value>
   </data>
   <data name="WrongKeyHashTable" xml:space="preserve">
-    <value>{0} is not a valid key in the configuration hashtable. Valid keys are ExcludeRules, IncludeRules and Severity.</value>
+    <value>{0} is not a valid key in the settings hashtable. Valid keys are ExcludeRules, IncludeRules and Severity.</value>
   </data>
   <data name="WrongValueHashTable" xml:space="preserve">
-    <value>Value {0} for key {1} has the wrong data type. Value in the configuration hashtable should be a string or an array of strings.</value>
+    <value>Value {0} for key {1} has the wrong data type. Value in the settings hashtable should be a string or an array of strings.</value>
   </data>
 </root>

Engine/Strings.resx

@@ -55,7 +55,7 @@ Describe "GlobalSuppression" {
         }
 
         It "Does not raise any violation for computername hard-coded using configuration hashtable" {
-            $hashtableConfiguration = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Configuration @{"includerules" = @("PSAvoidUsingCmdletAliases", "PSUseOutputTypeCorrectly")} |
+            $hashtableConfiguration = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Settings @{"includerules" = @("PSAvoidUsingCmdletAliases", "PSUseOutputTypeCorrectly")} |
                                         Where-Object { $_.RuleName -eq "PSAvoidUsingComputerNameHardcoded"}
             $hashtableConfiguration.Count | Should Be 0
         }
@@ -77,29 +77,29 @@ Describe "GlobalSuppression" {
         }
 
         It "Does not raise any violation for use output type correctly with configuration hashtable" {
-            $hashtableConfiguration = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Configuration @{"severity" = "warning"} |
+            $hashtableConfiguration = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Settings @{"severity" = "warning"} |
                                     Where-Object {$_.RuleName -eq "PSUseOutputTypeCorrectly"}
             $hashtableConfiguration.Count | should be 0
         }
     }
 
     Context "Error Case" {
         It "Raises Error for file not found" {
-            $invokeWithError = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Configuration ".\ThisFileDoesNotExist.ps1" -ErrorAction SilentlyContinue
+            $invokeWithError = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Settings ".\ThisFileDoesNotExist.ps1" -ErrorAction SilentlyContinue
             $invokeWithError.Count | should be 0
-            $Error[0].FullyQualifiedErrorId | should match "ConfigurationFileNotFound,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"
+            $Error[0].FullyQualifiedErrorId | should match "SettingsFileNotFound,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"
         }
 
         It "Raises Error for file with no hash table" {
-            $invokeWithError = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Configuration "$directory\GlobalSuppression.ps1" -ErrorAction SilentlyContinue
+            $invokeWithError = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Settings "$directory\GlobalSuppression.ps1" -ErrorAction SilentlyContinue
             $invokeWithError.Count | should be 0
-            $Error[0].FullyQualifiedErrorId | should match "ConfigurationFileHasNoHashTable,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"
+            $Error[0].FullyQualifiedErrorId | should match "SettingsFileHasNoHashTable,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"
         }
 
         It "Raises Error for wrong profile" {
-            $invokeWithError = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Configuration "$directory\WrongProfile.ps1" -ErrorAction SilentlyContinue
+            $invokeWithError = Invoke-ScriptAnalyzer "$directory\GlobalSuppression.ps1" -Settings "$directory\WrongProfile.ps1" -ErrorAction SilentlyContinue
             $invokeWithError.Count | should be 0
-            $Error[0].FullyQualifiedErrorId | should match "WrongConfigurationKey,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"
+            $Error[0].FullyQualifiedErrorId | should match "WrongSettingsKey,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"
         }
     }
 }