Skip to content

Commit b4f102a

Browse files
committed
Обновлено readme
1 parent 77d27bf commit b4f102a

File tree

1 file changed

+13
-42
lines changed

1 file changed

+13
-42
lines changed

README.md

Lines changed: 13 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
1-
## Набор утилит для автоматической разборки/сборки внешних обработок и отчетов, при помещении (commit) в git
1+
## Набор утилит для автоматической разборки/сборки внешних обработок и отчетов, при помещении (commit) в git
22

33
[![Join the chat at https://gitter.im/xDrivenDevelopment/precommit1c](https://badges.gitter.im/xDrivenDevelopment/precommit1c.svg)](https://gitter.im/xDrivenDevelopment/precommit1c?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
44

55
### Что к чему
66
----
77
* v8files-extractor.os - скрипт для OneScript, получающий список помещаемых файлов при коммите, фильтрующий по расширению только внешние отчёты/обработки и запускающий внешнюю обработку для распаковки этих файлов. Так же позволяет собирать обработки из полученных исходников.
8-
* * pyv8unpack.py - Python-скрипт, выполняющий такую же задачу
98
* [V8Reader.epf](http://infostart.ru/public/106310/) - внешняя обработка 1С, которая с помощью [v8unpack](http://svn2.assembla.com/svn/V8Unpack/track/) разбирает внешние обработки, определяет нормальные наименования для каталогов форм, файлов модулей объектов и т. д. и раскладывает их в нормальную структуру папок.
109
* ibService - сервисная база данных на 1С для запуска V8Reader.epf
11-
* pre-commit - собственно командный файл, вызываемый git перед каждым помещением. Выполняет роль простой запускалки скрипта pyv8unpack.py
10+
* pre-commit - собственно командный файл, вызываемый git перед каждым помещением. Выполняет роль простой запускалки скрипта v8files-extractor.os
1211

1312
### Установка
1413

1514
1. Зависимости:
16-
* OneScript http://oscript.io/ (рекомендуется)
17-
* * или Python 3.3
15+
* OneScript http://oscript.io/
1816
* установленная платформа 1С:Предприятие 8
1917
* git
2018
* в случае запуска из под wine необходим msscriptcontrol
21-
* в случае использования OneScript-версии требуется установка **develop**-версии библиотек [oscript-library]( https://github.com/EvilBeaver/oscript-library)
19+
* **develop**-версия библиотек [oscript-library]( https://github.com/EvilBeaver/oscript-library)
2220

23-
2. По умолчанию считается, что пути к oscript.exe и/или python.exe и git.exe находятся в переменной path, иначе необходимо указать явный путь в файлах pre-commit (для oscript/python) и pyv8unpack.py (для git)
21+
2. По умолчанию считается, что пути к oscript.exe и git.exe находятся в переменной path, иначе необходимо указать явный путь в файлах pre-commit
2422

25-
3. После скачивания данного репозитория необходимо инициализировать используемые подмодули.
23+
3. После клонирования данного репозитория необходимо инициализировать используемые подмодули.
2624
Откройте командую строку и выполните команды:
2725
```cmd
2826
cd путь/к/репозиторию/precommit1c
@@ -33,7 +31,7 @@ git submodule update --init --recursive
3331
```
3432
set PATH1C = d:\program\
3533
```
36-
или создать ini-файл рядом с файлом скрипта pyv8unpack.py или в домашней папке в корне с именем precommit1c.ini и содержанием:
34+
или создать ini-файл рядом с файлом скрипта v8files-extractor.os или в домашней папке в корне с именем precommit1c.ini и содержанием:
3735
```
3836
[DEFAULT]
3937
onecplatfrorms = c:\program\1cv8\8.3.5.823\bin\1cv8.exe
@@ -63,14 +61,13 @@ source_in_source = False
6361
tools
6462
ibService
6563
v8files-extractor.os
66-
pyv8unpack.py
6764
```
6865

69-
##Запуск
66+
## Запуск
7067

7168
После установки достаточно для проверки сделать commit для любого файла epf/erf, и в вашем репозитории автоматически должна создаться папка *src*, полностью повторяющая структуру проекта, изменённые или добавленные файлы распакуются в папки с аналогичными наименованиями.
7269

73-
##Командная строка запуска OneScript
70+
## Командная строка запуска OneScript
7471

7572
```
7673
oscript v8files-extractor.os ?
@@ -90,38 +87,12 @@ oscript v8files-extractor.os ?
9087
Если указан параметр --recursive, скрипт будет рекурсивно искать исходные коды отчетов и обработок в указанном каталоге и собирать их, повторяя структуру каталога
9188
```
9289

93-
##Командная строка запуска Питона
90+
## Ограничения
9491

95-
```
96-
python pyv8unpack.py [-h] [--version] [-v] [--index] [--g] [--compile]
97-
[--type TYPE] [--platform PLATFORM]
98-
[inputPath] [output]
99-
100-
101-
Утилита для автоматической распаковки внешних обработок
102-
103-
positional arguments:
104-
inputPath Путь к файлам, необходимым для распаковки
105-
output Путь к каталогу, куда распаковывать
106-
107-
optional arguments:
108-
-h, --help Show this help message and exit
109-
--version Show program's version number and exit
110-
-v, --verbose Increases log verbosity for each occurence
111-
--index Добавляем в индекс исходники
112-
--g Запустить чтение индекса из git и определить список
113-
файлов для разбора
114-
--compile Собрать внешний отчёт/обработку
115-
--type TYPE Тип файла для сборки epf, erf. По умолчанию авто epf
116-
--platform PLATFORM Путь к платформе 1С
117-
```
118-
119-
##Ограничения
120-
121-
Дополнительно необходима настройка git для возможности использования кириллических наименований внешних обработок ```git config --local core.quotepath false```
92+
Дополнительно необходима настройка git для возможности использования кириллических наименований внешних обработок `git config --local core.quotepath false`
12293

12394
Не стоит называть файлы с разным расширением epf и erf одинаковыми именами - каталоги с исходниками создаются только по наименованию без учёта расширения и возможен конфликт имен.
12495

125-
##Что внутри
96+
## Что внутри
12697

127-
Как это работает: v8files-extractor.os/pyv8unpack.py полностью повторяет иерархию папок относительно корня репозитория только в папке SRC (от слова source), для каждой изменённой внешней обработки создаётся своя папка и туда с помощью v8unpack распаковывается помещаемая обработка, с помощью v8reader определяются наименования макетов, форм, модуля обработки и переименовываются, переименования сохраняются в служебном файле renames.txt, те файлы, которые невозможно определить или же носят чисто служебный характер, переносятся в каталог *und*
98+
Как это работает: v8files-extractor.os полностью повторяет иерархию папок относительно корня репозитория только в папке SRC (от слова source), для каждой изменённой внешней обработки создаётся своя папка и туда с помощью v8unpack распаковывается помещаемая обработка, с помощью v8reader определяются наименования макетов, форм, модуля обработки и переименовываются, переименования сохраняются в служебном файле renames.txt, те файлы, которые невозможно определить или же носят чисто служебный характер, переносятся в каталог *und*

0 commit comments

Comments
 (0)