spectre.console/src/Spectre.Console.Cli/Annotations/CommandOptionAttribute.cs

namespace Spectre.Console.Cli;

/// <summary>
/// An attribute representing a command option.
/// </summary>
/// <seealso cref="Attribute" />
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
public sealed class CommandOptionAttribute : Attribute
{
    /// <summary>
    /// Gets the long names of the option.
    /// </summary>
    /// <value>The option's long names.</value>
    public IReadOnlyList<string> LongNames { get; }

    /// <summary>
    /// Gets the short names of the option.
    /// </summary>
    /// <value>The option's short names.</value>
    public IReadOnlyList<string> ShortNames { get; }

    /// <summary>
    /// Gets the value name of the option.
    /// </summary>
    /// <value>The option's value name.</value>
    public string? ValueName { get; }

    /// <summary>
    /// Gets a value indicating whether the value is optional.
    /// </summary>
    public bool ValueIsOptional { get; }

    /// <summary>
    /// Gets a value indicating whether the value is required.
    /// </summary>
    public bool IsRequired { get; }

    /// <summary>
    /// Gets or sets a value indicating whether this option is hidden from the help text.
    /// </summary>
    public bool IsHidden { get; set; }

    /// <summary>
    /// Initializes a new instance of the <see cref="CommandOptionAttribute"/> class.
    /// </summary>
    /// <param name="template">The option template.</param>
    /// <param name="isRequired">Indicates whether the option is required or not.</param>
    public CommandOptionAttribute(string template, bool isRequired = false)
    {
        if (template == null)
        {
            throw new ArgumentNullException(nameof(template));
        }

        // Parse the option template.
        var result = TemplateParser.ParseOptionTemplate(template);

        // Assign the result.
        LongNames = result.LongNames;
        ShortNames = result.ShortNames;
        ValueName = result.Value;
        ValueIsOptional = result.ValueIsOptional;
        IsRequired = isRequired;
    }

    internal bool IsMatch(string name)
    {
        return
            ShortNames.Contains(name, StringComparer.Ordinal) ||
            LongNames.Contains(name, StringComparer.Ordinal);
    }
}