{"id":22606101,"url":"https://github.com/newyaroslav/consolix","last_synced_at":"2025-03-28T21:46:05.020Z","repository":{"id":266934382,"uuid":"897124322","full_name":"NewYaroslav/Consolix","owner":"NewYaroslav","description":"Consolix is a header-only C++ library providing components and utilities for developing console applications.","archived":false,"fork":false,"pushed_at":"2025-03-02T14:17:53.000Z","size":1050,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-02T15:25:50.156Z","etag":null,"topics":["ansi-colors","cli","configuration-management","console-application","console-applications","cp866","cpp","cpp17","cxxopts","header-only","library","logging","logging-library","logit","utf-8-support","utf8"],"latest_commit_sha":null,"homepage":"https://newyaroslav.github.io/Consolix/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NewYaroslav.png","metadata":{"files":{"readme":"README-RU.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-02T04:22:59.000Z","updated_at":"2025-03-02T14:17:35.000Z","dependencies_parsed_at":"2024-12-07T05:17:59.507Z","dependency_job_id":"6278f491-fcd9-4429-a6ae-89354e5204c7","html_url":"https://github.com/NewYaroslav/Consolix","commit_stats":null,"previous_names":["newyaroslav/consolix"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NewYaroslav%2FConsolix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NewYaroslav%2FConsolix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NewYaroslav%2FConsolix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NewYaroslav%2FConsolix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NewYaroslav","download_url":"https://codeload.github.com/NewYaroslav/Consolix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246106660,"owners_count":20724400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansi-colors","cli","configuration-management","console-application","console-applications","cp866","cpp","cpp17","cxxopts","header-only","library","logging","logging-library","logit","utf-8-support","utf8"],"created_at":"2024-12-08T14:12:29.586Z","updated_at":"2025-03-28T21:46:05.001Z","avatar_url":"https://github.com/NewYaroslav.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Consolix\n\n```bash\n   █████████                                       ████   ███             \n  ███░░░░░███                                     ░░███  ░░░              \n ███     ░░░   ██████  ████████    █████   ██████  ░███  ████  █████ █████\n░███          ███░░███░░███░░███  ███░░   ███░░███ ░███ ░░███ ░░███ ░░███ \n░███         ░███ ░███ ░███ ░███ ░░█████ ░███ ░███ ░███  ░███  ░░░█████░  \n░░███     ███░███ ░███ ░███ ░███  ░░░░███░███ ░███ ░███  ░███   ███░░░███ \n ░░█████████ ░░██████  ████ █████ ██████ ░░██████  █████ █████ █████ █████\n  ░░░░░░░░░   ░░░░░░  ░░░░ ░░░░░ ░░░░░░   ░░░░░░  ░░░░░ ░░░░░ ░░░░░ ░░░░░ \n```\n\n**Consolix** — это `header-only` C++ библиотека, предоставляющая компоненты и утилиты для разработки консольных приложений.\n\n## Особенности\n\n- **Компонентная архитектура:** Легко подключаемые модули, такие как логирование, управление конфигурациями и обработка командной строки.\n- **Глобальный локатор сервисов:** Удобный механизм для управления зависимостями и сервисами.\n- **Поддержка UTF-8:**\n\t- Заголовок программы (`TitleComponent`) поддерживает установку текста в `UTF-8` с автоматической конвертацией в `UTF-16` для Windows и использованием `ANSI escape` последовательностей на POSIX-системах.\n\t- Вывод в консоль (`LoggerComponent`) поддерживает `UTF-8` с автоматической конвертацией в `CP866` на Windows для совместимости с устаревшими кодировками.\n- **Кастомизируемые циклы выполнения:** Поддержка структурированных циклов для выполнения пользовательских задач.\n- **Расширенное логирование:** Интеграция с [LogIt](https://github.com/NewYaroslav/log-it-cpp).\n- **Поддержка JSON с комментариями:** Загрузка конфигураций JSON с комментариями благодаря [nlohmann/json](https://github.com/nlohmann/json).\n- **Кроссплатформенность:** Работа на Windows и POSIX-совместимых системах. *(Для POSIX не протестировано)*.\n- **Совместимость с C++17:** Требует компилятора с поддержкой стандарта C++17 (GCC 7.1+, Clang 5.0+, MSVC 15.3+).\n\n## Установка\n\n**Consolix** — это `header-only` библиотека. Для начала работы просто добавьте её в ваш проект:\n\n1. Скачайте библиотеку или клонируйте репозиторий:\n   ```bash\n   git clone https://github.com/yourusername/Consolix.git\n   ```\n   \n2. Добавьте путь к заголовочным файлам в настройки вашего проекта:\n    ```\n    Consolix/include\n    ```\n\n3. Подключите заголовок в вашем коде:\n    ```\n    #include \u003cconsolix/consolix.hpp\u003e\n    ```\n    \n### Зависимости\n\nConsolix поддерживает интеграцию с внешними библиотеками через макросы, которые можно включать или отключать в зависимости от ваших нужд:\n\n- **LogIt** (включается через устанвоку макроса `CONSOLIX_USE_LOGIT 1`):\n    - Используется для логирования.\n    - LogIt на [GitHub](https://github.com/NewYaroslav/log-it-cpp.git).\n    - Зависит от библиотеки [time-shield](https://github.com/NewYaroslav/time-shield-cpp.git). \n    - Обе библиотеки являются *header-only*, поэтому достаточно добавить их заголовки в проект.\n- **cxxopts** (включается через устанвоку макроса `CONSOLIX_USE_CXXOPTS 1`):\n    - Используется для обработки аргументов командной строки.\n    - cxxopts на [GitHub](https://github.com/jarro2783/cxxopts.git).\n    - *header-only* библиотека.\n- **nlohmann/json** (включается через устанвоку макроса `CONSOLIX_USE_JSON 1`):\n    - Используется для работы с JSON, включая поддержку комментариев.\n    - nlohmann/json на [GitHub](https://github.com/nlohmann/json.git).\n    - *header-only* библиотека.\n\nЧтобы указать, какие зависимости использовать, задайте соответствующие макросы перед подключением Consolix:\n\n```cpp\n// Отключение LogIt и cxxopts, но включение nlohmann/json\n#define CONSOLIX_USE_LOGIT   0\n#define CONSOLIX_USE_CXXOPTS 0\n#define CONSOLIX_USE_JSON    1\n\n#include \u003cconsolix/consolix.hpp\u003e\n```\n\nДля включения зависимостей добавьте пути к их заголовкам в ваш проект:\n\n```\nlog-it-cpp/include\ntime-shield-cpp/include\ncxxopts/include\nnlohmann-json/include\n```\n\n## Пример использования\n\n```cpp\n#include \u003cconsolix/components.hpp\u003e\n\nint main(int argc, char* argv[]) {\n    // Добавление заголовка программы\n    consolix::add\u003cconsolix::TitleComponent\u003e(u8\"Consolix - консольное приложение\");\n\n    // Добавление логгера\n    consolix::add\u003cconsolix::LoggerComponent\u003e();\n\n    // Вывод ASCII-логотипа в консоль\n    consolix::add\u003cconsolix::LogoComponent\u003e(consolix::TextColor::DarkYellow);\n\n    // Обработка аргументов командной строки\n    consolix::add\u003cconsolix::CliComponent\u003e(\"MyApp\", \"Описание программы\", [](auto\u0026 options) {\n        options.add_options()(\"debug\", \"Включить режим отладки\");\n    }, argc, argv);\n\n    // Загрузка конфигурации из JSON\n    consolix::add\u003cconsolix::ConfigComponent\u003cMyConfig\u003e\u003e(\"config.json\");\n\n    // Выполнение главного цикла\n    consolix::run([]() {\n        CONSOLIX_STREAM() \u003c\u003c \"Выполнение главного цикла...\";\n    });\n\n    return 0;\n}\n```\n\n## Модули\n\n### Основные модули\n- **ServiceLocator:** Управление глобальными сервисами.\n- **ConsoleApplication:** Фреймворк для управления консольными приложениями.\n\n### Компоненты\n- **TitleComponent:** Управление заголовком окна консоли. Поддерживает UTF-8.\n- **LoggerComponent:** Централизованное логирование. Поддерживает UTF-8 с конвертацией в CP866.\n- **CliComponent:** Упрощённая работа с аргументами командной строки.\n- **ConfigComponent:** Работа с конфигурациями JSON с комментариями.\n- **LogoComponent:** Вывод ASCII-логотипов.\n- **LoopComponent:** Поддержка пользовательских циклов выполнения.\n\n### Утилиты\n- **path_utils.hpp:** Работа с путями и директориями.\n- **json_utils.hpp:** Удаление комментариев и работа с JSON.\n- **ColorManipulator.hpp:** Стилизация текста в консоли.\n\n## Документация\n\nПолная документация доступна [здесь](https://newyaroslav.github.io/Consolix/). Она включает руководство по установке, описания модулей, примеры использования и многое другое.\n\n## Лицензия\nConsolix распространяется под лицензией MIT. Полный текст лицензии доступен в файле LICENSE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewyaroslav%2Fconsolix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnewyaroslav%2Fconsolix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewyaroslav%2Fconsolix/lists"}