ANSI Terminal Color and Styling Support

import org.springframework.boot.ansi.*;

package org.springframework.boot.ansi;

/**
 * An ANSI encodable element.
 *
 * @since 1.0.0
 */
public interface AnsiElement {
    /**
     * @return the ANSI escape code
     */
    String toString();
}

package org.springframework.boot.ansi;

/**
 * Generates ANSI encoded output, automatically attempting to detect if the terminal
 * supports ANSI.
 *
 * @since 1.0.0
 */
public abstract class AnsiOutput {

    /**
     * Sets if ANSI output is enabled.
     * @param enabled if ANSI is enabled, disabled or detected
     */
    public static void setEnabled(Enabled enabled);

    /**
     * Returns if ANSI output is enabled
     * @return if ANSI enabled, disabled or detected
     */
    public static Enabled getEnabled();

    /**
     * Sets if the System.console() is known to be available.
     * @param consoleAvailable if the console is known to be available or null to
     * use standard detection logic.
     */
    public static void setConsoleAvailable(Boolean consoleAvailable);

    /**
     * Encode a single AnsiElement if output is enabled.
     * @param element the element to encode
     * @return the encoded element or an empty string
     */
    public static String encode(AnsiElement element);

    /**
     * Create a new ANSI string from the specified elements. Any AnsiElements will
     * be encoded as required.
     * @param elements the elements to encode
     * @return a string of the encoded elements
     */
    public static String toString(Object... elements);

    /**
     * Possible values to pass to setEnabled(). Determines when to output
     * ANSI escape sequences for coloring application output.
     */
    public enum Enabled {
        /**
         * Try to detect whether ANSI coloring capabilities are available. The default
         * value for AnsiOutput.
         */
        DETECT,

        /**
         * Enable ANSI-colored output.
         */
        ALWAYS,

        /**
         * Disable ANSI-colored output.
         */
        NEVER
    }
}

package org.springframework.boot.ansi;

/**
 * ANSI foreground colors.
 *
 * @since 1.3.0
 */
public enum AnsiColor implements AnsiElement {
    DEFAULT,
    BLACK,
    RED,
    GREEN,
    YELLOW,
    BLUE,
    MAGENTA,
    CYAN,
    WHITE,
    BRIGHT_BLACK,
    BRIGHT_RED,
    BRIGHT_GREEN,
    BRIGHT_YELLOW,
    BRIGHT_BLUE,
    BRIGHT_MAGENTA,
    BRIGHT_CYAN,
    BRIGHT_WHITE
}

package org.springframework.boot.ansi;

/**
 * ANSI background colors.
 *
 * @since 1.3.0
 */
public enum AnsiBackground implements AnsiElement {
    DEFAULT,
    BLACK,
    RED,
    GREEN,
    YELLOW,
    BLUE,
    MAGENTA,
    CYAN,
    WHITE,
    BRIGHT_BLACK,
    BRIGHT_RED,
    BRIGHT_GREEN,
    BRIGHT_YELLOW,
    BRIGHT_BLUE,
    BRIGHT_MAGENTA,
    BRIGHT_CYAN,
    BRIGHT_WHITE
}

package org.springframework.boot.ansi;

/**
 * ANSI text styles.
 *
 * @since 1.3.0
 */
public enum AnsiStyle implements AnsiElement {
    NORMAL,
    BOLD,
    FAINT,
    ITALIC,
    UNDERLINE
}

package org.springframework.boot.ansi;

/**
 * AnsiElement implementation for ANSI 8-bit foreground or background color codes.
 *
 * @since 2.2.0
 */
public final class Ansi8BitColor implements AnsiElement {

    /**
     * Return a foreground ANSI color code instance for the given code.
     * @param code the color code (must be 0-255)
     * @return an ANSI color code instance
     * @throws IllegalArgumentException if code is not between 0 and 255
     */
    public static Ansi8BitColor foreground(int code);

    /**
     * Return a background ANSI color code instance for the given code.
     * @param code the color code (must be 0-255)
     * @return an ANSI color code instance
     * @throws IllegalArgumentException if code is not between 0 and 255
     */
    public static Ansi8BitColor background(int code);
}

package org.springframework.boot.ansi;

import org.springframework.core.env.PropertySource;

/**
 * PropertySource for AnsiStyle, AnsiColor, AnsiBackground and Ansi8BitColor elements.
 * Supports properties of the form "AnsiStyle.BOLD", "AnsiColor.RED" or
 * "AnsiBackground.GREEN". Also supports a prefix of "Ansi." which is an aggregation
 * of everything (with background colors prefixed "BG_").
 *
 * ANSI 8-bit color codes can be used with AnsiColor and AnsiBackground.
 * For example, "AnsiColor.208" will render orange text.
 *
 * @since 1.3.0
 */
public class AnsiPropertySource extends PropertySource<AnsiElement> {

    /**
     * Create a new AnsiPropertySource instance.
     * @param name the name of the property source
     * @param encode if the output should be encoded
     */
    public AnsiPropertySource(String name, boolean encode);

    /**
     * Get an ANSI property by name.
     * Supported prefixes:
     * - "AnsiStyle." (e.g., "AnsiStyle.BOLD")
     * - "AnsiColor." (e.g., "AnsiColor.RED" or "AnsiColor.208")
     * - "AnsiBackground." (e.g., "AnsiBackground.GREEN" or "AnsiBackground.27")
     * - "Ansi." (aggregation prefix, e.g., "Ansi.BOLD", "Ansi.RED", "Ansi.BG_GREEN")
     * @param name the property name
     * @return the AnsiElement or encoded string, or null if not found
     */
    @Override
    public Object getProperty(String name);
}

import org.springframework.boot.ansi.*;

public class ColoredLogging {

    public void logWithColor() {
        // Simple colored output
        String message = AnsiOutput.toString(
            AnsiColor.GREEN, "SUCCESS: ", AnsiColor.DEFAULT, "Operation completed"
        );
        System.out.println(message);

        // Error message in red
        String error = AnsiOutput.toString(
            AnsiColor.RED, "ERROR: ", AnsiColor.DEFAULT, "Operation failed"
        );
        System.err.println(error);

        // Warning with background color
        String warning = AnsiOutput.toString(
            AnsiBackground.YELLOW, AnsiColor.BLACK, " WARNING ",
            AnsiBackground.DEFAULT, AnsiColor.DEFAULT, " Check configuration"
        );
        System.out.println(warning);
    }
}

import org.springframework.boot.ansi.*;

public class StyledOutput {

    public void demonstrateStyles() {
        // Bold text
        System.out.println(AnsiOutput.toString(
            AnsiStyle.BOLD, "Important Message", AnsiStyle.NORMAL
        ));

        // Italic text
        System.out.println(AnsiOutput.toString(
            AnsiStyle.ITALIC, "Emphasized text", AnsiStyle.NORMAL
        ));

        // Underlined text
        System.out.println(AnsiOutput.toString(
            AnsiStyle.UNDERLINE, "Underlined text", AnsiStyle.NORMAL
        ));

        // Combined: bold red text
        System.out.println(AnsiOutput.toString(
            AnsiStyle.BOLD, AnsiColor.RED, "Critical Alert",
            AnsiStyle.NORMAL, AnsiColor.DEFAULT
        ));
    }
}

import org.springframework.boot.ansi.*;

public class ExtendedColors {

    public void use8BitColors() {
        // Use 256-color palette (0-255)

        // Foreground color code 208 (orange)
        String orange = AnsiOutput.toString(
            Ansi8BitColor.foreground(208), "Orange text", AnsiColor.DEFAULT
        );
        System.out.println(orange);

        // Background color code 27 (deep blue)
        String highlighted = AnsiOutput.toString(
            Ansi8BitColor.background(27), "Highlighted text", AnsiBackground.DEFAULT
        );
        System.out.println(highlighted);

        // Combining foreground and background
        String colorful = AnsiOutput.toString(
            Ansi8BitColor.foreground(226), // Yellow
            Ansi8BitColor.background(21),  // Blue
            " Colorful Text ",
            AnsiColor.DEFAULT,
            AnsiBackground.DEFAULT
        );
        System.out.println(colorful);
    }
}

import org.springframework.boot.ansi.*;

@Configuration
public class AnsiConfiguration {

    @PostConstruct
    public void configureAnsi() {
        // Force enable ANSI output (even if not detected)
        AnsiOutput.setEnabled(AnsiOutput.Enabled.ALWAYS);

        // Or disable completely
        AnsiOutput.setEnabled(AnsiOutput.Enabled.NEVER);

        // Or use automatic detection (default)
        AnsiOutput.setEnabled(AnsiOutput.Enabled.DETECT);

        // Check current setting
        AnsiOutput.Enabled current = AnsiOutput.getEnabled();
        System.out.println("ANSI output: " + current);
    }

    @Bean
    @Profile("production")
    public CommandLineRunner disableAnsiInProduction() {
        return args -> {
            // Disable colors in production logs
            AnsiOutput.setEnabled(AnsiOutput.Enabled.NEVER);
        };
    }
}

import org.springframework.boot.Banner;
import org.springframework.boot.ansi.*;
import org.springframework.core.env.Environment;

public class ColoredBanner implements Banner {

    @Override
    public void printBanner(Environment environment, Class<?> sourceClass, PrintStream out) {
        out.println(AnsiOutput.toString(
            AnsiColor.GREEN, AnsiStyle.BOLD,
            " ███████╗██████╗ ██████╗ ██╗███╗   ██╗ ██████╗ ",
            AnsiStyle.NORMAL, AnsiColor.DEFAULT
        ));
        out.println(AnsiOutput.toString(
            AnsiColor.GREEN,
            " ██╔════╝██╔══██╗██╔══██╗██║████╗  ██║██╔════╝ ",
            AnsiColor.DEFAULT
        ));
        out.println(AnsiOutput.toString(
            AnsiColor.BRIGHT_GREEN,
            " ███████╗██████╔╝██████╔╝██║██╔██╗ ██║██║  ███╗",
            AnsiColor.DEFAULT
        ));
        out.println(AnsiOutput.toString(
            AnsiColor.CYAN,
            " ╚════██║██╔═══╝ ██╔══██╗██║██║╚██╗██║██║   ██║",
            AnsiColor.DEFAULT
        ));
        out.println(AnsiOutput.toString(
            AnsiColor.BRIGHT_CYAN,
            " ███████║██║     ██║  ██║██║██║ ╚████║╚██████╔╝",
            AnsiColor.DEFAULT
        ));
        out.println(AnsiOutput.toString(
            AnsiColor.BLUE,
            " ╚══════╝╚═╝     ╚═╝  ╚═╝╚═╝╚═╝  ╚═══╝ ╚═════╝ ",
            AnsiColor.DEFAULT
        ));

        String version = environment.getProperty("spring.application.version", "unknown");
        out.println(AnsiOutput.toString(
            AnsiStyle.FAINT, " Version: ", version, AnsiStyle.NORMAL
        ));
    }
}

import org.springframework.boot.ansi.*;

// In application.properties or application.yml:
// spring.output.ansi.enabled=always
// spring.output.ansi.enabled=detect
// spring.output.ansi.enabled=never

@Component
public class AnsiPropertyConfiguration {

    public AnsiPropertyConfiguration(Environment environment) {
        String ansiProperty = environment.getProperty("spring.output.ansi.enabled", "detect");

        switch (ansiProperty.toLowerCase()) {
            case "always":
                AnsiOutput.setEnabled(AnsiOutput.Enabled.ALWAYS);
                break;
            case "never":
                AnsiOutput.setEnabled(AnsiOutput.Enabled.NEVER);
                break;
            case "detect":
            default:
                AnsiOutput.setEnabled(AnsiOutput.Enabled.DETECT);
                break;
        }
    }
}

if (loggingToFile) {
    AnsiOutput.setEnabled(AnsiOutput.Enabled.NEVER);
}

# application.properties
spring.output.ansi.enabled=detect  # Development
# application-prod.properties
spring.output.ansi.enabled=never   # Production (file logging)