NAME

ru-perltidy - утилита для форматирования файлов perltidy с определением их кодировки.

VERSION

Version 0.03

SYNOPSIS

ru-perltidy [-h] [--man] [<files> ...] [--ext exts] [--in-branch]

DESCRIPTION

Форматирует файлы через perltidy c определением их кодировки.

Есть 3 основные режима работы:

# Отформатировать все изменённые, но ещё не закомиченные файлы:
$ ru-perltidy

# Отформатировать изменённые и закомиченные файлы в ветке (branch-е):
$ ru-perltidy --branch

# Отформатировать указанные файлы:
$ ru-perltidy file1 /root/file2

С помощью опции -e (--ext) можно указать расширения файлов для форматирования (по умолчанию это pm,pl,plx,t,):

$ ru-perltidy -e pm,,t

Обратите внимание на пустое расширение — оно используется для исполняемых скриптов perl, которые расширения не имеют. При наличие такого расширения будет проверяться так же первая строка файла регуляркой /^#!.*?\bperl\b/.

Так же можно указать кодировки и порядок в котором они будут проверяться:

$ ru-perltidy -n cp1251,utf-8

LEGENDS

На консоль утилита выведет файлы, которые были изменены с указанием:

equals — код в файле совпадает с отформатированным perltidy.

tidied — код в файле отформатирован perltidy.

failed — что-то пошло не так.

В случае, если хоть один из файлов failed, код завершения процесса будет равен 1.

OPTIONS

-h, --help

Показать помощь и выйти.

--man

Распечатать мануал и завершиться.

-e exts, --ext exts

Список расширений через запятую.

По умолчанию: pm,pl,t,.

Пустое расширение обозначает файлы без расширений.

-n encodings, --encodings encodings

Список кодировок через запятую.

По умолчанию берётся из переменной окружения RU-ENCODINGS, а если она пуста, равняется: utf-8,cp1251,koi8-r.

-b, --in-branch

Форматировать изменённые и закомиченные файлы в ветке (branch-е).

ARGS

files...

Файлы или директории с файлами, которые нужно отформатировать.

LICENSE

⚖ GPLv3

AUTHOR

Yaroslav O. Kosmina <darviarush@mail.ru>