using System;

namespace GitConverter.Lib.Logging
{
    /// <summary>
    /// Minimal logging interface the library can use without depending on any specific logging implementation.
    /// </summary>
    /// <remarks>
    /// - Keep this surface small so the library does not force a particular logging framework on consumers.
    /// - Implementations should avoid throwing from logging calls; logging should be best-effort and not change application flow.
    /// </remarks>
    public interface IAppLogger
    {
        /// <summary>
        /// Log a debug/detail message intended for developers or verbose diagnostics.
        /// </summary>
        /// <param name="message">The message to log.</param>
        void Debug(string message);

        /// <summary>
        /// Log an informational message that represents normal operation or key milestones.
        /// </summary>
        /// <param name="message">The message to log.</param>
        void Info(string message);

        /// <summary>
        /// Log a warning about an unexpected but recoverable condition.
        /// </summary>
        /// <param name="message">The warning message to log.</param>
        void Warn(string message);

        /// <summary>
        /// Log an error. Implementations may include exception details when <paramref name="ex"/> is provided.
        /// </summary>
        /// <param name="message">The error message to log.</param>
        /// <param name="ex">Optional exception associated with the error.</param>
        void Error(string message, Exception ex = null);
    }
}