Шаблон Shell-скрипта

Современный шаблон Bash-скрипта с цветным форматированием вывода и вспомогательными функциями для создания профессиональных утилит командной строки.

Возможности

• 🎨 Цветной вывод: Предопределённые цветовые схемы и функции форматирования
• 📝 Стандартизированные сообщения: Единый формат информационных, успешных, предупреждающих и ошибочных сообщений
• 🔧 Вспомогательные функции: Готовые к использованию функции для распространённых операций в shell-скриптах
• 📦 Модульный дизайн: Отдельный файл библиотеки для удобного повторного использования в разных проектах
• ⚡ Простая настройка: Простой механизм подключения для немедленного использования

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

1. Клонируйте или скачайте этот шаблон
2. Сделайте скрипт исполняемым:
   root@kitploit:~

   chmod +x script.sh
   

3. Запустите пример скрипта:
   root@kitploit:~

   ./script.sh
   

Использование

Базовая структура шаблона

#!/bin/bash

LIB="lib"
source $LIB/format.sh

section "Заголовок вашего раздела"
info "Информационное сообщение"
ok "Сообщение об успехе" 
warn "Предупреждение"
error "Сообщение об ошибке"

Доступные функции

Типы сообщений

• info "сообщение" - Отображает информационные сообщения с префиксом [i] голубым цветом
• ok "сообщение" - Отображает сообщения об успехе с префиксом [+] зелёным цветом
• warn "сообщение" - Отображает предупреждения с префиксом [!] жёлтым цветом
• error "сообщение" - Отображает сообщения об ошибках с префиксом [-] красным цветом (отправляется в stderr)

Интерактивные функции

• prompt "вопрос" - Отображает запрос с префиксом [?] пурпурным цветом и ожидает ввод пользователя
• section "заголовок" - Создаёт форматированный заголовок раздела

Форматирование текста

• bold "текст" - Отображает текст жирным шрифтом

Цветовые константы

Для пользовательского форматирования доступны следующие цветовые константы:

RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
MAGENTA='\033[0;35m'
CYAN='\033[0;36m'
WHITE='\033[1;37m'
BOLD='\033[1m'
UNDERLINE='\033[4m'
RESET='\033[0m'

Пример вывода

При запуске примера скрипта вы увидите:

=== Start ===
[i] Running exploit setup...
[+] Everything is ready
[!] This might break your system
[-] Something failed
[?] Continue? [y/N]:

Структура файлов

shell_template/
├── script.sh          # Пример скрипта, демонстрирующий использование
├── lib/
│   └── format.sh       # Основная библиотека форматирования
├── LICENSE             # Лицензия MIT
└── README.md          # Этот файл

Настройка

Добавление новых типов сообщений

Вы можете расширить библиотеку, добавив новые типы сообщений в lib/format.sh:

DEBUG="${BLUE}[D]${RESET}"
debug() { echo -e "${DEBUG} $*"; }

Пользовательские цвета

Определите собственные цветовые схемы, изменив цветовые константы или создав новые:

PURPLE='\033[0;35m'
CUSTOM_PREFIX="${PURPLE}[*]${RESET}"
custom() { echo -e "${CUSTOM_PREFIX} $*"; }

Рекомендации

1. Всегда подключайте библиотеку: Включайте source $LIB/format.sh в начале ваших скриптов
2. Используйте подходящие типы сообщений: Выбирайте правильную функцию в зависимости от контекста (info, ok, warn, error)
3. Структурируйте вывод с помощью разделов: Используйте section для организации вывода скрипта
4. Обрабатывайте ошибки корректно: Используйте error для сообщений об ошибках и перенаправляйте их в stderr
5. Делайте скрипты исполняемыми: Не забывайте chmod +x для ваших скриптов

Участие в разработке

Не стесняйтесь сообщать об ошибках, форкать репозиторий и создавать pull-запросы с любыми улучшениями.

Лицензия

Этот проект лицензирован в соответствии с MIT License — подробности см. в файле LICENSE.

Автор

Создано Christoph Huy