Skip to content

Commit 06c855e

Browse files
committed
Fix xDrivenDevelopment#63. Доработано README
1 parent fabc6a0 commit 06c855e

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,32 @@
44

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

1313
### Установка
1414

15-
1. Зависимости:
15+
1. Зависимости:
1616
* OneScript http://oscript.io/ (рекомендуется)
1717
* * или Python 3.3
18-
* установленная платформа 1С:Предприятия
18+
* установленная платформа 1С:Предприятие 8
1919
* git
2020
* в случае запуска из под wine необходим msscriptcontrol
21+
* в случае использования OneScript-версии требуется установка **develop**-версии библиотек [oscript-library]( https://github.com/EvilBeaver/oscript-library)
2122

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

24-
3. Путь к платформе находится автоматически в случае стандартной установки 1С. Если необходимо явно указать путь к платформе, то нужно: указать переменную окружения PATH1C c путём к каталогу, в который установлена 1С
25+
3. После скачивания данного репозитория необходимо инициализировать используемые подмодули.
26+
Откройте командую строку и выполните команды:
27+
```cmd
28+
cd путь/к/репозиторию/precommit1c
29+
git submodule update --init --recursive
30+
```
31+
32+
4. Путь к платформе находится автоматически в случае стандартной установки 1С. Если необходимо явно указать путь к платформе, то нужно: указать переменную окружения PATH1C c путём к каталогу, в который установлена 1С
2533
```
2634
set PATH1C = d:\program\
2735
```
@@ -31,34 +39,36 @@ set PATH1C = d:\program\
3139
onecplatfrorms = c:\program\1cv8\8.3.5.823\bin\1cv8.exe
3240
```
3341

34-
4. Путь хранения исходных текстов разобранных обработок по умолчанию используется как **src** (для обеспечения совместимости со старыми версиями обработки), однако его можно переназначить в ini-файле
42+
5. Путь хранения исходных текстов разобранных обработок по умолчанию используется как **src** (для обеспечения совместимости со старыми версиями обработки), однако его можно переназначить в ini-файле
3543
```
3644
[DEFAULT]
3745
source = plugin_source
3846
```
3947

40-
5. Флажок, изменяющий корневую папку хранения исходных текстов разобранных обработок по умолчанию используется как корневая папка (для обеспечения совместимости со старыми версиями обработки), однако его можно переназначить в ini-файле. Если изменить флажок на True - в каждой корневой папке внешних обработок будет создан подкаталог текстов разобранных обработок.
48+
6. Флажок, изменяющий корневую папку хранения исходных текстов разобранных обработок по умолчанию используется как корневая папка (для обеспечения совместимости со старыми версиями обработки), однако его можно переназначить в ini-файле. Если изменить флажок на True - в каждой корневой папке внешних обработок будет создан подкаталог текстов разобранных обработок.
4149
```
4250
[DEFAULT]
4351
source_in_source = False
4452
```
4553

46-
6. Наконец, содержимое каталога необходимо скопировать в каталог .git/hooks/ вашего проекта.
54+
7. Наконец, содержимое каталога необходимо скопировать в каталог .git/hooks/ вашего проекта.
4755
> *Примечание:* каталог .git по умолчанию скрыт.
4856
57+
В итоге у вас должна получиться следующая структура каталога:
4958
```
5059
.git\
5160
hooks\
5261
pre-commit
5362
V8Reader
54-
ibService
63+
tools
64+
ibService
5565
v8files-extractor.os
5666
pyv8unpack.py
5767
```
5868

59-
##Запуск
69+
##Запуск
6070

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

6373
##Командная строка запуска OneScript
6474

@@ -110,7 +120,7 @@ optional arguments:
110120

111121
Дополнительно необходима настройка git для возможности использования кириллических наименований внешних обработок ```git config --local core.quotepath false```
112122

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

115125
##Что внутри
116126

0 commit comments

Comments
 (0)