Fix/suppress various FxCop errors

Author: lzybkr

PSReadLine/BasicEditing.cs

@@ -3,9 +3,12 @@
 --********************************************************************/
 
 using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using System.Linq;
 using System.Management.Automation;
 using System.Management.Automation.Language;
+using System.Management.Automation.Runspaces;
 
 namespace Microsoft.PowerShell
 {
@@ -14,6 +17,7 @@ public partial class PSConsoleReadLine
         /// <summary>
         /// Insert the key
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void SelfInsert(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (!key.HasValue)
@@ -59,6 +63,7 @@ public static void SelfInsert(ConsoleKeyInfo? key = null, object arg = null)
         /// <summary>
         /// Reverts all of the input to the current input.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void RevertLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton._statusIsErrorMessage)
@@ -79,6 +84,7 @@ public static void RevertLine(ConsoleKeyInfo? key = null, object arg = null)
         /// Cancel the current input, leaving the input on the screen,
         /// but returns back to the host so the prompt is evaluated again.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void CancelLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.ClearStatusMessage(false);
@@ -113,6 +119,7 @@ public static void CancelLine(ConsoleKeyInfo? key = null, object arg = null)
         /// Like ForwardKillLine - deletes text from the point to the end of the line,
         /// but does not put the deleted text in the kill ring.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void ForwardDeleteLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             var current = _singleton._current;
@@ -131,6 +138,7 @@ public static void ForwardDeleteLine(ConsoleKeyInfo? key = null, object arg = nu
         /// Like BackwardKillLine - deletes text from the point to the start of the line,
         /// but does not put the deleted text in the kill ring.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void BackwardDeleteLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton._current > 0)
@@ -146,6 +154,7 @@ public static void BackwardDeleteLine(ConsoleKeyInfo? key = null, object arg = n
         /// <summary>
         /// Delete the character before the cursor.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void BackwardDeleteChar(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton._visualSelectionCommandCount > 0)
@@ -195,6 +204,7 @@ private void DeleteCharImpl(bool orExit)
         /// <summary>
         /// Delete the character under the cursor.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void DeleteChar(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.DeleteCharImpl(orExit: false);
@@ -203,6 +213,7 @@ public static void DeleteChar(ConsoleKeyInfo? key = null, object arg = null)
         /// <summary>
         /// Delete the character under the cursor, or if the line is empty, exit the process
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void DeleteCharOrExit(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.DeleteCharImpl(orExit: true);
@@ -284,7 +295,7 @@ public override AstVisitAction VisitCommand(CommandAst commandAst)
                         if (commandInfo == null && !_singleton.UnresolvedCommandCouldSucceed(commandName, _rootAst))
                         {
                             _singleton._current = commandAst.CommandElements[0].Extent.EndOffset;
-                            detectedError = string.Format(PSReadLineResources.CommandNotFoundError, commandName);
+                            detectedError = string.Format(CultureInfo.CurrentCulture, PSReadLineResources.CommandNotFoundError, commandName);
                             return AstVisitAction.StopVisit;
                         }
                     }
@@ -419,6 +430,7 @@ static bool StaticParameterBindingSupported(CommandInfo commandInfo)
         /// continuation prompt is displayed on the next line and PSReadline waits for
         /// keys to edit the current input.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void AcceptLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.AcceptLineImpl(false);
@@ -430,6 +442,7 @@ public static void AcceptLine(ConsoleKeyInfo? key = null, object arg = null)
         /// continuation prompt is displayed on the next line and PSReadline waits for
         /// keys to edit the current input.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void ValidateAndAcceptLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.AcceptLineImpl(true);
@@ -439,6 +452,7 @@ public static void ValidateAndAcceptLine(ConsoleKeyInfo? key = null, object arg
         /// Attempt to execute the current input.  If it can be executed (like AcceptLine),
         /// then recall the next item from history the next time Readline is called.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void AcceptAndGetNext(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton.AcceptLineImpl(false))
@@ -459,6 +473,7 @@ public static void AcceptAndGetNext(ConsoleKeyInfo? key = null, object arg = nul
         /// keys to edit the current input.  This is useful to enter multi-line input as
         /// a single command even when a single line is complete input by itself.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void AddLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             Insert('\n');

PSReadLine/Cmdlets.cs

@@ -13,6 +13,9 @@
 
 namespace Microsoft.PowerShell
 {
+
+#pragma warning disable 1591
+
     public enum TokenClassification
     {
         None,
@@ -193,6 +196,7 @@ public PSConsoleReadlineOptions(string hostName)
         /// odd things with script blocks, we create a white-list of commands
         /// that do invoke the script block - this covers the most useful cases.
         /// </summary>
+        [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
         public HashSet<string> CommandsToValidateScriptBlockArguments { get; set; }
 
         /// <summary>
@@ -571,6 +575,7 @@ public class SetPSReadlineKeyHandlerCommand : PSCmdlet, IDynamicParameters
         [Parameter(Position = 0, Mandatory = true)]
         [Alias("Key")]
         [ValidateNotNullOrEmpty]
+        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         public string[] Chord { get; set; }
 
         [Parameter(Position = 1, Mandatory = true, ParameterSetName = "ScriptBlock")]
@@ -692,6 +697,7 @@ public class RemoveKeyHandlerCommand : PSCmdlet
         [Parameter(Position = 0, Mandatory = true)]
         [Alias("Key")]
         [ValidateNotNullOrEmpty]
+        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         public string[] Chord { get; set; }
 
         [ExcludeFromCodeCoverage]
@@ -700,4 +706,7 @@ protected override void EndProcessing()
             PSConsoleReadLine.RemoveKeyHandler(Chord);
         }
     }
+
+#pragma warning restore 1591
+
 }

PSReadLine/Completion.cs

@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using System.Linq;
 using System.Management.Automation;
 using System.Management.Automation.Runspaces;
@@ -34,6 +35,7 @@ CommandCompletion IPSConsoleReadLineMockableMethods.CompleteInput(string input,
         /// Attempt to complete the text surrounding the cursor with the next
         /// available completion.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void TabCompleteNext(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.Complete(forward: true);
@@ -43,6 +45,7 @@ public static void TabCompleteNext(ConsoleKeyInfo? key = null, object arg = null
         /// Attempt to complete the text surrounding the cursor with the previous
         /// available completion.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void TabCompletePrevious(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.Complete(forward: false);
@@ -87,6 +90,7 @@ private static string GetUnquotedText(string s, bool consistentQuoting)
         /// prefix is used for completion.  If trying to complete the longest
         /// unambiguous completion, a list of possible completions is displayed.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void Complete(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.CompleteImpl(key, arg, false);
@@ -98,11 +102,13 @@ public static void Complete(ConsoleKeyInfo? key = null, object arg = null)
         /// prefix is used for completion.  If trying to complete the longest
         /// unambiguous completion, a list of possible completions is displayed.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void MenuComplete(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.CompleteImpl(key, arg, true);
         }
 
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         private void CompleteImpl(ConsoleKeyInfo? key, object arg, bool menuSelect)
         {
             var completions = GetCompletions();
@@ -267,13 +273,13 @@ private void DoReplacementForCompletion(CompletionResult completionResult, Comma
 
         private static string GetReplacementTextForDirectory(string replacementText, ref int cursorAdjustment)
         {
-            if (!replacementText.EndsWith("\\"))
+            if (!replacementText.EndsWith("\\", StringComparison.Ordinal))
             {
-                if (replacementText.EndsWith("\\'") || replacementText.EndsWith("\\\""))
+                if (replacementText.EndsWith("\\'", StringComparison.Ordinal) || replacementText.EndsWith("\\\"", StringComparison.Ordinal))
                 {
                     cursorAdjustment = -1;
                 }
-                else if (replacementText.EndsWith("'") || replacementText.EndsWith("\""))
+                else if (replacementText.EndsWith("'", StringComparison.Ordinal) || replacementText.EndsWith("\"", StringComparison.Ordinal))
                 {
                     var len = replacementText.Length;
                     replacementText = replacementText.Substring(0, len - 1) + '\\' + replacementText[len - 1];
@@ -303,6 +309,7 @@ private static void InvertSelectedCompletion(CHAR_INFO[] buffer, int selectedIte
         /// <summary>
         /// Display the list of possible completions.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void PossibleCompletions(ConsoleKeyInfo? key = null, object arg = null)
         {
             var completions = _singleton.GetCompletions();
@@ -330,7 +337,7 @@ private void PossibleCompletionsImpl(CommandCompletion completions, bool menuSel
 
             if (completions.CompletionMatches.Count >= _options.CompletionQueryItems)
             {
-                if (!PromptYesOrNo(string.Format(PSReadLineResources.DisplayAllPossibilities, completions.CompletionMatches.Count)))
+                if (!PromptYesOrNo(string.Format(CultureInfo.CurrentCulture, PSReadLineResources.DisplayAllPossibilities, completions.CompletionMatches.Count)))
                 {
                     return;
                 }

PSReadLine/ConsoleKeyChordConverter.cs

@@ -4,11 +4,15 @@
 
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using System.Runtime.InteropServices;
 
 namespace Microsoft.PowerShell
 {
+    /// <summary>
+    /// A helper class for converting strings to ConsoleKey chords.
+    /// </summary>
     public static class ConsoleKeyChordConverter
     {
         /// <summary>
@@ -31,7 +35,7 @@ public static ConsoleKeyInfo[] Convert(string chord)
 
             if (tokens.Length > 2)
             {
-                throw new ArgumentException("Chord can have at most two keys");
+                throw new ArgumentException(PSReadLineResources.ChordWIthTooManyKeys);
             }
 
             var result = new ConsoleKeyInfo[tokens.Length];
@@ -85,8 +89,7 @@ private static ConsoleKeyInfo ConvertOneSequence(string sequence)
                         }
                         else
                         {
-                            throw new ArgumentException("Unrecognized key '" + token + "'. Please use a character literal or a " +
-                                "well-known key name from the System.ConsoleKey enumeration.");
+                            throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, PSReadLineResources.UnrecognizedKey, token));
                         }
                     }
                     // try simple parse for ConsoleKey enum name
@@ -100,15 +103,13 @@ private static ConsoleKeyInfo ConvertOneSequence(string sequence)
 
                         if (!valid)
                         {
-                            throw new ArgumentException(String.Format("Unable to translate '{0}' to " +
-                                "virtual key code: {1}.", token[0], failReason));
+                            throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, PSReadLineResources.CantTranslateKey, token[0], failReason));
                         }
                     }
 
                     if (!valid)
                     {
-                        throw new ArgumentException("Unrecognized key '" + token + "'. Please use a character literal or a " +
-                            "well-known key name from the System.ConsoleKey enumeration.");
+                        throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, PSReadLineResources.UnrecognizedKey, token));
                     }
                 }
                 else
@@ -130,21 +131,20 @@ private static ConsoleKeyInfo ConvertOneSequence(string sequence)
                             // either found duplicate modifier token or shift state
                             // was already implied from char, e.g. char is "}", which is "shift+]"
                             throw new ArgumentException(
-                                String.Format("Duplicate or invalid modifier token '{0}' for key '{1}'.", modifier, key));
+                                String.Format(CultureInfo.CurrentCulture, PSReadLineResources.InvalidModifier, modifier, key));
                         }
                         modifiers |= modifier;
                     }
                     else
                     {
-                        throw new ArgumentException("Invalid modifier token '" + token + "'. The supported modifiers are " +
-                            "'alt', 'shift', 'control' or 'ctrl'.");
+                        throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, PSReadLineResources.InvalidModifier, token));
                     }
                 }
             }
 
             if (!valid)
             {
-                throw new ArgumentException("Invalid sequence '" + sequence + "'.");
+                throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, PSReadLineResources.InvalidSequence, sequence));
             }
 
             char keyChar = GetCharFromConsoleKey(key, modifiers);
@@ -161,6 +161,7 @@ private static bool TryParseCharLiteral(char literal, ref ConsoleModifiers modif
 
             // shift state will be in MSB
             short virtualKey = NativeMethods.VkKeyScan(literal);
+            int hresult = Marshal.GetLastWin32Error();
 
             if (virtualKey != 0)
             {
@@ -192,13 +193,11 @@ private static bool TryParseCharLiteral(char literal, ref ConsoleModifiers modif
                 else
                 {
                     // haven't seen this happen yet, but possible
-                    failReason = String.Format("The virtual key code {0} does not map " +
-                        "to a known System.ConsoleKey enumerated value.", virtualKey);
+                    failReason = String.Format(CultureInfo.CurrentCulture, PSReadLineResources.UnrecognizedKey, virtualKey);
                 }                
             }
             else
             {
-                int hresult = Marshal.GetLastWin32Error();
                 Exception e = Marshal.GetExceptionForHR(hresult);
                 failReason = e.Message;
             }