Treat CancellationToken parameter not last as error (and fix)

Author: andyleejordan

.editorconfig

@@ -23,6 +23,8 @@ dotnet_diagnostic.CS0219.severity = error
 dotnet_diagnostic.CS0414.severity = error
 # CA2007: Do not directly await a Task
 dotnet_diagnostic.CA2007.severity = error
+# CA1068: CancellationToken parameters must come last
+dotnet_diagnostic.CA1068.severity = error
 # CA1822: Mark members as static
 dotnet_diagnostic.CA1822.severity = error
 # CA1823: Avoid unused private fields

src/PowerShellEditorServices/Services/PowerShellContext/PowerShellContextService.cs

@@ -485,7 +485,7 @@ private void CleanupRunspace(RunspaceDetails runspaceDetails)
         /// <returns>A RunspaceHandle instance that gives access to the session's runspace.</returns>
         public Task<RunspaceHandle> GetRunspaceHandleAsync()
         {
-            return this.GetRunspaceHandleImplAsync(CancellationToken.None, isReadLine: false);
+            return this.GetRunspaceHandleImplAsync(isReadLine: false, CancellationToken.None);
         }
 
         /// <summary>
@@ -497,7 +497,7 @@ public Task<RunspaceHandle> GetRunspaceHandleAsync()
         /// <returns>A RunspaceHandle instance that gives access to the session's runspace.</returns>
         public Task<RunspaceHandle> GetRunspaceHandleAsync(CancellationToken cancellationToken)
         {
-            return this.GetRunspaceHandleImplAsync(cancellationToken, isReadLine: false);
+            return this.GetRunspaceHandleImplAsync(isReadLine: false, cancellationToken);
         }
 
         /// <summary>
@@ -1415,12 +1415,12 @@ public void Close()
 
         private Task<RunspaceHandle> GetRunspaceHandleAsync(bool isReadLine)
         {
-            return this.GetRunspaceHandleImplAsync(CancellationToken.None, isReadLine);
+            return this.GetRunspaceHandleImplAsync(isReadLine, CancellationToken.None);
         }
 
-        private Task<RunspaceHandle> GetRunspaceHandleImplAsync(CancellationToken cancellationToken, bool isReadLine)
+        private Task<RunspaceHandle> GetRunspaceHandleImplAsync(bool isReadLine, CancellationToken cancellationToken)
         {
-            return this.PromptNest.GetRunspaceHandleAsync(cancellationToken, isReadLine);
+            return this.PromptNest.GetRunspaceHandleAsync(isReadLine, cancellationToken);
         }
 
         private ExecutionTarget GetExecutionTarget(ExecutionOptions options = null)

src/PowerShellEditorServices/Services/PowerShellContext/Session/InvocationEventQueue.cs

@@ -113,7 +113,7 @@ internal async Task InvokeOnPipelineThreadAsync(Action<PowerShell> invocationAct
         {
             var request = new InvocationRequest(pwsh =>
             {
-                using (_promptNest.GetRunspaceHandle(CancellationToken.None, isReadLine: false))
+                using (_promptNest.GetRunspaceHandle(isReadLine: false, CancellationToken.None))
                 {
                     pwsh.Runspace = _runspace;
                     invocationAction(pwsh);

src/PowerShellEditorServices/Services/PowerShellContext/Session/PSReadLinePromptContext.cs

@@ -177,12 +177,12 @@ public async Task AbortReadLineAsync() {
 
         public void WaitForReadLineExit()
         {
-            using (_promptNest.GetRunspaceHandle(CancellationToken.None, isReadLine: true))
+            using (_promptNest.GetRunspaceHandle(isReadLine: true, CancellationToken.None))
             { }
         }
 
         public async Task WaitForReadLineExitAsync() {
-            using (await _promptNest.GetRunspaceHandleAsync(CancellationToken.None, isReadLine: true).ConfigureAwait(false))
+            using (await _promptNest.GetRunspaceHandleAsync(isReadLine: true, CancellationToken.None).ConfigureAwait(false))
             { }
         }
 

src/PowerShellEditorServices/Services/PowerShellContext/Session/PromptNest.cs

@@ -253,7 +253,7 @@ internal PowerShell GetPowerShell(bool isReadLine = false)
         /// </param>
         /// <param name="isReadLine">Indicates whether this is for a PSReadLine command.</param>
         /// <returns>The <see cref="RunspaceHandle" /> for the current frame.</returns>
-        internal RunspaceHandle GetRunspaceHandle(CancellationToken cancellationToken, bool isReadLine)
+        internal RunspaceHandle GetRunspaceHandle(bool isReadLine, CancellationToken cancellationToken)
         {
             if (_isDisposed)
             {
@@ -264,10 +264,10 @@ internal RunspaceHandle GetRunspaceHandle(CancellationToken cancellationToken, b
             // is in process.
             if (isReadLine && !_powerShellContext.IsCurrentRunspaceOutOfProcess())
             {
-                GetRunspaceHandleImpl(cancellationToken, isReadLine: false);
+                GetRunspaceHandleImpl(isReadLine: false, cancellationToken);
             }
 
-            return GetRunspaceHandleImpl(cancellationToken, isReadLine);
+            return GetRunspaceHandleImpl(isReadLine, cancellationToken);
         }
 
 
@@ -284,7 +284,7 @@ internal RunspaceHandle GetRunspaceHandle(CancellationToken cancellationToken, b
         /// The <see cref="Task{RunspaceHandle}.Result" /> property will return the
         /// <see cref="RunspaceHandle" /> for the current frame.
         /// </returns>
-        internal async Task<RunspaceHandle> GetRunspaceHandleAsync(CancellationToken cancellationToken, bool isReadLine)
+        internal async Task<RunspaceHandle> GetRunspaceHandleAsync(bool isReadLine, CancellationToken cancellationToken)
         {
             if (_isDisposed)
             {
@@ -295,10 +295,10 @@ internal async Task<RunspaceHandle> GetRunspaceHandleAsync(CancellationToken can
             // is in process.
             if (isReadLine && !_powerShellContext.IsCurrentRunspaceOutOfProcess())
             {
-                await GetRunspaceHandleImplAsync(cancellationToken, isReadLine: false).ConfigureAwait(false);
+                await GetRunspaceHandleImplAsync(isReadLine: false, cancellationToken).ConfigureAwait(false);
             }
 
-            return await GetRunspaceHandleImplAsync(cancellationToken, isReadLine).ConfigureAwait(false);
+            return await GetRunspaceHandleImplAsync(isReadLine, cancellationToken).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -517,7 +517,7 @@ private AsyncQueue<RunspaceHandle> NewHandleQueue()
             return queue;
         }
 
-        private RunspaceHandle GetRunspaceHandleImpl(CancellationToken cancellationToken, bool isReadLine)
+        private RunspaceHandle GetRunspaceHandleImpl(bool isReadLine, CancellationToken cancellationToken)
         {
             if (isReadLine)
             {
@@ -527,7 +527,7 @@ private RunspaceHandle GetRunspaceHandleImpl(CancellationToken cancellationToken
             return CurrentFrame.Queue.Dequeue(cancellationToken);
         }
 
-        private async Task<RunspaceHandle> GetRunspaceHandleImplAsync(CancellationToken cancellationToken, bool isReadLine)
+        private async Task<RunspaceHandle> GetRunspaceHandleImplAsync(bool isReadLine, CancellationToken cancellationToken)
         {
             if (isReadLine)
             {