Make auto wrapping in quotes depending on starting quote

erwinvanhunen · erwinvanhunen · commit 8df0658c1685 · 2024-11-15T23:31:40.000+01:00
diff --git a/src/Commands/Base/Completers/ContentTypeCompleter.cs b/src/Commands/Base/Completers/ContentTypeCompleter.cs
@@ -11,13 +11,13 @@ namespace PnP.PowerShell.Commands.Base.Completers
 {
     public sealed class ContentTypeCompleter : PnPArgumentCompleter
     {
-        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)
         {
             IEnumerable<ContentType> result = PnPConnection.Current.Context.LoadQuery(PnPConnection.Current.Context.Web.AvailableContentTypes.Include(f => f.Name));
             PnPConnection.Current.Context.ExecuteQueryRetry();
             foreach (var ct in result.Where(l => l.Name.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))
             {
-                yield return new CompletionResult($"\"{ct.Name}\"");
+                yield return new CompletionResult($"{quoteChar}{ct.Name}{quoteChar}");
             }
         }
     }
diff --git a/src/Commands/Base/Completers/FieldInternalNameCompleter.cs b/src/Commands/Base/Completers/FieldInternalNameCompleter.cs
@@ -11,13 +11,13 @@ namespace PnP.PowerShell.Commands.Base.Completers
 {
     public sealed class FieldInternalNameCompleter : PnPArgumentCompleter
     {
-        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)
         {
             IEnumerable<Field> result = PnPConnection.Current.Context.LoadQuery(PnPConnection.Current.Context.Web.AvailableFields.Include(f => f.InternalName));
             PnPConnection.Current.Context.ExecuteQueryRetry();
             foreach (var field in result.Where(l => l.InternalName.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))
             {
-                yield return new CompletionResult($"\"{field.InternalName}\"");
+                yield return new CompletionResult($"{quoteChar}{field.InternalName}{quoteChar}");
             }
         }
     }
diff --git a/src/Commands/Base/Completers/ListNameCompleter.cs b/src/Commands/Base/Completers/ListNameCompleter.cs
@@ -10,13 +10,18 @@ namespace PnP.PowerShell.Commands.Base.Completers
 {
     public sealed class ListNameCompleter : PnPArgumentCompleter
     {
-        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)
         {
             IEnumerable<List> result = PnPConnection.Current.Context.LoadQuery(PnPConnection.Current.Context.Web.Lists.Include(list => list.Title));
             PnPConnection.Current.Context.ExecuteQueryRetry();
             foreach (var list in result.Where(l => l.Title.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))
             {
-                yield return new CompletionResult($"\"{list.Title.Replace("\"","`\"")}\"");
+                var listTitle = list.Title;
+                if(quoteChar == '"')
+                {
+                   listTitle = list.Title.Replace("\"","`\"");
+                }
+                yield return new CompletionResult($"{quoteChar}{listTitle}{quoteChar}");
             }
 
         }
diff --git a/src/Commands/Base/Completers/PageCompleter.cs b/src/Commands/Base/Completers/PageCompleter.cs
@@ -16,15 +16,15 @@ namespace PnP.PowerShell.Commands.Base.Completers
 {
     public sealed class PageCompleter : PnPArgumentCompleter
     {
-        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)
         {
             List<CompletionResult> results = new List<CompletionResult>();
             wordToComplete = wordToComplete.Replace('\\', '/');
             var pages = PnPConnection.Current.PnPContext.Web.GetPages(wordToComplete.TrimStart('/'));
             foreach (var page in pages.OrderBy(p => p.Name))
             {
                 var result = string.IsNullOrEmpty(page.Folder) ? page.Name : page.Folder + "/" + page.Name;
-                results.Add(new CompletionResult($"\"{result}\""));
+                results.Add(new CompletionResult($"{quoteChar}{result}{quoteChar}"));
             }
             return results;
         }
diff --git a/src/Commands/Base/Completers/PnPArgumentCompleter.cs b/src/Commands/Base/Completers/PnPArgumentCompleter.cs
@@ -12,12 +12,17 @@ public abstract class PnPArgumentCompleter : IArgumentCompleter
     private const int Timeout = 2000;
     public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
     {
+        var quoteChar = '"';
+        if(wordToComplete.StartsWith('\''))
+        {
+            quoteChar = '\'';
+        }
         wordToComplete = wordToComplete.Trim(['"', '\'']);
-        var task = Task.Run(() => GetArguments(commandName, parameterName, wordToComplete, commandAst, fakeBoundParameters));
+        var task = Task.Run(() => GetArguments(commandName, parameterName, wordToComplete, commandAst, fakeBoundParameters, quoteChar));
         return task.TimeoutAfter(TimeSpan.FromMilliseconds(GetTimeOut())).GetAwaiter().GetResult();
     }
 
-    public abstract IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters);
+    public abstract IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar);
 
     private Int32 GetTimeOut()
     {
diff --git a/src/Commands/Base/Completers/PropertyBagKeyCompleter.cs b/src/Commands/Base/Completers/PropertyBagKeyCompleter.cs
@@ -10,9 +10,9 @@
 
 namespace PnP.PowerShell.Commands.Base.Completers
 {
-    public sealed class PropertyBagKeyCompleter : IArgumentCompleter
+    public sealed class PropertyBagKeyCompleter : PnPArgumentCompleter
     {
-        public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)
         {
             IEnumerable<string> keys = null;
             if (fakeBoundParameters["Folder"] == null)
@@ -36,7 +36,7 @@ public IEnumerable<CompletionResult> CompleteArgument(string commandName, string
 
             foreach (var key in keys.Where(k => k.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))
             {
-                yield return new CompletionResult($"\"{key}\"");
+                yield return new CompletionResult($"{quoteChar}{key}{quoteChar}");
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,13 @@ namespace PnP.PowerShell.Commands.Base.Completers`
`11`	`11`	`{`
`12`	`12`	`public sealed class ContentTypeCompleter : PnPArgumentCompleter`
`13`	`13`	`{`
`14`		`- public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)`
	`14`	`+ public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)`
`15`	`15`	`{`
`16`	`16`	`IEnumerable<ContentType> result = PnPConnection.Current.Context.LoadQuery(PnPConnection.Current.Context.Web.AvailableContentTypes.Include(f => f.Name));`
`17`	`17`	`PnPConnection.Current.Context.ExecuteQueryRetry();`
`18`	`18`	`foreach (var ct in result.Where(l => l.Name.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))`
`19`	`19`	`{`
`20`		`- yield return new CompletionResult($"\"{ct.Name}\"");`
	`20`	`+ yield return new CompletionResult($"{quoteChar}{ct.Name}{quoteChar}");`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,18 @@ namespace PnP.PowerShell.Commands.Base.Completers`
`10`	`10`	`{`
`11`	`11`	`public sealed class ListNameCompleter : PnPArgumentCompleter`
`12`	`12`	`{`
`13`		`- public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)`
	`13`	`+ public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)`
`14`	`14`	`{`
`15`	`15`	`IEnumerable<List> result = PnPConnection.Current.Context.LoadQuery(PnPConnection.Current.Context.Web.Lists.Include(list => list.Title));`
`16`	`16`	`PnPConnection.Current.Context.ExecuteQueryRetry();`
`17`	`17`	`foreach (var list in result.Where(l => l.Title.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))`
`18`	`18`	`{`
`19`		- yield return new CompletionResult($"\"{list.Title.Replace("\"","`\"")}\"");
	`19`	`+ var listTitle = list.Title;`
	`20`	`+ if(quoteChar == '"')`
	`21`	`+ {`
	`22`	+ listTitle = list.Title.Replace("\"","`\"");
	`23`	`+ }`
	`24`	`+ yield return new CompletionResult($"{quoteChar}{listTitle}{quoteChar}");`
`20`	`25`	`}`
`21`	`26`
`22`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,15 +16,15 @@ namespace PnP.PowerShell.Commands.Base.Completers`
`16`	`16`	`{`
`17`	`17`	`public sealed class PageCompleter : PnPArgumentCompleter`
`18`	`18`	`{`
`19`		`- public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)`
	`19`	`+ public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)`
`20`	`20`	`{`
`21`	`21`	`List<CompletionResult> results = new List<CompletionResult>();`
`22`	`22`	`wordToComplete = wordToComplete.Replace('\\', '/');`
`23`	`23`	`var pages = PnPConnection.Current.PnPContext.Web.GetPages(wordToComplete.TrimStart('/'));`
`24`	`24`	`foreach (var page in pages.OrderBy(p => p.Name))`
`25`	`25`	`{`
`26`	`26`	`var result = string.IsNullOrEmpty(page.Folder) ? page.Name : page.Folder + "/" + page.Name;`
`27`		`- results.Add(new CompletionResult($"\"{result}\""));`
	`27`	`+ results.Add(new CompletionResult($"{quoteChar}{result}{quoteChar}"));`
`28`	`28`	`}`
`29`	`29`	`return results;`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,12 +12,17 @@ public abstract class PnPArgumentCompleter : IArgumentCompleter`
`12`	`12`	`private const int Timeout = 2000;`
`13`	`13`	`public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)`
`14`	`14`	`{`
	`15`	`+ var quoteChar = '"';`
	`16`	`+ if(wordToComplete.StartsWith('\''))`
	`17`	`+ {`
	`18`	`+ quoteChar = '\'';`
	`19`	`+ }`
`15`	`20`	`wordToComplete = wordToComplete.Trim(['"', '\'']);`
`16`		`- var task = Task.Run(() => GetArguments(commandName, parameterName, wordToComplete, commandAst, fakeBoundParameters));`
	`21`	`+ var task = Task.Run(() => GetArguments(commandName, parameterName, wordToComplete, commandAst, fakeBoundParameters, quoteChar));`
`17`	`22`	`return task.TimeoutAfter(TimeSpan.FromMilliseconds(GetTimeOut())).GetAwaiter().GetResult();`
`18`	`23`	`}`
`19`	`24`
`20`		`- public abstract IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters);`
	`25`	`+ public abstract IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar);`
`21`	`26`
`22`	`27`	`private Int32 GetTimeOut()`
`23`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,9 @@`
`10`	`10`
`11`	`11`	`namespace PnP.PowerShell.Commands.Base.Completers`
`12`	`12`	`{`
`13`		`- public sealed class PropertyBagKeyCompleter : IArgumentCompleter`
	`13`	`+ public sealed class PropertyBagKeyCompleter : PnPArgumentCompleter`
`14`	`14`	`{`
`15`		`- public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)`
	`15`	`+ public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters, char quoteChar)`
`16`	`16`	`{`
`17`	`17`	`IEnumerable<string> keys = null;`
`18`	`18`	`if (fakeBoundParameters["Folder"] == null)`
`@@ -36,7 +36,7 @@ public IEnumerable<CompletionResult> CompleteArgument(string commandName, string`
`36`	`36`
`37`	`37`	`foreach (var key in keys.Where(k => k.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))`
`38`	`38`	`{`
`39`		`- yield return new CompletionResult($"\"{key}\"");`
	`39`	`+ yield return new CompletionResult($"{quoteChar}{key}{quoteChar}");`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`	`}`