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

Handle cases where matchingCommandSchema == null more cleanly

Browse Source
This commit is contained in:
Alexey Golub
2019-07-30 18:13:59 +03:00
parent 041a995c62
commit 50df046754
2 changed files with 56 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
CliFx/CliApplication.cs
View File

@@ -4,6 +4,7 @@ using System.IO;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;
using CliFx.Attributes;
using CliFx.Exceptions;
using CliFx.Internal;
using CliFx.Models;
@@ -61,21 +62,7 @@ namespace CliFx
private CommandSchema GetMatchingCommandSchema(IReadOnlyList<CommandSchema> availableCommandSchemas, string commandName) =>
availableCommandSchemas.FirstOrDefault(c => string.Equals(c.Name, commandName, StringComparison.OrdinalIgnoreCase));
private bool IsHelpRequested(CommandInput commandInput)
{
var firstOptionAlias = commandInput.Options.FirstOrDefault()?.Alias;
return string.Equals(firstOptionAlias, "help", StringComparison.OrdinalIgnoreCase) ||
string.Equals(firstOptionAlias, "h", StringComparison.OrdinalIgnoreCase) ||
string.Equals(firstOptionAlias, "?", StringComparison.OrdinalIgnoreCase);
}
private bool IsVersionRequested(CommandInput commandInput)
{
var firstOptionAlias = commandInput.Options.FirstOrDefault()?.Alias;
return string.Equals(firstOptionAlias, "version", StringComparison.OrdinalIgnoreCase);
}
public async Task<int> RunAsync(IReadOnlyList<string> commandLineArguments)
{
@@ -94,17 +81,26 @@ namespace CliFx
return -1;
}
// Fail if specified a command which is not defined
if (!commandInput.CommandName.IsNullOrWhiteSpace() && matchingCommandSchema == null)
{
_console.WithColor(ConsoleColor.Red,
c => c.Error.WriteLine($"Specified command [{commandInput.CommandName}] is not defined."));
return -1;
// Handle cases where requested command is not defined
if (matchingCommandSchema == null)
{
// If specified a command - show error
if (commandInput.IsCommandSpecified())
{
_console.WithColor(ConsoleColor.Red,
c => c.Error.WriteLine($"Specified command [{commandInput.CommandName}] is not defined."));
}
// Show help
var stubDefaultCommandSchema = _commandSchemaResolver.GetCommandSchema(typeof(StubDefaultCommand));
_commandHelpTextRenderer.RenderHelpText(_applicationMetadata, availableCommandSchemas, stubDefaultCommandSchema);
return commandInput.IsCommandSpecified() ? -1 : 0;
}
// Show version if it was requested without specifying a command
if (IsVersionRequested(commandInput) && commandInput.CommandName.IsNullOrWhiteSpace())
if (commandInput.IsVersionRequested() && !commandInput.IsCommandSpecified())
{
_console.Output.WriteLine(_applicationMetadata.VersionText);
@@ -112,21 +108,13 @@ namespace CliFx
}
// Show help if it was requested
if (IsHelpRequested(commandInput))
if (commandInput.IsHelpRequested())
{
_commandHelpTextRenderer.RenderHelpText(_applicationMetadata, availableCommandSchemas, matchingCommandSchema);
return 0;
}
// Show help if command wasn't specified but a default command isn't defined
if (commandInput.CommandName.IsNullOrWhiteSpace() && matchingCommandSchema == null)
{
_commandHelpTextRenderer.RenderHelpText(_applicationMetadata, availableCommandSchemas);
return 0;
}
// Create an instance of the command
var command = _commandFactory.CreateCommand(matchingCommandSchema.Type);
@@ -171,4 +159,13 @@ namespace CliFx
return entryAssembly.ExportedTypes.Where(t => t.Implements(typeof(ICommand))).ToArray();
}
}
public partial class CliApplication
{
[Command]
private sealed class StubDefaultCommand : ICommand
{
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
}
}
}

29
CliFx/Models/Extensions.cs Normal file
View File

@@ -0,0 +1,29 @@
using System;
using System.Linq;
using CliFx.Internal;
namespace CliFx.Models
{
public static class Extensions
{
public static bool IsCommandSpecified(this CommandInput commandInput) => !commandInput.CommandName.IsNullOrWhiteSpace();
public static bool IsHelpRequested(this CommandInput commandInput)
{
var firstOptionAlias = commandInput.Options.FirstOrDefault()?.Alias;
return string.Equals(firstOptionAlias, "help", StringComparison.OrdinalIgnoreCase) ||
string.Equals(firstOptionAlias, "h", StringComparison.OrdinalIgnoreCase) ||
string.Equals(firstOptionAlias, "?", StringComparison.OrdinalIgnoreCase);
}
public static bool IsVersionRequested(this CommandInput commandInput)
{
var firstOptionAlias = commandInput.Options.FirstOrDefault()?.Alias;
return string.Equals(firstOptionAlias, "version", StringComparison.OrdinalIgnoreCase);
}
public static bool IsDefault(this CommandSchema commandSchema) => commandSchema.Name.IsNullOrWhiteSpace();
}
}