Improve post-build command, fix spelling mistakes.

Kory Gill · Kory Gill · commit efdfba9cd13d · 2015-12-08T20:54:10.000-08:00
diff --git a/Engine/Generic/AvoidCmdletGeneric.cs b/Engine/Generic/AvoidCmdletGeneric.cs
@@ -24,7 +24,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
     public abstract class AvoidCmdletGeneric : IScriptRule
     {
         /// <summary>
-        /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the anaylsis.
+        /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the analysis.
         /// </summary>
         /// <param name="ast">The script's ast</param>
         /// <param name="fileName">The name of the script file being analyzed</param>
@@ -38,7 +38,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
 
             List<String> cmdletNameAndAliases = Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper.Instance.CmdletNameAndAliases(GetCmdletName());
 
-            // Iterrates all CommandAsts and check the command name.
+            // Iterates all CommandAsts and check the command name.
             foreach (CommandAst cmdAst in commandAsts)
             {
                 if (cmdAst.GetCommandName() == null) continue;
diff --git a/Engine/Generic/AvoidParameterGeneric.cs b/Engine/Generic/AvoidParameterGeneric.cs
@@ -23,7 +23,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
     public abstract class AvoidParameterGeneric : IScriptRule
     {
         /// <summary>
-        /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the anaylsis.
+        /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the analysis.
         /// </summary>
         /// <param name="ast">The script's ast</param>
         /// <param name="fileName">The name of the script file being analyzed</param>
@@ -35,7 +35,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             // Finds all CommandAsts.
             IEnumerable<Ast> commandAsts = ast.FindAll(testAst => testAst is CommandAst, true);
 
-            // Iterrates all CommandAsts and check the condition.
+            // Iterates all CommandAsts and check the condition.
             foreach (CommandAst cmdAst in commandAsts)
             {
                 if (CommandCondition(cmdAst) && cmdAst.CommandElements != null)
diff --git a/Engine/Generic/ILogger.cs b/Engine/Generic/ILogger.cs
@@ -34,7 +34,7 @@ public interface ILogger
         string GetName();
 
         /// <summary>
-        /// GetDescription: Retrives the description of the logger.
+        /// GetDescription: Retrieves the description of the logger.
         /// </summary>
         /// <returns>The description of the logger</returns>
         string GetDescription();
diff --git a/Engine/Generic/IScriptRule.cs b/Engine/Generic/IScriptRule.cs
@@ -25,7 +25,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
     public interface IScriptRule : IRule
     {
         /// <summary>
-        /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the anaylsis.
+        /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the analysis.
         /// </summary>
         /// <param name="ast">The script's ast</param>
         /// <param name="fileName">The name of the script file being analyzed</param>
diff --git a/Engine/Generic/SourceType.cs b/Engine/Generic/SourceType.cs
@@ -23,7 +23,7 @@ public enum SourceType : uint
         Builtin = 0,
 
         /// <summary>
-        /// MANAGED: Indicates the script analyzer rule is contirbuted as a managed rule.
+        /// MANAGED: Indicates the script analyzer rule is contributed as a managed rule.
         /// </summary>
         Managed = 1,
 
diff --git a/Engine/PSScriptAnalyzer.psd1 b/Engine/PSScriptAnalyzer.psd1
@@ -23,7 +23,7 @@ CompanyName = 'Microsoft Corporation'
 Copyright = '(c) Microsoft Corporation 2015. All rights reserved.'
 
 # Description of the functionality provided by this module
-Description = 'PSScriptAnalyzer provides script analysis and checks for potential code defects in the scripts by applying a group of builtin or customized rules on the scripts being analyzed.'
+Description = 'PSScriptAnalyzer provides script analysis and checks for potential code defects in the scripts by applying a group of built-in or customized rules on the scripts being analyzed.'
 
 # Minimum version of the Windows PowerShell engine required by this module
 PowerShellVersion = '5.0'
diff --git a/Engine/ScriptAnalyzer.cs b/Engine/ScriptAnalyzer.cs
@@ -888,7 +888,7 @@ public Dictionary<string, List<string>> CheckRuleExtension(string[] path, PathIn
                 }
             }
 
-            // Resloves relative paths.
+            // Resolves relative paths.
             try
             {
                 for (int i = 0; i < validModPaths.Count; i++)
diff --git a/Engine/VariableAnalysis.cs b/Engine/VariableAnalysis.cs
@@ -133,7 +133,7 @@ private void ProcessParameters(IEnumerable<ParameterAst> parameters)
         }
 
         /// <summary>
-        /// Used to analyze scriptbloct, functionmemberast or functiondefinitionast
+        /// Used to analyze scriptblock, functionmemberast or functiondefinitionast
         /// </summary>
         /// <param name="ast"></param>
         /// <returns></returns>
diff --git a/Engine/VariableAnalysisBase.cs b/Engine/VariableAnalysisBase.cs
@@ -552,7 +552,7 @@ internal static Block[] SetDominators(Block entry, List<Block> Blocks)
 
                     Block dom = block._predecessors[0];
 
-                    // Get first proccessed node
+                    // Get first processed node
                     foreach (var pred in block._predecessors)
                     {
                         if (dominators[pred.PostOrder] != null)
@@ -828,14 +828,14 @@ internal static Tuple<Dictionary<string, VariableAnalysisDetails>, Dictionary<st
                 }
             }
 
-            // Initialize variables in internaldictionary to undetermined
+            // Initialize variables in internal dictionary to undetermined
             foreach (var key in InternalVariablesDictionary.Keys.ToList())
             {
                 InternalVariablesDictionary[key].Constant = Undetermined.UndeterminedConstant;
                 InternalVariablesDictionary[key].Type = typeof(Undetermined);
             }
 
-            // Initialze DefinedBlock of phi function. If it is null then that phi function is not initialized;
+            // Initialize DefinedBlock of phi function. If it is null then that phi function is not initialized;
             foreach (var block in blocks)
             {
                 foreach (var phi in block.Phis)
@@ -956,7 +956,7 @@ internal static Tuple<Dictionary<string, VariableAnalysisDetails>, Dictionary<st
                         {
                             CommandExpressionAst cmeAst = assigned._rightAst as CommandExpressionAst;
                             MemberExpressionAst memAst = (cmeAst != null) ? (cmeAst.Expression as MemberExpressionAst) : null;
-                            // Don't handle the this case because this is handled in assignmenttarget
+                            // Don't handle the this case because this is handled in assignment target
 
                             if (memAst != null && memAst.Expression is VariableExpressionAst)
                             {
@@ -2042,7 +2042,7 @@ public object VisitNamedAttributeArgument(NamedAttributeArgumentAst namedAttribu
         /// <returns></returns>
         public object VisitParameter(ParameterAst parameterAst)
         {
-            // Nothing to do now, we've already allocated parameters in the first pass looking for all variable naems.
+            // Nothing to do now, we've already allocated parameters in the first pass looking for all variable names.
             System.Diagnostics.Debug.Assert(false, "Code is unreachable");
             return null;
         }
@@ -2812,7 +2812,7 @@ public object VisitBinaryExpression(BinaryExpressionAst binaryExpressionAst)
                 // left operand is always evaluated, visit it's expression in the current block.
                 binaryExpressionAst.Left.Visit(this.Decorator);
 
-                // The right operand is condtionally evaluated.  We aren't generating any code here, just
+                // The right operand is conditionally evaluated.  We aren't generating any code here, just
                 // modeling the flow graph, so we just visit the right operand in a new block, and have
                 // both the current and new blocks both flow to a post-expression block.
                 var targetBlock = new Block();
diff --git a/Engine/about_PSScriptAnalyzer.help.txt b/Engine/about_PSScriptAnalyzer.help.txt
@@ -88,7 +88,7 @@ RUNNING SCRIPT ANALYZER ON AN EXISTING SCRIPT, MODULE OR DSC RESOURCE
         see if the output is "manageable".  If it isn't, then you will want to "ease 
         into" things by starting with the most serious violations first - errors.
         
-        You may be temtped to use the Invoke-ScriptAnalyzer command's Severity 
+        You may be tempted to use the Invoke-ScriptAnalyzer command's Severity 
         parameter with the argument Error to do this - don't.  This will run every 
         built-in rule and then filter the results during output.  The more rules the 
         script analyzer runs, the longer it will take to analyze a file.  You can 
diff --git a/Rules/AvoidAlias.cs b/Rules/AvoidAlias.cs
@@ -35,7 +35,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             // Finds all CommandAsts.
             IEnumerable<Ast> foundAsts = ast.FindAll(testAst => testAst is CommandAst, true);
 
-            // Iterrates all CommandAsts and check the command name.
+            // Iterates all CommandAsts and check the command name.
             foreach (Ast foundAst in foundAsts)
             {
                 CommandAst cmdAst = (CommandAst)foundAst;
diff --git a/Rules/AvoidDefaultTrueValueSwitchParameter.cs b/Rules/AvoidDefaultTrueValueSwitchParameter.cs
@@ -36,7 +36,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             // Finds all ParamAsts.
             IEnumerable<Ast> paramAsts = ast.FindAll(testAst => testAst is ParameterAst, true);
 
-            // Iterrates all ParamAsts and check if any are switch.
+            // Iterates all ParamAsts and check if any are switch.
             foreach (ParameterAst paramAst in paramAsts)
             {
                 if (paramAst.Attributes.Any(attr => attr.TypeName.GetReflectionType() == typeof(System.Management.Automation.SwitchParameter))
diff --git a/Rules/AvoidEmptyCatchBlock.cs b/Rules/AvoidEmptyCatchBlock.cs
@@ -35,7 +35,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             // Finds all CommandAsts.
             IEnumerable<Ast> foundAsts = ast.FindAll(testAst => testAst is CatchClauseAst, true);
 
-            // Iterrates all CatchClauseAst and check the statements count.
+            // Iterates all CatchClauseAst and check the statements count.
             foreach (Ast foundAst in foundAsts)
             {
                 CatchClauseAst catchAst = (CatchClauseAst)foundAst;
diff --git a/Rules/AvoidPositionalParameters.cs b/Rules/AvoidPositionalParameters.cs
@@ -35,7 +35,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             // Finds all CommandAsts.
             IEnumerable<Ast> foundAsts = ast.FindAll(testAst => testAst is CommandAst, true);
 
-            // Iterrates all CommandAsts and check the command name.
+            // Iterates all CommandAsts and check the command name.
             foreach (Ast foundAst in foundAsts)
             {
                 CommandAst cmdAst = (CommandAst)foundAst;
diff --git a/Rules/AvoidShouldContinueWithoutForce.cs b/Rules/AvoidShouldContinueWithoutForce.cs
@@ -37,7 +37,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             // Finds all ParamAsts.
             IEnumerable<Ast> funcAsts = ast.FindAll(testAst => testAst is FunctionDefinitionAst, true);
 
-            // Iterrates all ParamAsts and check if there are any force.
+            // Iterates all ParamAsts and check if there are any force.
             foreach (FunctionDefinitionAst funcAst in funcAsts)
             {
                 IEnumerable<Ast> paramAsts = funcAst.FindAll(testAst => testAst is ParameterAst, true);
diff --git a/Rules/AvoidUserNameAndPasswordParams.cs b/Rules/AvoidUserNameAndPasswordParams.cs
@@ -50,7 +50,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
 
                 // Finds all ParamAsts.
                 IEnumerable<Ast> paramAsts = funcAst.FindAll(testAst => testAst is ParameterAst, true);
-                // Iterrates all ParamAsts and check if their names are on the list.
+                // Iterates all ParamAsts and check if their names are on the list.
                 foreach (ParameterAst paramAst in paramAsts)
                 {
                     var psCredentialType = paramAst.Attributes.FirstOrDefault(paramAttribute =>
diff --git a/Rules/AvoidUsingPlainTextForPassword.cs b/Rules/AvoidUsingPlainTextForPassword.cs
@@ -39,7 +39,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
 
             List<String> passwords = new List<String>() {"Password", "Passphrase", "Cred", "Credential"};
 
-            // Iterrates all ParamAsts and check if their names are on the list.
+            // Iterates all ParamAsts and check if their names are on the list.
             foreach (ParameterAst paramAst in paramAsts)
             {
                 TypeInfo paramType = (TypeInfo) paramAst.StaticType;
diff --git a/Rules/ScriptAnalyzerBuiltinRules.csproj b/Rules/ScriptAnalyzerBuiltinRules.csproj
diff --git a/Rules/UseDeclaredVarsMoreThanAssignments.cs b/Rules/UseDeclaredVarsMoreThanAssignments.cs

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic`
`25`	`25`	`public interface IScriptRule : IRule`
`26`	`26`	`{`
`27`	`27`	`/// <summary>`
`28`		`- /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the anaylsis.`
	`28`	`+ /// AnalyzeScript: Analyzes the given Ast and returns DiagnosticRecords based on the analysis.`
`29`	`29`	`/// </summary>`
`30`	`30`	`/// <param name="ast">The script's ast</param>`
`31`	`31`	`/// <param name="fileName">The name of the script file being analyzed</param>`
Original file line number	Diff line number	Diff line change
`@@ -888,7 +888,7 @@ public Dictionary<string, List<string>> CheckRuleExtension(string[] path, PathIn`
`888`	`888`	`}`
`889`	`889`	`}`
`890`	`890`
`891`		`- // Resloves relative paths.`
	`891`	`+ // Resolves relative paths.`
`892`	`892`	`try`
`893`	`893`	`{`
`894`	`894`	`for (int i = 0; i < validModPaths.Count; i++)`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ private void ProcessParameters(IEnumerable<ParameterAst> parameters)`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`/// <summary>`
`136`		`- /// Used to analyze scriptbloct, functionmemberast or functiondefinitionast`
	`136`	`+ /// Used to analyze scriptblock, functionmemberast or functiondefinitionast`
`137`	`137`	`/// </summary>`
`138`	`138`	`/// <param name="ast"></param>`
`139`	`139`	`/// <returns></returns>`
Original file line number	Diff line number	Diff line change
`@@ -552,7 +552,7 @@ internal static Block[] SetDominators(Block entry, List<Block> Blocks)`
`552`	`552`
`553`	`553`	`Block dom = block._predecessors[0];`
`554`	`554`
`555`		`- // Get first proccessed node`
	`555`	`+ // Get first processed node`
`556`	`556`	`foreach (var pred in block._predecessors)`
`557`	`557`	`{`
`558`	`558`	`if (dominators[pred.PostOrder] != null)`
`@@ -828,14 +828,14 @@ internal static Tuple<Dictionary<string, VariableAnalysisDetails>, Dictionary<st`
`828`	`828`	`}`
`829`	`829`	`}`
`830`	`830`
`831`		`- // Initialize variables in internaldictionary to undetermined`
	`831`	`+ // Initialize variables in internal dictionary to undetermined`
`832`	`832`	`foreach (var key in InternalVariablesDictionary.Keys.ToList())`
`833`	`833`	`{`
`834`	`834`	`InternalVariablesDictionary[key].Constant = Undetermined.UndeterminedConstant;`
`835`	`835`	`InternalVariablesDictionary[key].Type = typeof(Undetermined);`
`836`	`836`	`}`
`837`	`837`
`838`		`- // Initialze DefinedBlock of phi function. If it is null then that phi function is not initialized;`
	`838`	`+ // Initialize DefinedBlock of phi function. If it is null then that phi function is not initialized;`
`839`	`839`	`foreach (var block in blocks)`
`840`	`840`	`{`
`841`	`841`	`foreach (var phi in block.Phis)`
`@@ -956,7 +956,7 @@ internal static Tuple<Dictionary<string, VariableAnalysisDetails>, Dictionary<st`
`956`	`956`	`{`
`957`	`957`	`CommandExpressionAst cmeAst = assigned._rightAst as CommandExpressionAst;`
`958`	`958`	`MemberExpressionAst memAst = (cmeAst != null) ? (cmeAst.Expression as MemberExpressionAst) : null;`
`959`		`- // Don't handle the this case because this is handled in assignmenttarget`
	`959`	`+ // Don't handle the this case because this is handled in assignment target`
`960`	`960`
`961`	`961`	`if (memAst != null && memAst.Expression is VariableExpressionAst)`
`962`	`962`	`{`
`@@ -2042,7 +2042,7 @@ public object VisitNamedAttributeArgument(NamedAttributeArgumentAst namedAttribu`
`2042`	`2042`	`/// <returns></returns>`
`2043`	`2043`	`public object VisitParameter(ParameterAst parameterAst)`
`2044`	`2044`	`{`
`2045`		`- // Nothing to do now, we've already allocated parameters in the first pass looking for all variable naems.`
	`2045`	`+ // Nothing to do now, we've already allocated parameters in the first pass looking for all variable names.`
`2046`	`2046`	`System.Diagnostics.Debug.Assert(false, "Code is unreachable");`
`2047`	`2047`	`return null;`
`2048`	`2048`	`}`
`@@ -2812,7 +2812,7 @@ public object VisitBinaryExpression(BinaryExpressionAst binaryExpressionAst)`
`2812`	`2812`	`// left operand is always evaluated, visit it's expression in the current block.`
`2813`	`2813`	`binaryExpressionAst.Left.Visit(this.Decorator);`
`2814`	`2814`
`2815`		`- // The right operand is condtionally evaluated. We aren't generating any code here, just`
	`2815`	`+ // The right operand is conditionally evaluated. We aren't generating any code here, just`
`2816`	`2816`	`// modeling the flow graph, so we just visit the right operand in a new block, and have`
`2817`	`2817`	`// both the current and new blocks both flow to a post-expression block.`
`2818`	`2818`	`var targetBlock = new Block();`