Skip to content

README.ru.md

Latest commit

 

History

History
201 lines (148 loc) · 6.61 KB

README.ru.md

File metadata and controls

201 lines (148 loc) · 6.61 KB

PrettyTerm - Pretty Terminal Printers

License: MIT Nim Version Version

Библиотека для создания красивых терминальных интерфейсов на Nim.

Описание

PrettyTerm - это мощная Nim библиотека, которая предоставляет инструменты для создания стилизованных и красивых терминальных интерфейсов. Библиотека включает в себя:

  • 🎨 Поддержку ANSI цветов и стилей
  • 🎭 Систему тематизации с настраиваемыми цветами и иконками
  • 📝 Систему тегов для простой стилизации текста
  • 🌳 Древовидный принтер для структурированного вывода
  • 📊 Продвинутую систему логирования

Установка

nimble install prettyterm

Быстрый старт

import prettyterm

# Использование стилизованных строк
echo sty"<red>Красный текст</red> и <green|bold>жирный зеленый</green|bold>"

# Настройка тем
let config = newDisplayConfig()
# ... использование конфигурации

# Логирование
let logger = newLogger(newLogTime())
let component = newComponent("myfile.nim", "myFunction", "/path")
discard logger.addLog("Тестовое сообщение", component, Ok)

Основные возможности

🎨 Цвета и стили

Библиотека предоставляет полный набор ANSI цветов и стилей:

# Цвета текста
echo FgRed & "Красный текст" & ResetColor
echo FgGreen & "Зеленый текст" & ResetColor
echo FgBlue & "Синий текст" & ResetColor

# Цвета фона
echo BgYellow & "Текст на желтом фоне" & ResetColor

# Стили текста
echo styleBold & "Жирный текст" & ResetColor
echo styleItalic & "Курсивный текст" & ResetColor
echo styleUnderline & "Подчеркнутый текст" & ResetColor

🎭 Тематизация

Настраиваемая система тем для консистентного оформления:

# Создание цветовой темы
let customTheme = newColorTheme(
  hintColor = clrBlue,
  errorColor = clrRed,
  successColor = clrGreen,
  warningColor = clrYellow
)

# Создание темы иконок
let customIcons = newIconsTheme(
  hintIcon = "💡",
  errorIcon = "❌",
  successIcon = "✅",
  warningIcon = "⚠️"
)

# Создание конфигурации отображения
let config = newDisplayConfig(
  colorTheme = customTheme,
  iconsTheme = customIcons
)

📝 Стилизация текста

Простой и интуитивный синтаксис с тегами:

# Простые теги
echo sty"<red>Красный текст</red>"
echo sty"<green|bold>Жирный зеленый</green|bold>"

# Комбинация стилей
echo sty"<blue|underline|bg-yellow>Синий подчеркнутый на желтом фоне</blue|underline|bg-yellow>"

# Интерполяция переменных
let name = "Мир"
let value = 42
echo sty"Привет, <green>{name}</green>! Значение: <yellow|bold>{value}</yellow|bold>"

🌳 Древовидный вывод

Структурированный вывод данных с поддержкой ветвления:

# Создание корневой ветки
let root = newBranch("Анализ проекта")

# Добавление подветок
let lex = root.enterBranch("Лексический анализ")
echo lex.formatBranchLine("Токенизация завершена")

let syntax = lex.enterBranch("Синтаксический анализ")
echo syntax.formatBranchLine("Построение AST")

# Вывод таблиц
echo syntax.formatTableHeader("Результаты")
echo syntax.formatTableLine("Успешно: 100%")
echo syntax.formatTableFooter()

# Вывод кода с нумерацией строк
echo syntax.formatTableCodeMultiLine(1, """
proc hello() =
  echo "Hello, World!"
""")

📊 Логирование

Мощная система логирования с различными стилями вывода:

# Создание логгера
let logger = newLogger(
  creationTime = newLogTime(),
  printableInTerminal = true
)

# Создание компонента
let component = newComponent(
  fileName = "main.nim",
  funcName = "main",
  dirPath = "/src"
)

# Добавление логов
logger.style = loggerStyleTiny
discard logger.addLog("Приложение запущено", component, Ok)

logger.style = loggerStyleFull
discard logger.addLog("Ошибка подключения к базе данных", component, Error)

# Завершение работы с сохранением в файл
logger.destroyLogger("./app.log", writeToFile = true)

Структура проекта

prettyterm/
├── prettyterm.nimble    # Nimble package file
├── src/                 # package source
│   ├── prettyterm.nim   # Main module
│   │   source/          # All source files
│   │   ├── colors.nim       # ANSI colors and styles
│   │   ├── commonTypes.nim  # Basic types
│   │   ├── themeConfig.nim  # Theme configuration
│   │   ├── stylish.nim      # Text styling
│   │   ├── treePrinter.nim  # Tree printer
│   │   └── prettyLogger.nim # Logging system
├── LICENSE              # MIT license
└── README.md           # Documentation
└── README.ru.md        # Russion version Documentation

Требования

  • Nim >= 1.6.0
  • Современный терминал с поддержкой ANSI escape-кодов и юникода

Лицензия

MIT License - см. файл LICENSE

Автор

CodeLibraty Foundation

Вклад в проект

Мы приветствуем вклад в развитие проекта! Пожалуйста, создайте issue или pull request для предложений по улучшению.