Изменен: 27.11.2024 09:09:02
Данное решение базируется на идеях проекта precommit1c, но является самостоятельным решением.
Указанным продуктом пользовались долгое время, он очень хорош, но потребность в развитии и невозможность реализации некоторых сценариев работы в публичной версии сподвигли к реализации нового решения.
Установка на компьютер стандартна
opm install precommit4onec илиПеред использованием необходима установка precommit-hook'а в репозиторий:
precommit4onec install repo_nameprecommit4onec install folder_reps -rПосле этого, при каждом коммите будет выполняться обработка файлов.
В комплекте присутствуют следующие сценарии обработки файлов:
РазборОтчетОбработокРасширений - при выполнении данного сценария, файлы внешних отчетов, обработок и расширений средствами платформы будут разложены на исходные файлы и помещены в каталог исходных файлов репозитория в подкаталоги, соответствующие расширениям. Например внешний отчет ВнешнийОтчет1.erf будет разложен в каталог src\erf\ВнешнийОтчет1РазборОбычныхФормНаИсходники - при выполнении данного сценария, файлы обычных форм (Form.bin) раскладываются на исходные файлы с помощью инструмента v8unpackКорректировкаXMLФорм - при выполнении данного сценария, файлы описаний форм (Form.xml) проверяются на наличие задублировавшихся индексов элементов, которые образуются при объединениях. Если дубли есть, то они исправляютсяДобавлениеПробеловПередКлючевымиСловами - при выполнении данного сценария, в файлах модулей перед ключевыми словами добавляются отсутствующие пробелы. На данный момент обрабатывается только ключевое слово Экспорт.УдалениеЛишнихКонцевыхПробелов - при выполнении данного сценария, в файлах модулей удаляются лишние пробелы и табы в конце не пустой строки.СортировкаДереваМетаданных - при выполнении данного сценария, выполняется упорядочивание объектов метаданных в дереве за исключением подсистем, они остаются в том порядке, который задал разработчик.СинхронизацияОбъектовМетаданныхИФайлов - анализирует наличие файлов и объектов конфигурации.УдалениеДублейМетаданных - удаляет задублированные объекты метаданных (результат кривого мерджа)ЗапретИспользованияПерейти - проверяет модуль на использование методов ПерейтиУдалениеЛишнихПустыхСтрок - выполняет очистку модуля от лишних пустых строк (лишними считаются 2 и более идущих подряд пустых строках)ПроверкаКорректностиОбластей - выполняет проверку на корректность скобок областей: на парность и перед окончание области должно быть ее определениеПроверкаДублейПроцедурИФункций - выполняет поиск одинаковых названий процедур и функций в модуле.ОтключениеПолнотекстовогоПоиска - По умолчанию отключает полнотекстовый поиск в файлах описания метаданных. Имеет настройку для исключения файлов из обработки. Для исключения необходимо указать относительный путь в репозитории до файла описания метаданного. Можно выключать из обработки отдельные реквизиты метаданного, для этого надо задать массив реквизитов в конфигурационном файле.ИсправлениеНеКаноническогоНаписания - Проверяет модули на каноничность написания ключевых слов и исправляет найденноеprecommit4onec может читать настройки своей работы из специального конфигурационного файла.
Управление настройками происходит с использованием команды configure:
precommit4onec configure -globalprecommit4onec configure -global -resetprecommit4onec configure -global -config.Предоставляется возможность в репозитории иметь свои, отличные от глобальных, настройки. Для этого необходимо вместо флага -global в указанных выше командах передавать параметр -rep-path с указанием пути к каталогу репозитория.
Также можно настроить различное поведение для различных каталогов репозитория, для работы с подкаталогами (проектами) используется ключ -child-path.
Настройки проектов полностью переопределяют базовые настройки. Например если в основной настройки указаны ОтключенныеСценарии,
а для проекта configuration\ они не заполнены, то для каталога configuration будут выполнены все сценарии.
Конфигурирование дает возможности:
Некоторые сценарии поддерживают возможность изменения своих настроек со значений по умолчанию на установленные в конфигурационном файле. На данный момент реализована возможность указывать необходимую версию платформы 1С:Предприятие в сценарии РазборОтчетОбработокРасширений.
{
"Precommt4onecСценарии": {
"ИспользоватьСценарииРепозитория": false, // Признак, выполнения проверок из репозитория
"КаталогЛокальныхСценариев": "", // Относительный путь к каталогу локальных проверок
"ГлобальныеСценарии": [...], // Список проверок, которые будут выполнятся
"ОтключенныеСценарии": [...], // Список проверок, которые не будут выполнятся (имеет больший приоритет относительно ГлобальныеСценарии)
"НастройкиСценариев": { // Настройки выполняемых проверок
...
},
"Проекты":{ // Настройки проектов (подкаталогов репозитория). Настройки проектов полностью переопределяют настройки и имеют такую же структуру
"configuration\\": { // Имя проекта (подкаталога)
"ИспользоватьСценарииРепозитория": false,
"ГлобальныеСценарии": []
}
}
}
}
Для создания нового сценария обработки файлов необходимо воспользоваться шаблоном, находящимся в каталоге СценарииОбработки скрипта.
Чтобы сценарий работал для всех репозиториев необходимо
СценарииОбработкиЧтобы сценарий работал в конкретном репозитории необходимо
tools\СценарииОбработкиЕсли при выполнении precommit4onec не найдет файлов сценариев в указанном каталоге, либо не найдет каталог, он об этом сообщит в лог и продолжит работу без ошибок.