// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace System.CommandLine.StaticCompletions.Shells;

/// <summary>
/// Provides and manages completions scripts for a specific shell.
/// </summary>
public interface IShellProvider
{
    /// <summary>
    /// The name of this shell as exposed on the completion command line arguments.
    /// </summary>
    string ArgumentName { get; }

    /// <summary>
    /// The file extension typically used for this shell's completions scripts (sans period).
    /// </summary>
    string Extension { get; }

    /// <summary>
    /// This will be used when specifying the shell in CLI completions and help text. Use it to provide any specific details about the shell.
    /// For example, the PowershellShellProvider will clarify that it only works for PowerShell Core.
    /// </summary>
    string? HelpDescription { get; }

    /// <summary>
    /// Generates a shell-specific completions script for the given command tree.
    /// </summary>
    /// <param name="command"></param>
    /// <returns></returns>
    string GenerateCompletions(System.CommandLine.Command command);
}