Noi/BirthdayBot
1
0
Fork 0
mirror of https://github.com/NoiTheCat/BirthdayBot.git synced 2024-11-24 01:14:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update style, add nullable

Browse source
This commit is contained in:
Noi 2021-11-22 13:32:30 -08:00
parent f8350fed53
commit 488ebfa163
1 changed files with 38 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
UserInterface/CommandDocumentation.cs
View file

@ -1,52 +1,43 @@
using Discord;
using System;
using System.Collections.Generic;
using System.Text;
using System.Text;
namespace BirthdayBot.UserInterface
{
internal class CommandDocumentation
{
public string[] Commands { get; }
public string Usage { get; }
public string Examples { get; }
namespace BirthdayBot.UserInterface;
public CommandDocumentation(IEnumerable<string> commands, string usage, string examples)
{
var cmds = new List<string>();
foreach (var item in commands) cmds.Add(CommandsCommon.CommandPrefix + item);
if (cmds.Count == 0) throw new ArgumentException(null, nameof(commands));
Commands = cmds.ToArray();
Usage = usage ?? throw new ArgumentException(null, nameof(usage));
Examples = examples;
}
internal class CommandDocumentation {
public string[] Commands { get; }
public string Usage { get; }
public string? Examples { get; }
/// <summary>
/// Returns a string that can be inserted into a help or usage message.
/// </summary>
public string Export()
{
var result = new StringBuilder();
foreach (var item in Commands) result.Append(", `" + item + "`");
result.Remove(0, 2);
result.Insert(0, '●');
result.AppendLine();
result.Append("» " + Usage);
if (Examples != null)
{
result.AppendLine();
result.Append("» Examples: " + Examples);
}
return result.ToString();
}
/// <summary>
/// Creates an embeddable message containing the command documentation.
/// </summary>
public Embed UsageEmbed => new EmbedBuilder()
{
Author = new EmbedAuthorBuilder() { Name = "Usage" },
Description = Export()
}.Build();
public CommandDocumentation(IEnumerable<string> commands, string usage, string? examples) {
var cmds = new List<string>();
foreach (var item in commands) cmds.Add(CommandsCommon.CommandPrefix + item);
if (cmds.Count == 0) throw new ArgumentException(null, nameof(commands));
Commands = cmds.ToArray();
Usage = usage ?? throw new ArgumentException(null, nameof(usage));
Examples = examples;
}
/// <summary>
/// Returns a string that can be inserted into a help or usage message.
/// </summary>
public string Export() {
var result = new StringBuilder();
foreach (var item in Commands) result.Append(", `" + item + "`");
result.Remove(0, 2);
result.Insert(0, '●');
result.AppendLine();
result.Append("» " + Usage);
if (Examples != null) {
result.AppendLine();
result.Append("» Examples: " + Examples);
}
return result.ToString();
}
/// <summary>
/// Creates an embeddable message containing the command documentation.
/// </summary>
public Embed UsageEmbed => new EmbedBuilder() {
Author = new EmbedAuthorBuilder() { Name = "Usage" },
Description = Export()
}.Build();
}