Утилита для автоматической обработки исходных файлов конфигурации, внешних отчетов и обработок для платформы 1С:Предприятие при помещении в репозиторий git
Данное решение базируется на идеях проекта precommit1c, но является самостоятельным решением.
Указанным продуктом пользовались долгое время, он очень хорош, но потребность в развитии и невозможность реализации некоторых сценариев работы в публичной версии сподвигли к реализации нового решения.
Установка на компьютер стандартна
opm install precommit4onec
илиПеред использованием необходима установка precommit-hook'а в репозиторий:
precommit4onec install repo_name
precommit4onec install folder_reps -r
-source-dir "configuration"
После этого, при каждом коммите будет выполняться обработка файлов.
В комплекте присутствуют следующие сценарии обработки файлов:
ДобавлениеПробеловПередКлючевымиСловами
- добавляет отсутствующие пробелы перед ключевыми словами в файлах модулей. На данный момент обрабатывается только ключевое слово Экспорт
.ДобавлениеТестовВРасширение
- добавляет отсутствующие сценарии в расширение с unit-тестами. См. подробнееЗапретИспользованияПерейти
- проверяет модуль на использование методов Перейти
.ИсправлениеНеКаноническогоНаписания
- исправляет неканоничное написание ключевых слов в модулях.КорректировкаXMLФорм
- исправляет дубли индексов элементов в файлах описаний форм (могут образоваться при объединениях). Поддерживаются как файлы в формате выгрузки конфигуратора (Form.xml
), так и в формате EDT (Form.form
).ОбработкаЮнитТестов
- обновляет метод-загрузчик сценариев в общих модулях расширения с unit-тестами (по умолчанию отключен).ОтключениеПолнотекстовогоПоиска
- отключает полнотекстовый поиск в файлах описаний метаданных. См. подробнееПроверкаДублейПроцедурИФункций
- проверяет уникальность названий процедур и функций в модулях.ПроверкаКорректностиИнструкцийПрепроцессора
- проверяет корректность написания инструкций препроцессора в модулях.ПроверкаКорректностиОбластей
- проверяет корректность "скобок" областей в модулях (парность и последовательность).ПроверкаНецензурныхСлов
- проверяет наличие нецензурных слов в модулях. См. подробнееРазборОбычныхФормНаИсходники
- раскладывает файлы обычных форм (Form.bin
) на исходные файлы с помощью инструмента v8unpack
.РазборОтчетОбработокРасширений
- раскладывает средствами платформы файлы внешних отчетов, обработок и расширений на исходные файлы. См. подробнееСинхронизацияОбъектовМетаданныхИФайлов
- анализирует наличие файлов и объектов конфигурации. Поддерживается только файл описания конфигурации в формате выгрузки конфигуратора (Configuration.xml
).СортировкаДереваМетаданных
- упорядочивает объекты метаданных верхнего уровня по алфавиту в файле описания конфигурации (кроме подсистем). Поддерживается как файл в формате выгрузки конфигуратора (Configuration.xml
), так и в формате EDT (Configuration.mdo
).УдалениеДублейМетаданных
- удаляет дубли объектов метаданных в файле описания конфигурации (могут образоваться при объединениях). Поддерживается как файл в формате выгрузки конфигуратора (Configuration.xml
), так и в формате EDT (Configuration.mdo
)..УдалениеЛишнихКонцевыхПробелов
- удаляет лишние пробелы и табы в конце не пустых строк в файлах модулей.УдалениеЛишнихПустыхСтрок
- удаляет лишние пустые строки в модулях (лишними считаются 2 и более идущих подряд пустых строк).precommit4onec может читать настройки своей работы из специального конфигурационного файла.
Управление настройками происходит с использованием команды configure
:
precommit4onec configure -global
precommit4onec configure -global -reset
precommit4onec configure -global -config
.Предоставляется возможность в репозитории иметь свои, отличные от глобальных, настройки. Для этого необходимо вместо флага -global
в указанных выше командах передавать параметр -rep-path
с указанием пути к каталогу репозитория.
Также можно настроить различное поведение для различных каталогов репозитория, для работы с подкаталогами (проектами) используется ключ -child-path
.
Настройки проектов полностью переопределяют базовые настройки. Например если в основной настройке указаны ОтключенныеСценарии
,
а для проекта configuration\
они не заполнены, то для каталога configuration
будут выполнены все сценарии.
Конфигурирование дает возможности:
Некоторые сценарии поддерживают возможность изменения своих настроек со значений по умолчанию на установленные в конфигурационном файле. На данный момент реализована возможность указывать необходимую версию платформы 1С:Предприятие в сценарии РазборОтчетОбработокРасширений
.
{
"GLOBAL": { // необязательная секция
"ВерсияПлатформы": "8.3.10.2309", // используемая версия платформы например для разбора на исходники
"version": "2.0", // версия конфигурационного файла (необязательно)
"ФорматEDT": true, // признак использования исходных файлов в формате EDT
},
"Precommt4onecСценарии": {
"ИспользоватьСценарииРепозитория": false, // Признак, выполнения проверок из репозитория
"КаталогЛокальныхСценариев": "", // Относительный путь к каталогу локальных проверок
"ГлобальныеСценарии": [...], // Список проверок, которые будут выполнятся
"ОтключенныеСценарии": [...], // Список проверок, которые не будут выполнятся (имеет больший приоритет относительно ГлобальныеСценарии)
"НастройкиСценариев": { // Настройки выполняемых проверок
...
},
"Проекты":{ // Настройки проектов (подкаталогов репозитория). Настройки проектов полностью переопределяют настройки и имеют такую же структуру
"configuration\\": { // Имя проекта (подкаталога)
"ИспользоватьСценарииРепозитория": false,
"ГлобальныеСценарии": []
}
}
}
}
Для создания нового сценария обработки файлов необходимо воспользоваться шаблоном, находящимся в каталоге СценарииОбработки
скрипта.
Чтобы сценарий работал для всех репозиториев необходимо
СценарииОбработки
Чтобы сценарий работал в конкретном репозитории необходимо
tools\СценарииОбработки
Если при выполнении precommit4onec не найдет файлов сценариев в указанном каталоге, либо не найдет каталог, он об этом сообщит в лог и продолжит работу без ошибок.
1. Откройте маркетплейс из главного меню TurboConf или из меню в панели уведомлений.
2. Найдите нужную разработку.
3. Нажмите кнопку Установить.
TurboConf все установит автоматически!