Разработка и Git

Запустить форматтеры проекта

Определяет Ruff, Black, Prettier или gofmt и по умолчанию только проверяет форматирование.

Shell Linux macOS Новичок
Скачать format-runner.sh
Описание

Что делает скрипт

Скрипт смотрит на файлы проекта и доступные команды, затем запускает подходящий форматтер в режиме проверки. Только флаг --apply переписывает файлы. Если инструмент не установлен, шаг пропускается с понятным сообщением.

Перед запуском
  • С флагом --apply форматтеры изменят файлы. Сначала проверьте diff.
Запуск

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

bash format-runner.sh --path .

Скачайте файл, откройте терминал в папке со скриптом и выполните команду.

Примеры

Другие варианты

  • bash format-runner.sh --path .
  • bash format-runner.sh --path ./src --apply
  • bash format-runner.sh --path . --tool ruff
Зависимости

Что понадобится

Bash 4+ Стандартные find, sed, sort и awk
Linux sudo apt install bash
macOS brew install bash
Python 3.10+ Нужен для установки Ruff и Black
Linux sudo apt install python3
macOS brew install python
Ruff Форматирование и проверка Python
Linux python3 -m pip install ruff
macOS python3 -m pip install ruff
Black Используется, если Ruff не установлен
Linux python3 -m pip install black
macOS python3 -m pip install black
Node.js 20+ Нужен для Prettier
Linux sudo apt install nodejs npm
macOS brew install node
Prettier Форматирование JS, TS, JSON и Markdown
Linux sudo npm install -g prettier
macOS npm install -g prettier
Go 1.22+ Нужен только для gofmt
Linux sudo apt install golang-go
macOS brew install go
Исходник

format-runner.sh

#!/usr/bin/env bash
set -euo pipefail

usage() {
    cat <<'EOF'
Использование: format-runner.sh [--path ПАПКА] [--tool auto|ruff|black|prettier|gofmt] [--apply]
Без --apply выполняется только проверка.
EOF
}

path="."
tool="auto"
apply=0
status=0
ran=0

while [[ $# -gt 0 ]]; do
    case "$1" in
        --path) path="${2:-}"; shift 2 ;;
        --tool) tool="${2:-}"; shift 2 ;;
        --apply) apply=1; shift ;;
        -h|--help) usage; exit 0 ;;
        *) echo "Неизвестный аргумент: $1" >&2; usage >&2; exit 2 ;;
    esac
done

[[ -d "$path" ]] || { echo "Папка не найдена: $path" >&2; exit 2; }

has_python=0
[[ -f "$path/pyproject.toml" ]] && has_python=1
if [[ "$has_python" -eq 0 ]]; then
    python_file="$(find "$path" -type f -name '*.py' -print 2>/dev/null | sed -n '1p')"
    [[ -n "$python_file" ]] && has_python=1
fi

run_ruff() {
    if ! command -v ruff >/dev/null 2>&1; then
        echo "Ruff не установлен, шаг пропущен."
        return 0
    fi
    ran=$((ran + 1))
    echo "Ruff:"
    if [[ "$apply" -eq 1 ]]; then
        ruff format "$path" || status=1
    else
        ruff format --check "$path" || status=1
    fi
}

run_black() {
    if ! command -v black >/dev/null 2>&1; then
        echo "Black не установлен, шаг пропущен."
        return 0
    fi
    ran=$((ran + 1))
    echo "Black:"
    if [[ "$apply" -eq 1 ]]; then
        black "$path" || status=1
    else
        black --check "$path" || status=1
    fi
}

run_prettier() {
    if ! command -v prettier >/dev/null 2>&1; then
        echo "Prettier не установлен, шаг пропущен."
        return 0
    fi
    ran=$((ran + 1))
    echo "Prettier:"
    if [[ "$apply" -eq 1 ]]; then
        prettier --write "$path" || status=1
    else
        prettier --check "$path" || status=1
    fi
}

run_gofmt() {
    if ! command -v gofmt >/dev/null 2>&1; then
        echo "gofmt не установлен, шаг пропущен."
        return 0
    fi
    ran=$((ran + 1))
    echo "gofmt:"
    if [[ "$apply" -eq 1 ]]; then
        gofmt -w "$path" || status=1
    else
        local files
        files="$(gofmt -l "$path")"
        if [[ -n "$files" ]]; then
            echo "$files"
            status=1
        fi
    fi
}

case "$tool" in
    auto)
        if [[ "$has_python" -eq 1 ]]; then
            if command -v ruff >/dev/null 2>&1; then
                run_ruff
            elif command -v black >/dev/null 2>&1; then
                run_black
            else
                echo "Python-файлы найдены, но Ruff и Black не установлены."
            fi
        fi
        if [[ -f "$path/package.json" ]]; then
            run_prettier
        fi
        if [[ -f "$path/go.mod" ]]; then
            run_gofmt
        fi
        ;;
    ruff) run_ruff ;;
    black) run_black ;;
    prettier) run_prettier ;;
    gofmt) run_gofmt ;;
    *) echo "Неизвестный инструмент: $tool" >&2; exit 2 ;;
esac

echo
if [[ "$ran" -eq 0 ]]; then
    echo "Подходящие форматтеры не найдены."
elif [[ "$status" -eq 0 ]]; then
    echo "Проверка форматирования пройдена."
else
    echo "Есть файлы, требующие форматирования." >&2
fi
exit "$status"

Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.

CLI 1.0.0

Скачать без браузера

Команда скачает этот файл в текущую папку. CLI работает на Windows, macOS и Linux.

scriptdock get dev-format-runner
  • Поиск по всему каталогу
  • Python 3.10+
  • Без внешних пакетов
Скачать CLI

GUI-версия готовится. Подробнее

Категория

Разработка и Git

Git, сборка, тесты, зависимости, логи и обслуживание проектов.