-
Notifications
You must be signed in to change notification settings - Fork 636
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 Jan 12, 2026
This was referenced Jan 21, 2026
microsoft-github-policy-service bot
pushed a commit
to Azure/bicep
that referenced
this pull request
Feb 1, 2026
Updated [Spectre.Console](https://github.com/spectreconsole/spectre.console) from 0.51.1 to 0.54.0. <details> <summary>Release notes</summary> _Sourced from [Spectre.Console's releases](https://github.com/spectreconsole/spectre.console/releases)._ ## 0.54.0 Version `0.54.0` of Spectre.Console has been released! ## Spectre.Console.Cli has a new home! We've decided to move `Spectre.Console.Cli` to its own repository, where we will prepare it for a _1.0_ release. This means that the _Spectre.Console.Cli_ NuGet packages will no longer be versioned together with _Spectre.Console_. They will now have a preview version such as `1.0.0-alpha-0.x`. There should be no issues staying on version _0.53.0_ of _Spectre.Console.Cli_ until we release a stable version if you prefer not to use a pre-release dependency. ## New unit testing package for Spectre.Console.Cli There is now a new testing package for _Spectre.Console.Cli_ called [Spectre.Console.Cli.Testing](https://www.nuget.org/packages/Spectre.Console.Cli.Testing). This is where you will find the `CommandAppTester` from now on. You can find more information about unit testing in the [documentation](https://spectreconsole.net/cli/unit-testing). ## What's Changed * Normalizes paths when writing exceptions to the console for tests. by [@phil-scott-78](https://github.com/phil-scott-78) in [#1758](spectreconsole/spectre.console#1758) * Fixes issue with Panel not applying overflow to children by [@phil-scott-78](https://github.com/phil-scott-78) in [#1942](spectreconsole/spectre.console#1942) * Remove Spectre.Console.Cli from repository by [@patriksvensson](https://github.com/patriksvensson) in [#1928](spectreconsole/spectre.console#1928) **Full Changelog**: spectreconsole/spectre.console@0.53.0...0.54.0 ## 0.53.1 This is a hotfix release for 0.53.0, which accidentally included `OpenCli.Sources` as a dependency, instead of being included in the package. As a bonus, a fix for panels was also included in this release 😄 ## What's Changed * Ensure OpenCli.Sources are not a dependency of the CLI package. by @patriksvensson in d61788d6c681745c8d1158ceeb4545ba37a99522 * Normalizes paths when writing exceptions to the console for tests. by @phil-scott-78 in spectreconsole/spectre.console#1758 * Fixes issue with Panel not applying overflow to children by @phil-scott-78 in spectreconsole/spectre.console#1942 **Full Changelog**: spectreconsole/spectre.console@0.53.0...0.53.1 ## 0.53.0 ## What's Changed * Add top-level CancellationToken support to Spectre.Console.Cli by [@0xced](https://github.com/0xced) in [#1911](spectreconsole/spectre.console#1911) * Update the Spectre.Console.Cli documentation with CancellationToken by [@0xced](https://github.com/0xced) in [#1920](spectreconsole/spectre.console#1920) **Full Changelog**: spectreconsole/spectre.console@0.52.0...0.53.0 ## 0.52.0 ## What's Changed * Add OpenCLI integration to Spectre.Console.Cli by [@patriksvensson](https://github.com/patriksvensson) in [#1909](spectreconsole/spectre.console#1909) * Fix OPENCLI_VISIBILITY_INTERNAL to DefineConstants concat by [@devlead](https://github.com/devlead) in [#1912](spectreconsole/spectre.console#1912) **Full Changelog**: spectreconsole/spectre.console@0.51.1...0.52.0 Commits viewable in [compare view](spectreconsole/spectre.console@0.51.1...0.54.0). </details> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/18859) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This was referenced Feb 1, 2026
This was referenced Feb 9, 2026
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.