88e2e9e993
This commit attempts to make the command line help user experience for `dotnet` more consistent for all of the built-in SDK commands. The following has been changed: * Organized the top-level help into a section detailing how to run .NET applications and a section on running SDK commands. * Sorted the SDK commands by name (previous ordering was undefined). * Removed `--verbosity` from the "common options section" since it is not a top-level option, nor is it common to all commands. * Added missing parameter names for parameterized options (especially for the `dotnet tool` subcommands). * Fixed the localization of parameter names for parameterized options. * Added missing `PROJECT` parameter to a few commands. * Fixed the localization of the build command's `PROJECT` parameter description. * Fixed the confusing descriptions for the `--framework`, `--configuration`, and `--runtime` options that were being shared between different commands. * Fixed the "unknown command" error for `dotnet help <command>` to show in red. * Deleted .resx for `dotnet msbuild` that is no longer used. * Change the option descriptions to be more consistent in their grammatical structure. * Removed extra blank line from end of help output. Fixes #7431. Fixes #9230. Fixes #9165.
35 lines
1.1 KiB
C#
35 lines
1.1 KiB
C#
// Copyright (c) .NET Foundation and contributors. All rights reserved.
|
|
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
|
|
using Microsoft.DotNet.Tools.Test.Utilities;
|
|
using Xunit;
|
|
using FluentAssertions;
|
|
using HelpActual = Microsoft.DotNet.Tools.Help;
|
|
|
|
namespace Microsoft.DotNet.Help.Tests
|
|
{
|
|
public class GivenThatIWantToShowHelpForDotnetHelpCommand : TestBase
|
|
{
|
|
private const string HelpText =
|
|
@"Usage: dotnet help [options] <COMMAND_NAME>
|
|
|
|
Arguments:
|
|
<COMMAND_NAME> The SDK command to launch online help for.
|
|
|
|
Options:
|
|
-h, --help Show command line help.";
|
|
|
|
[Theory]
|
|
[InlineData("--help")]
|
|
[InlineData("-h")]
|
|
[InlineData("-?")]
|
|
[InlineData("/?")]
|
|
public void WhenHelpOptionIsPassedToDotnetHelpCommandItPrintsUsage(string helpArg)
|
|
{
|
|
var cmd = new HelpCommand()
|
|
.ExecuteWithCapturedOutput($"{helpArg}");
|
|
cmd.Should().Pass();
|
|
cmd.StdOut.Should().ContainVisuallySameFragmentIfNotLocalized(HelpText);
|
|
}
|
|
}
|
|
}
|