tidyallp - Интернет в облаке

ПРОГРАММА:

ИМЯ

tidyall - Ваш универсальный инструмент для проверки и проверки кода

СИНТАКСИС

# Создайте tidyall.ini или .tidyallrc в верхней части вашего проекта
#
[Перлтиди]
select = ** / *. {pl, pm, t}
argv = -noll -it = 2

[ПерлКритик]
выберите = lib / ** / *. pm
ignore = lib / UtterHack.pm
argv = - серьезность 3

# Обработать все файлы в текущем проекте,
# смотреть вверх от cwd для файла conf
#
% тидиалл -а

# Обработать один или несколько конкретных файлов,
# ищем conf файл вверх от первого файла
#
% tidyall файл [файл ...]

# Рекурсивная обработка каталога
#
% tidyall -r каталог

ОПИСАНИЕ

Есть много отличных инструментов для проверки кода и валидаторов. "tidyall" делает их
доступны из единого унифицированного интерфейса.

Вы можете запустить tidyall для одного файла или для всей иерархии проекта и настроить
какие тидеры / валидаторы применяются к каким файлам. "tidyall" будет создавать резервные копии файлов
заранее, и для эффективности будут рассматривать только файлы, которые были изменены с момента их
последний обработанный.

какой a аккуратнее? какой a валидатор?
A аккуратнее преобразует файл, чтобы улучшить его внешний вид без изменения его семантики.
Примеры включают perltidy, podtidy и js-beautify.
украсить>.

A валидатор анализирует файл для определения правильности. Примеры включают
perlcritic, podchecker и jshinthttp://www.jshint.com/>.

Многие tidiers также являются валидаторами, например, "perltidy" выдаст ошибку на плохо сформированном
Перл.

Чтобы использовать tidier или валидатор с tidyall, у него должен быть соответствующий класс плагина,
обычно под префиксом «Code :: TidyAll :: Plugin ::». Этот дистрибутив поставляется с плагинами
для:

· Perl: перлкритический, перлтиди-сладкий

· Под: подчекер, подспелл, подтиды

· Каменщик: масонтиды

· JavaScript: js-beautify, jshint, jslint

· JSON: JSON

· CSS: cssunminifier

· PHP: PHPS

· Разное: Code :: TidyAll :: Plugin :: SortLines

См. Code :: TidyAll :: Plugin для получения информации о создании собственного плагина.

С ПОМОЩЬЮ ТИДЬЯЛЛ

"tidyall" работает на основе проекта, где проект представляет собой просто иерархию каталогов
файлы. Рабочие каталоги svn или git являются типичными примерами проектов.

Вершина проекта называется корень каталог. В корневом каталоге вам понадобится
файл конфигурации с именем "tidyall.ini" или ".tidyallrc"; он определяет, как различные тидеры и
валидаторы будут применены к файлам в вашем проекте.

"tidyall" найдет ваш корневой каталог и файл конфигурации автоматически в зависимости от того, как вы
назови это:

"tidyall файл [файл ...]"
"tidyall" будет искать файл conf вверх от первого файла.

"tidyall -p / - файл трубы"
"tidyall" будет искать файл conf вверх от указанного файла.

"tidyall -a / - all" или "tidyall -s / - svn" или "tidyall -g / - git"
"tidyall" будет искать файл conf вверх от текущего рабочего каталога.

"tidyall -a --root-dir dir"
"tidyall" ожидает найти файл conf в указанном корневом каталоге.

Вы также можете передать --conf-name, чтобы изменить имя, которое ищется, или --conf-file на
указать явный путь.

КОНФИГУРАЦИЯ

Конфигурационный файл ("tidyall.ini" или ".tidyallrc") находится в формате Config :: INI. Вот
образец:

[Перлтиди]
select = ** / *. {pl, pm, t}
argv = -noll -it = 2

[ПерлКритик]
выберите = lib / ** / *. pm
ignore = lib / UtterHack.pm lib / OneTime / *. pm
argv = - серьезность 3

[ПодТиди]
select = lib / ** / *. {pm, pod}

По порядку в трех разделах объявляется:

· Примените «PerlTidy» с настройками «-noll -it = 2» ко всем файлам * .pl, * .pm и * .t.

· Примените «PerlCritic» с уровнем серьезности 3 ко всем модулям Perl где-нибудь под «lib /»,
кроме "lib / UtterHack.pm".

· Примените «PodTidy» с настройками по умолчанию ко всем файлам * .pm и * .pod, расположенным под «lib /».

Стандарт конфигурация элементы
[класс] или [описание класса]
Заголовок каждого раздела относится к тидиаллу. плагин. Имя автоматически
с префиксом "Code :: TidyAll :: Plugin ::", если он не начинается с '+', например

; Использует плагин Code :: TidyAll :: Plugin :: PerlTidy
;
[Перлтиди]

; Использует плагин My ​​:: TidyAll :: Plugin
;
[+ My :: TidyAll :: Плагин]

Вы также можете включить необязательное описание после класса. Описание будет
игнорируется, и для плагина будет использоваться только первое слово. Это позволяет вам список
плагин более одного раза, каждый раз с разной конфигурацией. Например, два
различные конфигурации "PerlCritic":

; Будьте суровы с библиотеками
;
[PerlCritic строгий]
выберите = lib / ** / *. pm
argv = --жестокий

; но нежно по сценариям
;
[PerlCritic снисходителен]
выберите = bin / ** / *. pl
argv = - нежный

Предупреждение: если вы просто укажете один и тот же плагин дважды без описания (или одного и того же
description), один из них будет автоматически проигнорирован.

выберите
Один или несколько шаблонов File :: Zglob, разделенных пробелом или на нескольких строках,
с указанием, какие файлы выбрать. Требуется хотя бы один. например

; Все .t и .pl где-то под bin и t;
; плюс все файлы .pm прямо в lib / Foo и lib / Bar
;
select = {bin, t} / ** / *. p [лм]
select = lib / {Foo, Bar} / *. pm

; Все файлы .txt в любом месте проекта
;
выберите = ** / *. txt

Шаблон относится к корневому каталогу и не должен иметь косой черты в начале. Все
стандартные символы glob ("*", "?", "[]", "{}") будут работать; кроме того, "**" может быть
используется для представления нуля или более каталогов. См. Документацию File :: Zglob для получения дополнительной информации.
Детали.

игнорировать
Один или несколько шаблонов File :: Zglob, разделенных пробелом или на нескольких строках,
с указанием, какие файлы игнорировать. Это необязательно и отменяет "выбор". например

; Все файлы .pl где угодно в bin, кроме bin / awful.pl или где угодно
; под bin / tmp
;
выберите = bin / ** / *. pl
игнорировать = bin / awful.pl bin / tmp / ** / *. pl

притон
Одно или несколько слов, разделенных пробелом или на нескольких строках, указывающих, какие
строки shebang для принятия. Это необязательно, и дальнейшие фильтры «выбирают». например

; Все файлы без расширения где-либо в bin, которые включают "perl" или
; "perl5" линия shebang.
выберите = корзина / ** / *
игнорировать = bin /**/*.*
шебанг = perl perl5

только_режимы
Список режимов, разделенных пробелом. например

only_modes = тестовый кли

Плагин будет только запускается, если один из этих режимов передан в "tidyall" через "-m" или
"--Режим".

кроме режимов
Список режимов, разделенных пробелом. например

except_modes = редактор фиксации

Плагин будет не запускается, если один из этих режимов передан в "tidyall" через "-m" или
"--Режим".

ARGV
Многие плагины (такие как perltidy, perlcritic и podtidy) используют эту опцию, которая
указывает аргументы для передачи базовой утилите командной строки.

вес
Это целое число, которое используется для сортировки плагинов. По умолчанию сначала запускаются более аккуратные плагины,
затем плагины валидатора с сортировкой каждой группы в алфавитном порядке.

PLUGIN ЗАКАЗАТЬ И АТОМИЧНОСТЬ

Если несколько плагинов соответствуют файлу, тидеры применяются перед валидаторами, чтобы валидаторы
проверяем окончательный результат. Внутри этих двух групп плагины применяются в
в алфавитном порядке по названию / описанию плагина.

Вы также можете явно указать вес каждого плагина. По умолчанию тидиры имеют вес
50, а у валидаторов - 60. Вы можете установить любое целое число, чтобы
влиять на работу плагина.

Применение нескольких плагинов по принципу «все или ничего». Если во время
приложение любого плагина, файл вообще не модифицируется.

КОМАНДНАЯ СТРОКА ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

-а, --все
Обработать все файлы. Выполняет рекурсивный поиск всех файлов в иерархии проекта,
начиная с корня, и обрабатывает любой файл, который соответствует хотя бы одному плагину в
конфигурации.

-г, --гит
Обработать все добавленные или измененные файлы в текущем рабочем каталоге git.

-х, --помощь
Распечатать справочное сообщение

-л, --список
Перечислите каждый файл вместе со списком плагинов, которым он соответствует (файлы без совпадений
пропускаются). Фактически не обрабатывает файлы и не заботится о том,
кешировано. Обычно используется с -a, -g или -seg

% тидиалл -a -l
lib / CHI.pm (PerlCritic, PerlTidy, PodTidy)
lib / CHI / Benchmarks.pod (PodTidy)
lib / CHI / CacheObject.pm (PerlCritic, PerlTidy, PodTidy)

-м, --режим
Дополнительный режим, который может повлиять на то, какие плагины запускаются. По умолчанию "cli". См. «РЕЖИМЫ».

-p путь, --pipe путь
Прочтите содержимое из STDIN и запишите полученный контент в STDOUT. В случае успеха
tidyall завершает работу со статусом 0. Если возникает ошибка, tidyall выводит сообщение об ошибке в
СТДЕРР, Зеркала домен вход содержание в STDOUT без изменений и выйдет со статусом 1.
Зеркальное отображение означает, что вы можете безопасно направить трубку к месту назначения независимо от того,
возникает ошибка.

При указании этой опции вы должны указать ровно одно имя файла, относительное или
absolute, который будет использоваться для определения того, какие плагины применять, а также где
корневой каталог и файл конфигурации. Файл на самом деле не читается и делает
нужно даже нужно существовать.

Этот параметр подразумевает --no-backups и --no-cache (так как настоящего файла нет) и
--quiet (поскольку мы не хотим смешивать посторонний вывод с приведенным в порядок результатом).

# Чтение из STDIN и запись в STDOUT с соответствующими плагинами
# для некоторых / path.pl (которые могут не существовать)
#
% tidyall --pipe some / path.pl

-r, --рекурсивный
Рекурсивно вводить любые каталоги, перечисленные в командной строке, и обрабатывать все файлы
в. По умолчанию каталоги, обнаруженные в командной строке, будут генерировать
предупреждение.

-с, --свн
Обработать все добавленные или измененные файлы в текущем рабочем каталоге svn.

-к, --тишина
Подавить вывод, кроме ошибок.

-v, --подробный
Показать дополнительный вывод.

-I путь1, путь2, ...
Добавьте один или несколько путей к библиотекам в @INC, например Perl -I. Полезно, если --tidyall-class или
плагины находятся в альтернативном каталоге lib.

--backup-ttl продолжительность
Время, по истечении которого файлы резервных копий могут быть очищены. Может быть числом секунд или любым
строка, распознаваемая Time :: Duration :: Parse, например, "4h" или "1day". По умолчанию «1ч».

- только проверка
Вместо того, чтобы на самом деле приводить в порядок файлы, проверьте, убран ли каждый файл (т.е.
version совпадает с текущей версией), и если нет, то считайте это ошибкой. Это используется
с помощью Test :: Code :: TidyAll и хуков предварительной фиксации svn и git, например, для обеспечения
что вы привели в порядок свои файлы.

--conf-файл путь
Укажите относительный или абсолютный путь к файлу conf вместо поиска его в
обычный способ.

--conf-имя имя
Укажите имя файла conf для поиска вместо значений по умолчанию ("tidyall.ini" /
".tidyallrc").

--data-каталог путь
Содержит такие данные, как резервные копии и кеш. По умолчанию root_dir / .tidyall.d

--итерации считать
Выполните каждое более аккуратное преобразование считать раз. По умолчанию 1.

В некоторых случаях (надеюсь, редко) результат более аккуратного может быть другим, если он
применяется несколько раз. Вы можете выполнить несколько итераций, чтобы убедиться, что
содержание "оседает" в своей окончательной упорядоченной форме - особенно, если порядок
принудительно с помощью ловушки управления версиями или теста. Конечно, производительность пострадает.
маленький. Вам редко нужно устанавливать это значение выше 2.

Это влияет только на тидеры, но не на валидаторы; например, perlcritic и jshint все равно
запускаться только один раз.

- нет резервных копий
Не создавайте резервные копии файлов перед обработкой.

--без кеша
Не кэшировать время последней обработки; обрабатывать все файлы каждый раз. Смотрите также
"--refresh-cache".

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

--обновить-кэш
Удалите любую существующую информацию кеша перед обработкой каждого файла, затем запишите новую информацию кеша.
См. Также «--no-cache».

--root-каталог
Явно укажите корневой каталог. Обычно это выводится из указанных файлов
или текущий рабочий каталог.

--tidyall-класс класс
Подкласс для использования вместо Code :: TidyAll.

Указание кредита in конфигурация
Практически любой параметр командной строки можно указать в верхней части файла конфигурации, над
разделы плагинов. Замените тире подчеркиванием. например

backup_ttl = 4 ч.
итераций = 2
tidyall_class = Мой :: Код :: TidyAll

[Перлтиди]
select = ** / *. {pl, pm, t}
argv = -noll -it = 2

...

Если параметр передается в обоих местах, командная строка имеет приоритет.

ВЫХОД статус

"tidyall" выйдет со статусом 1, если при обработке файлов произошли какие-либо ошибки, и 0
в противном случае.

РЕЖИМЫ

Вы можете использовать tidyall в разных контекстах, и вы можете не захотеть запускать все
плагины во всех из них.

Вы можете передать режим tidyall с помощью «-m» или «--mode», а затем указать, что определенные плагины
должен запускаться только в определенных режимах (через "only_modes") или должен выполняться во всех, кроме определенных
режимы (через "except_modes").

Примеры режимов:

· "Cli" - при явном вызове tidyall из командной строки без указания режима

· «Редактор» - при вызове из редактора

· "Commit" - при использовании ловушки фиксации, такой как Code :: TidyAll :: SVN :: Precommit или
Код :: TidyAll :: Git :: Precommit

· «Тест» - при использовании Test :: Code :: TidyAll

Теперь, поскольку perlcritic занимает немного времени, вы можете запускать его только во время тестов.
и явный вызов из командной строки:

[ПерлКритик]
выберите = lib / ** / *. pm
only_modes = тестовый кли
...

Или вы можете указать, что он будет работать во всех режимах кроме редактор:

[ПерлКритик]
выберите = lib / ** / *. pm
except_modes = редактор
...

Если вы не укажете для плагина ни "only_modes", ни "except_modes", он всегда будет
бежать.

ОБРАБОТАННЫЕ ПОСЛЕДНИЕ КЭШ

"tidyall" отслеживает подпись каждого файла после его последней обработки. На последующих
запускается, он будет обрабатывать файл только в том случае, если его подпись изменилась. Кеш хранится в файлах
под директорией data.

Вы можете принудительно обновить кеш с помощью "--refresh-cache" или отключить поведение
полностью с "--no-cache".

BACKUPS

"tidyall" сделает резервную копию каждого файла перед его изменением. Резервные копии с метками времени хранятся в
отдельная иерархия каталогов в каталоге данных.

Старые файлы резервных копий будут автоматически очищаться при периодическом запуске "tidyall". В
продолжительность, указанная в "--backup-ttl", указывает минимальное время резервного копирования
должна быть сохранена, а частота продувки должна выполняться. Может быть указано как "30м".
или «4 часа» или любая строка, приемлемая для Time :: Duration :: Parse. По умолчанию это "1ч" (1
час).

Вы можете отключить резервное копирование с помощью «--no-backups».

"ОТСУТСТВУЕТ" ПРЕДПОСЫЛКИ

Распределение "Code :: TidyAll" намеренно не зависит от предварительных требований, необходимых для
каждый плагин. Это означает, что если вы хотите использовать perltidy, вы должны установить
Модуль Perl :: Tidy вручную.

В СВЯЗИ ИНСТРУМЕНТЫ

· Etc / editors / tidyall.el
tidyall / master / etc / editors / tidyall.el> и etc / editors / tidyall.vim

в этом дистрибутиве содержатся команды Emacs и Vim для запуска "tidyall" на
текущий буфер. Вы можете назначить это нажатию клавиши по вашему выбору (например, ctrl-t или
, т).

· Code :: TidyAll :: SVN :: Precommit реализует ловушку перед фиксацией subversion, которая проверяет,
все файлы приведены в порядок и действительны в соответствии с "tidyall", в противном случае отклоняет фиксацию.

· Code :: TidyAll :: Git :: Precommit и Code :: TidyAll :: Git :: Prereceive реализуют git pre-
обработчики фиксации и предварительного приема, соответственно, которые проверяют, все ли файлы приведены в порядок, и
действительно согласно "тидялл".

· Test :: Code :: TidyAll - это библиотека тестирования для проверки того, что все файлы в вашем проекте
находятся в опрятном и действующем состоянии.

KNOWN ОШИБКИ

· Пока не работает в Windows

Используйте tidyallp онлайн с помощью сервисов onworks.net