Skip to content

Conversation

@0xced
Copy link
Contributor

@0xced 0xced commented Oct 6, 2025

Fixes #701

  • I have read the Contribution Guidelines
  • I have commented on the issue above and discussed the intended changes
  • A maintainer has signed off on the changes and the issue was assigned to me
  • All newly added code is adequately covered by tests
  • All existing tests are still running without errors
  • The documentation was modified to reflect the changes OR no documentation changes are required.

Opened as draft because the documentation still needs to be updated.

Changes

A new CancellationToken parameter has been added to the Run and RunAsync methods of ICommandApp and everywhere else needed.

This is a breaking change. Both Command and AsyncCommand subclasses will need to be updated to handle the new CancellationToken.

Before:

public sealed class MyCommand : AsyncCommand
{
    public override Task<int> ExecuteAsync(CommandContext context)
    {
        return Task.FromResult(0);
    }
}

After:

public sealed class MyCommand : AsyncCommand
{
    public override async Task<int> ExecuteAsync(CommandContext context, CancellationToken cancellationToken)
    {
        await Task.Delay(0, cancellationToken);
        return 0;
    }
}

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.

var app = new CommandApp();
app.Configure(config => config.CancellationExitCode(123));

Please upvote 👍 this pull request if you are interested in it.

@0xced 0xced force-pushed the RunAsync-CancellationToken branch from 0fa40e8 to 230d3b6 Compare October 6, 2025 16:52
Also raise CA2016 (forward the CancellationToken parameter to methods that take one) to warning

Fixes spectreconsole#701
@0xced 0xced force-pushed the RunAsync-CancellationToken branch from 230d3b6 to a9563b6 Compare October 6, 2025 17:23
@0xced 0xced marked this pull request as ready for review October 11, 2025 18:33
@0xced
Copy link
Contributor Author

0xced commented Oct 11, 2025

I will update the documentation in a follow-up pull request. Let's merge this to get it into a pre-release.

Copy link
Contributor

@patriksvensson patriksvensson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@patriksvensson patriksvensson merged commit f5f61ca into spectreconsole:main Oct 11, 2025
3 checks passed
@0xced 0xced deleted the RunAsync-CancellationToken branch October 15, 2025 16:14
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.
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CLI Command RunAsync support passing in/propagating a CancelationToken

2 participants