Rename 'PredictionColor' to 'InlinePredictionColor' (#1860)

Author: daxian-dbw

PSReadLine/Cmdlets.cs

@@ -87,7 +87,7 @@ public class PSConsoleReadLineOptions
 
         // Use dark black by default for the suggestion text.
         // Find the most suitable color using https://stackoverflow.com/a/33206814
-        public const string DefaultPredictionColor = "\x1b[38;5;238m";
+        public const string DefaultInlinePredictionColor = "\x1b[38;5;238m";
 
         public static EditMode DefaultEditMode = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
             ? EditMode.Windows
@@ -451,10 +451,10 @@ public object SelectionColor
             set => _selectionColor = VTColorUtils.AsEscapeSequence(value);
         }
 
-        public object PredictionColor
+        public object InlinePredictionColor
         {
-            get => _predictionColor;
-            set => _predictionColor = VTColorUtils.AsEscapeSequence(value);
+            get => _inlinePredictionColor;
+            set => _inlinePredictionColor = VTColorUtils.AsEscapeSequence(value);
         }
 
         internal string _defaultTokenColor;
@@ -471,7 +471,7 @@ public object PredictionColor
         internal string _emphasisColor;
         internal string _errorColor;
         internal string _selectionColor;
-        internal string _predictionColor;
+        internal string _inlinePredictionColor;
 
         internal void ResetColors()
         {
@@ -489,7 +489,7 @@ internal void ResetColors()
             MemberColor       = DefaultNumberColor;
             EmphasisColor     = DefaultEmphasisColor;
             ErrorColor        = DefaultErrorColor;
-            PredictionColor   = DefaultPredictionColor;
+            InlinePredictionColor = DefaultInlinePredictionColor;
 
             var bg = Console.BackgroundColor;
             if (fg == VTColorUtils.UnknownColor || bg == VTColorUtils.UnknownColor)
@@ -526,7 +526,7 @@ internal void SetColor(string property, object value)
                         {"Number", (o, v) => o.NumberColor = v},
                         {"Member", (o, v) => o.MemberColor = v},
                         {"Selection", (o, v) => o.SelectionColor = v},
-                        {"Prediction", (o, v) => o.PredictionColor = v},
+                        {"InlinePrediction", (o, v) => o.InlinePredictionColor = v},
                     };
 
                 Interlocked.CompareExchange(ref ColorSetters, setters, null);

PSReadLine/PSReadLine.format.ps1xml

@@ -206,8 +206,8 @@ $d = [Microsoft.PowerShell.KeyHandler]::GetGroupingDescription($_.Group)
                 <ScriptBlock>[Microsoft.PowerShell.VTColorUtils]::FormatColor($_.ParameterColor)</ScriptBlock>
               </ListItem>
               <ListItem>
-                <Label>PredictionColor</Label>
-                <ScriptBlock>[Microsoft.PowerShell.VTColorUtils]::FormatColor($_.PredictionColor)</ScriptBlock>
+                <Label>InlinePredictionColor</Label>
+                <ScriptBlock>[Microsoft.PowerShell.VTColorUtils]::FormatColor($_.InlinePredictionColor)</ScriptBlock>
               </ListItem>
               <ListItem>
                 <Label>SelectionColor</Label>

PSReadLine/Render.cs

@@ -340,7 +340,7 @@ void RenderOneChar(char charToRender, bool toEmphasize)
 
             if (suggestion != null)
             {
-                color = _options._predictionColor;
+                color = _options._inlinePredictionColor;
                 foreach (char charToRender in suggestion)
                 {
                     RenderOneChar(charToRender, toEmphasize: false);

test/SuggestionTest.cs

@@ -240,7 +240,7 @@ public void SetPredictionColor()
             TestSetup(KeyMode.Cmd);
             var predictionColor = MakeCombinedColor(ConsoleColor.DarkYellow, ConsoleColor.Yellow);
             var predictionColorToCheck = Tuple.Create(ConsoleColor.DarkYellow, ConsoleColor.Yellow);
-            PSConsoleReadLine.SetOptions(new SetPSReadLineOption {Colors = new Hashtable(){{"Prediction", predictionColor}}});
+            PSConsoleReadLine.SetOptions(new SetPSReadLineOption {Colors = new Hashtable(){{"InlinePrediction", predictionColor}}});
 
             SetHistory("echo -bar", "eca -zoo");
             Test("ech", Keys(

test/UnitTestReadLine.cs

@@ -509,7 +509,7 @@ private void TestSetup(KeyMode keyMode, params KeyHandler[] keyHandlers)
             var tokenTypes = new[]
             {
                 "Default", "Comment", "Keyword", "String", "Operator", "Variable",
-                "Command", "Parameter", "Type", "Number", "Member", "Selection", "Prediction"
+                "Command", "Parameter", "Type", "Number", "Member", "Selection", "InlinePrediction"
             };
             var colors = new Hashtable();
             for (var i = 0; i < tokenTypes.Length; i++)