Aurora 🎨

"Porque la vida es muy corta para terminales en blanco y negro"

🌈 La biblioteca más simpática para hacer que tu terminal se vea increíble

¿Cansado de ver texto aburrido en tu terminal? ¿Quieres que tus logs tengan más estilo que un influencer en Instagram? Aurora es tu nuevo mejor amigo. Convierte tu terminal del equivalente digital de una pared gris en un festival de colores y efectos que hasta tu gato querrá ver.

✨ Filosofía de Aurora

Aurora está diseñado con simplicidad en mente:

• 🚀 Uso básico ultra-simple - Aurora.format/2 con opciones básicas para el 90% de casos
• 🔧 Módulos especializados - Para casos avanzados que requieren control total
• 📚 Documentación clara - Con ejemplos que hasta tu abuela entendería

🚀 Instalación (más fácil que hacer café)

# En tu mix.exs, agrega esta línea mágica:
def deps do
  [
    {:aurora, "~> 1.0"}
  ]
end

mix deps.get  # ¡Y ya está! 🎉

🎨 Configuración Opcional

Si quieres personalizar los colores, crea un archivo config/config.exs en tu proyecto:

# config/config.exs
import Config

config :aurora, :colors,
  colors: %{
    primary: %{hex: "#0066CC"},     # Tu color principal
    error: %{hex: "#DC3545"},       # Tu color de error
    # ... más colores personalizados
  }

Ver configuración completa más abajo.

📋 Funciones Disponibles - Referencia Rápida

🎯 Funciones Básicas (en Aurora.ex)

📊 Datos Estructurados (en Aurora.ex)

🔧 Utilidades (en Aurora.ex)

💡 Para funciones avanzadas (tablas, badges, divisores, encabezados, efectos específicos, etc.) usar directamente los módulos especializados: Aurora.Format, Aurora.Color, Aurora.Effects, Aurora.Convert.

🎯 Uso Básico (para el 90% de casos)

La función mágica: Aurora.format/2

# Texto simple con color
Aurora.format("¡Hola mundo!", color: :primary) |> IO.puts()

# Texto con error (rojo y negrita)
Aurora.format("Error crítico", color: :error, bold: true) |> IO.puts()

# Texto centrado
Aurora.format("Título centrado", color: :info, align: :center) |> IO.puts()

# Múltiples líneas con el mismo formato |> IO.puts()
Aurora.format(["Línea 1", "Línea 2", "Línea 3"], color: :success) |> IO.puts()

# Color personalizado con hex
Aurora.format("Color custom", color: "#FF6B35") |> IO.puts()

Opciones básicas de Aurora.format/2

🔧 Funciones Especializadas (para casos avanzados)

Colorizar texto directamente

# Solo aplicar color
Aurora.colorize("texto", :primary) |> IO.puts()
Aurora.colorize("error", "#FF0000") |> IO.puts()

Efectos de texto

# Un solo efecto
Aurora.stylize("texto", :bold) |> IO.puts()

# Múltiples efectos
Aurora.stylize("texto", [:bold, :underline, :italic]) |> IO.puts()

Gradientes de color

# Generar gradiente de 6 colores
colors = Aurora.gradient("#FF0000", "#00FF00")  # Rojo a verde

# Gradiente personalizado
colors = Aurora.gradient("#FF0000", "#0000FF", 10)  # 10 colores

Trabajar con chunks (piezas de texto)

# Crear chunk individual
chunk = Aurora.chunk("texto", :primary)

# Crear múltiples chunks
chunks = Aurora.chunks([
  {"Error:", :error},
  {" Archivo no encontrado", :warning}
])

# Formatear lista de chunks
Aurora.format_chunks(chunks)

Utilidades básicas

# Limpiar códigos ANSI de texto formateado
text_limpio = Aurora.clean("\\e[31mTexto\\e[0m")

# Obtener longitud real del texto (sin códigos ANSI)
longitud = Aurora.text_length("\\e[31mHola\\e[0m")  # => 4

Formateo de datos estructurados

# JSON (acepta maps, strings, listas)
data = %{name: "Juan", age: 25, active: true}
Aurora.json(data) |> IO.puts()                            # Pretty print con colores
Aurora.json(data, color: :success) |> IO.puts()           # JSON en verde
Aurora.json(data, compact: true) |> IO.puts()             # Formato compacto
Aurora.json(data, indent: true) |> IO.puts()              # Con indentación extra

# Para funciones más avanzadas (tablas, badges, etc.) usar los módulos especializados
# Ver sección "Uso Avanzado con Módulos" más abajo

📋 Colores Disponibles

Colores Principales

Colores de Estado

Colores Especiales

🎨 Configuración Personalizada de Colores

Puedes personalizar los colores predefinidos creando tu propia configuración en config/config.exs:

# config/config.exs
config :aurora, :colors,
  colors: %{
    no_color: %{name: :no_color, hex: "#F8F8F2"},
    debug: %{name: :debug, hex: "#B0B0B0"},
    primary: %{name: :primary, hex: "#A1E7FA"},
    secondary: %{name: :secondary, hex: "#3AABA3"},
    ternary: %{name: :ternary, hex: "#FF8000"},
    quaternary: %{name: :quaternary, hex: "#9B42E2"},
    success: %{name: :success, hex: "#97C53C"},
    warning: %{name: :warning, hex: "#FFCC00"},
    warn: %{name: :warning, hex: "#FFCC00"},
    error: %{name: :error, hex: "#FF5B5B"},
    info: %{name: :info, hex: "#00ffff"},
    happy: %{name: :happy, hex: "#EE80C3"},
    background: %{name: :background, hex: "#32302f"},
    menu: %{name: :menu, hex: "#abcdf1"},
    notice: %{name: :notice, hex: "#5FD7FF"},
    critical: %{name: :critical, hex: "#fbff00", inverted: true},
    alert: %{name: :alert, hex: "#fbff00", inverted: true},
    emergency: %{name: :emergency, hex: "#FF0000", inverted: true}
  },
  gradients: %{
    gradient_1: %{name: :gradient_1, hex: "#ff8000"},
    gradient_2: %{name: :gradient_2, hex: "#ff9429"},
    gradient_3: %{name: :gradient_3, hex: "#ffa952"},
    gradient_4: %{name: :gradient_4, hex: "#ffbd7a"},
    gradient_5: %{name: :gradient_5, hex: "#ffd2a3"},
    gradient_6: %{name: :gradient_6, hex: "#ffe6cc"}
  }

Uso con colores personalizados:

# Usar colores personalizados
Aurora.format("Mensaje de marca", color: :brand)
Aurora.format("Texto resaltado", color: :highlight)
Aurora.format("Información secundaria", color: :muted)

# Los colores se aplican automáticamente
Aurora.colorize("Gradiente fuego", :fire)

Ejemplos de configuración: Consulta el archivo config/config.exs.example para ver un ejemplo completo de configuración con muchos colores personalizados.

Nota: Si no se proporciona configuración, Aurora usará los colores predeterminados mostrados en la tabla.

🔍 Consultar Colores Disponibles

Puedes obtener dinámicamente todos los colores configurados:

# Obtener todos los colores disponibles
colores_disponibles = Aurora.colors()
IO.inspect(colores_disponibles)

# Verificar si un color específico existe
color_existe = Map.has_key?(Aurora.colors(), :brand)

# Obtener información detallada de un color
info_color = Aurora.Color.get_color_info(:primary)
IO.inspect(info_color)
# => %Aurora.Structs.ColorInfo{name: :primary, hex: "#00FFFF", inverted: false}

🎨 Efectos Disponibles

🏗️ Uso Avanzado con Módulos

Para casos donde necesitas control total, usa los módulos especializados:

Aurora.Format - Control total del formateo

# Crear estructura FormatInfo completa
format_info = %Aurora.Structs.FormatInfo{
  chunks: [
    %Aurora.Structs.ChunkText{
      text: "Título importante",
      color: Aurora.Color.get_color_info(:primary),
      effects: %Aurora.Structs.EffectInfo{bold: true, underline: true}
    }
  ],
  align: :center,
  manual_tabs: 2,
  add_line: :both
}

resultado = Aurora.Format.format(format_info)

Aurora.Color - Manejo avanzado de colores

# Obtener información de color
color_info = Aurora.Color.get_color_info(:primary)

# Trabajar con colores hex
color_custom = Aurora.Color.get_color_info("#FF6B35")

# Generar gradientes entre colores
gradiente = Aurora.Color.generate_gradient_between("#FF0000", "#00FF00")

# Obtener todos los colores disponibles
colores = Aurora.Color.get_all_colors()

Aurora.Effects - Control de efectos

# Aplicar efecto individual
texto = Aurora.Effects.apply_effect("texto", :bold)

# Aplicar múltiples efectos
texto = Aurora.Effects.apply_multiple_effects("texto", [:bold, :italic])

# Aplicar efectos desde lista de opciones
texto = Aurora.Effects.apply_effects("texto", [bold: true, italic: true])

Aurora.Convert - Utilidades de conversión

# Convertir datos a chunks
chunk = Aurora.Convert.to_chunk("texto")
chunk = Aurora.Convert.to_chunk({"texto", :primary})

# Verificar si datos forman tabla
es_tabla = Aurora.Convert.table?([[1, 2], [3, 4]])

🧪 Estructuras de Datos

ChunkText - Fragmento de texto formateado

%Aurora.Structs.ChunkText{
  text: "Mi texto",                    # Texto (requerido)
  color: %ColorInfo{},                 # Color opcional
  effects: %EffectInfo{}               # Efectos opcionales
}

ColorInfo - Información de color

%Aurora.Structs.ColorInfo{
  name: :primary,                      # Nombre del color
  hex: "#00FFFF",                      # Código hexadecimal
  inverted: false                      # Si está invertido
}

FormatInfo - Configuración completa de formato

%Aurora.Structs.FormatInfo{
  chunks: [%ChunkText{}],              # Lista de chunks (requerido)
  default_color: %ColorInfo{},         # Color por defecto
  align: :left,                        # Alineación
  manual_tabs: -1,                     # Indentación manual (-1 = automática)
  add_line: :none,                     # Saltos de línea (:before, :after, :both, :none)
  animation: ""                        # Prefijo de animación
}

EffectInfo - Efectos de texto

%Aurora.Structs.EffectInfo{
  bold: false,                         # Negrita
  italic: false,                       # Cursiva
  underline: false,                    # Subrayado
  dim: false,                          # Atenuado
  blink: false,                        # Parpadeante
  reverse: false,                      # Invertido
  hidden: false,                       # Oculto
  strikethrough: false,                # Tachado
  link: false                          # Como enlace
}

🧪 Testing

# Ejecutar todos los tests
mix test

# Ejecutar solo doctests
mix test --only doctest

# Ejecutar tests con cobertura
mix test --cover

📦 Dependencias

• :jason - Para formateo de JSON (incluida automáticamente)

📄 Licencia

MIT License - ¡Úsalo, mejóralo, compártelo!

🤝 Contribuir

¿Tienes ideas para hacer Aurora aún más genial? ¡Los PRs son bienvenidos! Asegúrate de:

1. Mantener la filosofía simple
2. Agregar tests para nuevas funcionalidades
3. Actualizar la documentación
4. Hacer que todo sea súper fácil de usar

¡Disfruta haciendo tu terminal hermoso! 🎨✨