NAME

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

VERSION

Version 0.06

SYNOPSIS

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

DESCRIPTION

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

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

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

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

# Обработать файлы в директориях:
$ ru-perltidy --in-dir .,/tmp/mydir

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

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

$ ru-perltidy -e pm,t

А для файлов, которые расширений не имеют, можно указать список интерпретаторов, указываемых в первой строке скрипта (#!/usr/bin/env perl):

$ ru-perltidy -i perl,perl5

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

$ ru-perltidy -n cp1251,utf-8

LEGENDS

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

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

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

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

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

OPTIONS

-h, --help

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

--man

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

-e exts, --ext exts

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

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

Пустая строка обозначает любые расширения.

-i interpreters, --interpreters interpreters

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

По умолчанию: perl,perl5.

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

-n encodings, --encodings encodings

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

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

-b, --in-branch

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

-d dirs, --in-dir dirs

Форматировать изменённые и закомиченные файлы в директориях. Директории через запятую.

ARGS

files...

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

LICENSE

⚖ GPLv3

AUTHOR

Yaroslav O. Kosmina <darviarush@mail.ru>