1
0
mirror of https://github.com/arkuznetsov/1CFilesConverter.git synced 2024-11-21 17:36:30 +02:00

docs: Дополнен README.

This commit is contained in:
ArKuznetsov 2024-10-09 11:44:46 +03:00
parent 7dae056770
commit 5d9da45b97

View File

@ -23,6 +23,7 @@
* [Java runtime environment 11](https://releases.1c.ru/project/Liberica11FullJDK)
* [1C:Enterprise Development Tools (EDT)](https://releases.1c.ru/project/DevelopmentTools10)
* Утилита ring (входит в состав EDT)
* Утилита 1C:EDT CLI (входит в состав EDT)
* [watchman](https://facebook.github.io/watchman/docs/install) - для [автоматической конвертации файлов при изменении](#watchman) (рекомендуется прописать в переменную окружения `%PATH%`)
## <a id="environment"></a>Переменные среды
@ -34,11 +35,15 @@
* **V8_CONVERT_TOOL** - инструмент для конвертации файлов конфигурации/расширения (по умолчанию: `designer`):
* **designer** - для конвертации используется пакетный режим конфигуратора
* **ibcmd** - для конвертации используется утилита администрирования автономного сервера
* **V8_TOOL** - путь к исполняемому файлу 1С:Предприятие `1Cv8.exe` (по умолчанию: `C:\Program Files\1cv8\%V8_VERSION%\bin\1cv8.exe`)
* **IBCMD_TOOL** - путь к утилите управления автономным сервером `ibcmd` (по умолчанию: `C:\Program Files\1cv8\%V8_VERSION%\bin\ibcmd.exe`)
* **V8_TOOL** - путь к исполняемому файлу 1С:Предприятие `1Cv8.exe` (по умолчанию: `%PROGRAMW6432%\1cv8\%V8_VERSION%\bin\1cv8.exe`)
* **IBCMD_TOOL** - путь к утилите управления автономным сервером `ibcmd` (по умолчанию: `%PROGRAMW6432%\1cv8\%V8_VERSION%\bin\ibcmd.exe`)
* **RING_TOOL** - путь к утилите ring из состава EDT (по умолчанию берется из переменной окружения `%PATH%`)
* **EDTCLI_TOOL** - путь к утилите 1cedtcli из состава EDT (по умолчанию ищется в каталоге `%PROGRAMW6432%\1C\1CE\components\1c-edt-%V8_EDT_VERSION%*`)
* **IBCMD_DATA** - путь к каталогу данных автономного сервера при использовании утилиты `ibcmd` (по умолчанию `%V8_TEMP%\ibcmd_data`)
* **V8_SKIP_ENV** - если установлена в `1`, то отключает чтение переменных среды из файла `.env`
* **V8_CONF_CLEAN_DST** - если установлена в `1`, то перед конвертацией конфигурации каталог назначения будет очищен
* **V8_EXT_CLEAN_DST** - если установлена в `1`, то перед конвертацией расширения каталог назначения будет очищен
* **V8_DP_CLEAN_DST** - если установлена в `1`, то перед конвертацией обработок/отчетов каталог назначения будет очищен
Значения переменных среды могут быть указаны в файле `.env` в текущем рабочем каталоге, пример приведен в файле [tests/example.env](./tests/example.env)
@ -81,7 +86,7 @@
ВНИМАНИЕ! При использовании ibcmd могут возникать ошибки загрузки конфигурации из XML-файлов, если в пути к файлам присутствует `..`, т.е. рекомендуется указывать полные пути.
Проверялось на версии 8.3.20.2290
Проверялось на версии 8.3.20.2290, 8.3.23.1865, 8.3.23.2040
```
@ -126,7 +131,7 @@
ВНИМАНИЕ! При использовании ibcmd могут возникать ошибки загрузки конфигурации из XML-файлов, если в пути к файлам присутствует `..`, т.е. рекомендуется указывать полные пути.
Проверялось на версии 8.3.20.2290
Проверялось на версии 8.3.20.2290, 8.3.23.1865, 8.3.23.2040
```
@ -480,7 +485,7 @@
### [edt-validate.cmd](./scripts/edt-validate.cmd)
Выполняет проверку проекта 1C:Enterprise Development Tools (EDT) (`ring edt validate`).
Выполняет проверку проекта 1C:Enterprise Development Tools (EDT) (`ring edt validate` или `1cedtcli -command validate`).
Может использоваться для проектов конфигураций, расширений, внешних отчетов и отбработок.
Проверяем проектом может выступать: