Treat CancellationToken parameter not last as error (and fix)

andyleejordan · andyleejordan · commit d36d9e0a82aa · 2021-08-03T12:16:59.000-07:00
diff --git a/.editorconfig b/.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
diff --git a/src/PowerShellEditorServices/Services/PowerShellContext/PowerShellContextService.cs b/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)
diff --git a/src/PowerShellEditorServices/Services/PowerShellContext/Session/InvocationEventQueue.cs b/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);
diff --git a/src/PowerShellEditorServices/Services/PowerShellContext/Session/PSReadLinePromptContext.cs b/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))
             { }
         }
 
diff --git a/src/PowerShellEditorServices/Services/PowerShellContext/Session/PromptNest.cs b/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)
             {

Original file line number	Diff line number	Diff line change
`@@ -485,7 +485,7 @@ private void CleanupRunspace(RunspaceDetails runspaceDetails)`
`485`	`485`	`/// <returns>A RunspaceHandle instance that gives access to the session's runspace.</returns>`
`486`	`486`	`public Task<RunspaceHandle> GetRunspaceHandleAsync()`
`487`	`487`	`{`
`488`		`- return this.GetRunspaceHandleImplAsync(CancellationToken.None, isReadLine: false);`
	`488`	`+ return this.GetRunspaceHandleImplAsync(isReadLine: false, CancellationToken.None);`
`489`	`489`	`}`
`490`	`490`
`491`	`491`	`/// <summary>`
`@@ -497,7 +497,7 @@ public Task<RunspaceHandle> GetRunspaceHandleAsync()`
`497`	`497`	`/// <returns>A RunspaceHandle instance that gives access to the session's runspace.</returns>`
`498`	`498`	`public Task<RunspaceHandle> GetRunspaceHandleAsync(CancellationToken cancellationToken)`
`499`	`499`	`{`
`500`		`- return this.GetRunspaceHandleImplAsync(cancellationToken, isReadLine: false);`
	`500`	`+ return this.GetRunspaceHandleImplAsync(isReadLine: false, cancellationToken);`
`501`	`501`	`}`
`502`	`502`
`503`	`503`	`/// <summary>`
`@@ -1415,12 +1415,12 @@ public void Close()`
`1415`	`1415`
`1416`	`1416`	`private Task<RunspaceHandle> GetRunspaceHandleAsync(bool isReadLine)`
`1417`	`1417`	`{`
`1418`		`- return this.GetRunspaceHandleImplAsync(CancellationToken.None, isReadLine);`
	`1418`	`+ return this.GetRunspaceHandleImplAsync(isReadLine, CancellationToken.None);`
`1419`	`1419`	`}`
`1420`	`1420`
`1421`		`- private Task<RunspaceHandle> GetRunspaceHandleImplAsync(CancellationToken cancellationToken, bool isReadLine)`
	`1421`	`+ private Task<RunspaceHandle> GetRunspaceHandleImplAsync(bool isReadLine, CancellationToken cancellationToken)`
`1422`	`1422`	`{`
`1423`		`- return this.PromptNest.GetRunspaceHandleAsync(cancellationToken, isReadLine);`
	`1423`	`+ return this.PromptNest.GetRunspaceHandleAsync(isReadLine, cancellationToken);`
`1424`	`1424`	`}`
`1425`	`1425`
`1426`	`1426`	`private ExecutionTarget GetExecutionTarget(ExecutionOptions options = null)`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ internal async Task InvokeOnPipelineThreadAsync(Action<PowerShell> invocationAct`
`113`	`113`	`{`
`114`	`114`	`var request = new InvocationRequest(pwsh =>`
`115`	`115`	`{`
`116`		`- using (_promptNest.GetRunspaceHandle(CancellationToken.None, isReadLine: false))`
	`116`	`+ using (_promptNest.GetRunspaceHandle(isReadLine: false, CancellationToken.None))`
`117`	`117`	`{`
`118`	`118`	`pwsh.Runspace = _runspace;`
`119`	`119`	`invocationAction(pwsh);`
Original file line number	Diff line number	Diff line change
`@@ -177,12 +177,12 @@ public async Task AbortReadLineAsync() {`
`177`	`177`
`178`	`178`	`public void WaitForReadLineExit()`
`179`	`179`	`{`
`180`		`- using (_promptNest.GetRunspaceHandle(CancellationToken.None, isReadLine: true))`
	`180`	`+ using (_promptNest.GetRunspaceHandle(isReadLine: true, CancellationToken.None))`
`181`	`181`	`{ }`
`182`	`182`	`}`
`183`	`183`
`184`	`184`	`public async Task WaitForReadLineExitAsync() {`
`185`		`- using (await _promptNest.GetRunspaceHandleAsync(CancellationToken.None, isReadLine: true).ConfigureAwait(false))`
	`185`	`+ using (await _promptNest.GetRunspaceHandleAsync(isReadLine: true, CancellationToken.None).ConfigureAwait(false))`
`186`	`186`	`{ }`
`187`	`187`	`}`
`188`	`188`
Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,7 @@ internal PowerShell GetPowerShell(bool isReadLine = false)`
`253`	`253`	`/// </param>`
`254`	`254`	`/// <param name="isReadLine">Indicates whether this is for a PSReadLine command.</param>`
`255`	`255`	`/// <returns>The <see cref="RunspaceHandle" /> for the current frame.</returns>`
`256`		`- internal RunspaceHandle GetRunspaceHandle(CancellationToken cancellationToken, bool isReadLine)`
	`256`	`+ internal RunspaceHandle GetRunspaceHandle(bool isReadLine, CancellationToken cancellationToken)`
`257`	`257`	`{`
`258`	`258`	`if (_isDisposed)`
`259`	`259`	`{`
`@@ -264,10 +264,10 @@ internal RunspaceHandle GetRunspaceHandle(CancellationToken cancellationToken, b`
`264`	`264`	`// is in process.`
`265`	`265`	`if (isReadLine && !_powerShellContext.IsCurrentRunspaceOutOfProcess())`
`266`	`266`	`{`
`267`		`- GetRunspaceHandleImpl(cancellationToken, isReadLine: false);`
	`267`	`+ GetRunspaceHandleImpl(isReadLine: false, cancellationToken);`
`268`	`268`	`}`
`269`	`269`
`270`		`- return GetRunspaceHandleImpl(cancellationToken, isReadLine);`
	`270`	`+ return GetRunspaceHandleImpl(isReadLine, cancellationToken);`
`271`	`271`	`}`
`272`	`272`
`273`	`273`
`@@ -284,7 +284,7 @@ internal RunspaceHandle GetRunspaceHandle(CancellationToken cancellationToken, b`
`284`	`284`	`/// The <see cref="Task{RunspaceHandle}.Result" /> property will return the`
`285`	`285`	`/// <see cref="RunspaceHandle" /> for the current frame.`
`286`	`286`	`/// </returns>`
`287`		`- internal async Task<RunspaceHandle> GetRunspaceHandleAsync(CancellationToken cancellationToken, bool isReadLine)`
	`287`	`+ internal async Task<RunspaceHandle> GetRunspaceHandleAsync(bool isReadLine, CancellationToken cancellationToken)`
`288`	`288`	`{`
`289`	`289`	`if (_isDisposed)`
`290`	`290`	`{`
`@@ -295,10 +295,10 @@ internal async Task<RunspaceHandle> GetRunspaceHandleAsync(CancellationToken can`
`295`	`295`	`// is in process.`
`296`	`296`	`if (isReadLine && !_powerShellContext.IsCurrentRunspaceOutOfProcess())`
`297`	`297`	`{`
`298`		`- await GetRunspaceHandleImplAsync(cancellationToken, isReadLine: false).ConfigureAwait(false);`
	`298`	`+ await GetRunspaceHandleImplAsync(isReadLine: false, cancellationToken).ConfigureAwait(false);`
`299`	`299`	`}`
`300`	`300`
`301`		`- return await GetRunspaceHandleImplAsync(cancellationToken, isReadLine).ConfigureAwait(false);`
	`301`	`+ return await GetRunspaceHandleImplAsync(isReadLine, cancellationToken).ConfigureAwait(false);`
`302`	`302`	`}`
`303`	`303`
`304`	`304`	`/// <summary>`
`@@ -517,7 +517,7 @@ private AsyncQueue<RunspaceHandle> NewHandleQueue()`
`517`	`517`	`return queue;`
`518`	`518`	`}`
`519`	`519`
`520`		`- private RunspaceHandle GetRunspaceHandleImpl(CancellationToken cancellationToken, bool isReadLine)`
	`520`	`+ private RunspaceHandle GetRunspaceHandleImpl(bool isReadLine, CancellationToken cancellationToken)`
`521`	`521`	`{`
`522`	`522`	`if (isReadLine)`
`523`	`523`	`{`
`@@ -527,7 +527,7 @@ private RunspaceHandle GetRunspaceHandleImpl(CancellationToken cancellationToken`
`527`	`527`	`return CurrentFrame.Queue.Dequeue(cancellationToken);`
`528`	`528`	`}`
`529`	`529`
`530`		`- private async Task<RunspaceHandle> GetRunspaceHandleImplAsync(CancellationToken cancellationToken, bool isReadLine)`
	`530`	`+ private async Task<RunspaceHandle> GetRunspaceHandleImplAsync(bool isReadLine, CancellationToken cancellationToken)`
`531`	`531`	`{`
`532`	`532`	`if (isReadLine)`
`533`	`533`	`{`