updated CLI help text

This commit is contained in:
irongut
2021-10-19 00:28:24 +01:00
parent 7c070aea38
commit d8b1bc5ef2
@@ -8,7 +8,7 @@ namespace CodeCoverageSummary
[Value(index: 0, Required = true, HelpText = "Code coverage file to analyse.")] [Value(index: 0, Required = true, HelpText = "Code coverage file to analyse.")]
public string Filename { get; set; } public string Filename { get; set; }
[Option(longName: "badge", Required = false, HelpText = "Include a badge reporting the Line Rate coverage in the output using shields.io - true or false.", Default = "false")] [Option(longName: "badge", Required = false, HelpText = "Include a Line Rate coverage badge in the output using shields.io - true or false.", Default = "false")]
public string BadgeString { get; set; } public string BadgeString { get; set; }
public bool Badge => BadgeString.Equals("true", StringComparison.OrdinalIgnoreCase); public bool Badge => BadgeString.Equals("true", StringComparison.OrdinalIgnoreCase);
@@ -16,7 +16,7 @@ namespace CodeCoverageSummary
[Option(longName: "format", Required = false, HelpText = "Output Format - markdown or text.", Default = "text")] [Option(longName: "format", Required = false, HelpText = "Output Format - markdown or text.", Default = "text")]
public string Format { get; set; } public string Format { get; set; }
[Option(longName: "indicators", Required = false, HelpText = "Include package health indicators in the output - true or false.", Default = "true")] [Option(longName: "indicators", Required = false, HelpText = "Include health indicators in the output - true or false.", Default = "true")]
public string IndicatorsString { get; set; } public string IndicatorsString { get; set; }
public bool Indicators => IndicatorsString.Equals("true", StringComparison.OrdinalIgnoreCase); public bool Indicators => IndicatorsString.Equals("true", StringComparison.OrdinalIgnoreCase);
@@ -24,7 +24,7 @@ namespace CodeCoverageSummary
[Option(longName: "output", Required = false, HelpText = "Output Type - console, file or both.", Default = "console")] [Option(longName: "output", Required = false, HelpText = "Output Type - console, file or both.", Default = "console")]
public string Output { get; set; } public string Output { get; set; }
[Option(longName: "thresholds", Required = false, HelpText = "Badge colour threshold percentages.", Default = "50 75")] [Option(longName: "thresholds", Required = false, HelpText = "Badge and health indicator threshold percentages.", Default = "50 75")]
public string Thresholds { get; set; } public string Thresholds { get; set; }
} }
} }