-
Notifications
You must be signed in to change notification settings - Fork 612
Add top-level CancellationToken support to Spectre.Console.Cli #1911
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
patriksvensson
merged 1 commit into
spectreconsole:main
from
0xced:RunAsync-CancellationToken
Oct 11, 2025
Merged
Add top-level CancellationToken support to Spectre.Console.Cli #1911
patriksvensson
merged 1 commit into
spectreconsole:main
from
0xced:RunAsync-CancellationToken
Oct 11, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0fa40e8 to
230d3b6
Compare
Also raise CA2016 (forward the CancellationToken parameter to methods that take one) to warning Fixes spectreconsole#701
230d3b6 to
a9563b6
Compare
This was referenced Oct 7, 2025
Closed
Contributor
Author
|
I will update the documentation in a follow-up pull request. Let's merge this to get it into a pre-release. |
patriksvensson
approved these changes
Oct 11, 2025
Contributor
patriksvensson
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
0xced
added a commit
to 0xced/0xced.Templates
that referenced
this pull request
Oct 15, 2025
Use top-level cancellation support introduced in spectreconsole/spectre.console#1911
0xced
added a commit
to 0xced/spectre.console
that referenced
this pull request
Oct 16, 2025
Now that spectreconsole#1911 is merged, all `Execute` methods of commands have a new CancellationToken parameter. Update the documentation to reflect that. New documentation shall still be written with an example on how to pass the top-level CancellationToken to the app.Run(Async) method.
6 tasks
patriksvensson
pushed a commit
that referenced
this pull request
Oct 16, 2025
Now that #1911 is merged, all `Execute` methods of commands have a new CancellationToken parameter. Update the documentation to reflect that. New documentation shall still be written with an example on how to pass the top-level CancellationToken to the app.Run(Async) method.
0xced
added a commit
to 0xced/examples
that referenced
this pull request
Oct 27, 2025
All the Cli examples have been updated with the new CancellationToken introduced in spectreconsole/spectre.console#1911
This was referenced Nov 12, 2025
This was referenced Nov 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #701
Opened as draft because the documentation still needs to be updated.
Changes
A new
CancellationTokenparameter has been added to theRunandRunAsyncmethods ofICommandAppand everywhere else needed.This is a breaking change. Both
CommandandAsyncCommandsubclasses will need to be updated to handle the newCancellationToken.Before:
After:
When the application terminates because the cancellation token was triggered, the default exit code is 130. This value can be configured through the new
CancellationExitCode()fluent method.Please upvote 👍 this pull request if you are interested in it.