Mirrors/CliFx
1
0
Fork 0
mirror of https://github.com/Tyrrrz/CliFx.git synced 2025-10-25 15:19:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme with cancellation info (#29)

Browse Source
This commit is contained in:
Moophic
2019-10-30 19:49:43 +02:00
committed by Alexey Golub
parent 9564cd5d30
commit e8f53c9463
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Readme.md
View File

@@ -87,7 +87,7 @@ public class LogCommand : ICommand
[CommandOption("base", 'b', Description = "Logarithm base.")]
public double Base { get; set; } = 10;
public Task ExecuteAsync(IConsole console)
public Task ExecuteAsync(IConsole console, CancellationToken cancellationToken)
{
var result = Math.Log(Value, Base);
console.Output.WriteLine(result);
@@ -99,7 +99,10 @@ public class LogCommand : ICommand
By implementing `ICommand` this class also provides `ExecuteAsync` method. This is the method that gets called when the user invokes the command. Its return type is `Task` in order to facilitate asynchronous execution, but if your command runs synchronously you can simply return `Task.CompletedTask`.
The `ExecuteAsync` method also takes an instance of `IConsole` as a parameter. You should use this abstraction to interact with the console instead of calling `System.Console` so that your commands are testable.
This method takes two parameters: an instance of `IConsole` and `CancellationToken`.
You should use the `console` parameter in places where you would normally use `System.Console`, in order to make your command testable.
The `cancellationToken` parameter can be used to handle interrupt signal (Ctrl+C or Ctrl+Break) to gracefully cancel execution and perform any necessary cleanup. If another interrupt signal is received after the first one, the application will terminate immediately.
Finally, the command defined above can be executed from the command line in one of the following ways:
@@ -173,7 +176,7 @@ public class DivideCommand : ICommand
[CommandOption("divisor", IsRequired = true)]
public double Divisor { get; set; }
public Task ExecuteAsync(IConsole console)
public Task ExecuteAsync(IConsole console, CancellationToken cancellationToken)
{
if (Math.Abs(Divisor) < double.Epsilon)
{
@@ -263,7 +266,7 @@ public class UserAddCommand : ICommand
[CommandOption("email", 'e')]
public string Email { get; set; }
public Task ExecuteAsync(IConsole console)
public Task ExecuteAsync(IConsole console, CancellationToken cancellationToken)
{
var validationResult = new UserAddCommandValidator().Validate(this);
if (!validationResult.IsValid)
@@ -336,7 +339,7 @@ public class ConcatCommand : ICommand
[CommandOption("right")]
public string Right { get; set; } = "world";
public Task ExecuteAsync(IConsole console)
public Task ExecuteAsync(IConsole console, CancellationToken cancellationToken)
{
console.Output.Write(Left);
console.Output.Write(' ');
@@ -365,7 +368,7 @@ public async Task ConcatCommand_Test()
};
// Act
await command.ExecuteAsync(console);
await command.ExecuteAsync(console, CancellationToken.None);
// Assert
Assert.That(stdout.ToString(), Is.EqualTo("foo bar"));
@@ -476,4 +479,4 @@ CliFx is made out of "Cli" for "Command Line Interface" and "Fx" for "Framework"
## Donate
If you really like my projects and want to support me, consider donating to me on [Patreon](https://patreon.com/tyrrrz) or [BuyMeACoffee](https://buymeacoffee.com/tyrrrz). All donations are optional and are greatly appreciated. 🙏
If you really like my projects and want to support me, consider donating to me on [Patreon](https://patreon.com/tyrrrz) or [BuyMeACoffee](https://buymeacoffee.com/tyrrrz). All donations are optional and are greatly appreciated. 🙏