File: Extensions\AnsiExtensions.cs
Web Access
Project: ..\..\..\src\Cli\Microsoft.DotNet.Cli.Utils\Microsoft.DotNet.Cli.Utils.csproj (Microsoft.DotNet.Cli.Utils)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
namespace Microsoft.DotNet.Cli.Utils.Extensions;
 
public static class AnsiExtensions
{
    private static readonly Lazy<bool> _xtermEnabled = new(
        () =>
        {
            var environment = Environment.GetEnvironmentVariable("TERM");
            if (!string.IsNullOrWhiteSpace(environment))
            {
                return environment.IndexOf("xterm", StringComparison.OrdinalIgnoreCase) >= 0;
            }
 
            return false;
        });
 
    public static string Black(this string text)
    {
        return "\x1B[30m" + text + "\x1B[39m";
    }
 
    public static string Red(this string text)
    {
        return "\x1B[31m" + text + "\x1B[39m";
    }
    public static string Green(this string text)
    {
        return "\x1B[32m" + text + "\x1B[39m";
    }
 
    public static string Yellow(this string text)
    {
        return "\x1B[33m" + text + "\x1B[39m";
    }
 
    public static string Blue(this string text)
    {
        return "\x1B[34m" + text + "\x1B[39m";
    }
 
    public static string Magenta(this string text)
    {
        return "\x1B[35m" + text + "\x1B[39m";
    }
 
    public static string Cyan(this string text)
    {
        return "\x1B[36m" + text + "\x1B[39m";
    }
 
    public static string White(this string text)
    {
        return "\x1B[37m" + text + "\x1B[39m";
    }
 
    public static string Bold(this string text)
    {
        return "\x1B[1m" + text + "\x1B[22m";
    }
 
    /// <summary>
    /// Wraps a string with ANSI escape codes to display it as a clickable URL in supported terminals.
    /// </summary>
    /// <param name="url">The URL to be wrapped.</param>
    /// <param name="displayText">The URL display text.</param>
    /// <returns>A string containing the URL wrapped with ANSI escape codes.</returns>
    public static string Url(this string url, string displayText)
    {
        return _xtermEnabled.Value
            ? "\x1B]8;;" + url + "\x1b\\" + displayText + "\x1b]8;;\x1b\\"
            : url;
    }
}