OptionAttribute.cs

/*
 * Copyright 2026 the original author or authors.
 * <p>
 * Licensed under the Moderne Source Available License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * https://docs.moderne.io/licensing/moderne-source-available-license
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
using JetBrains.Annotations;

namespace OpenRewrite.Core;

/// <summary>
/// Marks a property as a configurable recipe option.
/// Mirrors Java's <c>@Option</c> annotation.
/// </summary>
[AttributeUsage(AttributeTargets.Property)]
public sealed class OptionAttribute : Attribute
{
    [LanguageInjection("markdown")]
    public string DisplayName { get; set; } = "";

    [LanguageInjection("markdown")]
    public string Description { get; set; } = "";

    public string Example { get; set; } = "";

    public string[]? Valid { get; set; }

    public bool Required { get; set; } = true;

    /// <summary>
    /// Indicates the value is sensitive (an API token, password, etc.).
    /// <para>
    /// Consumers persisting or displaying option values are expected to redact secret values.
    /// The corresponding <see cref="OptionDescriptor.Value"/> is left raw at the source so the
    /// value can still be passed into recipe execution (including across RPC); redaction happens
    /// at each persistence boundary.
    /// </para>
    /// </summary>
    public bool Secret { get; set; } = false;
}