From 94fa189cfa4357ce1c6f16d7057b86ce10aa4436 Mon Sep 17 00:00:00 2001 From: mihailkudravcev Date: Thu, 24 Sep 2026 10:44:09 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=B7=D0=B0=D0=BC=D0=B5=D0=BD=D0=B8?= =?UTF-8?q?=D1=82=D1=8C=20percent-=D0=BA=D0=BE=D0=B4=D0=B8=D1=80=D0=BE?= =?UTF-8?q?=D0=B2=D0=B0=D0=BD=D0=BD=D1=8B=D0=B5=20=D1=8F=D0=BA=D0=BE=D1=80?= =?UTF-8?q?=D1=8F=20=D0=B2=20=D0=BE=D0=B3=D0=BB=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B8=D0=B8=20=D0=BD=D0=B0=20=D1=80=D1=83=D1=81=D1=81?= =?UTF-8?q?=D0=BA=D0=B8=D0=B9=20=D1=82=D0=B5=D0=BA=D1=81=D1=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 61 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index a36373e..1d34b93 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ Данный репозиторий содержит вспомогательные скрипты для работы с Git в проектах, где используется множество вложенных репозиториев (монорепозиторий с подмодулями), а также настройка репозиториев под выгрузку конфигуратора 1С. Основные задачи: + - Автоматическая регистрация вложенных репозиториев как подмодулей - Снятие путей из `.gitignore` при регистрации - Централизованное управление множеством репозиториев @@ -39,15 +40,16 @@ ### `setup-1c-repo` — настройка репозитория под 1С -**Описание:** +**Описание:**\ Включает локальные настройки Git в **указанной папке** (`--path` / `-Path`, **обязательно**) под выгрузку конфигурации/расширения из **конфигуратора 1С**: UTF-8 с BOM, CRLF в рабочей копии для файлов выгрузки, корректные пути с кириллицей, длинные пути, `.gitattributes` и `.gitignore`. Без пути скрипт не выполняется. | Платформа | Скрипт | -|-----------|--------| +| --- | --- | | **Windows** | `setup-1c-repo.ps1` или `setup-1c-repo.cmd` | | **macOS / Linux** | `setup-1c-repo.sh` | **Использование (Windows):** + ```powershell .\setup-1c-repo.ps1 -Path D:\projects\uas_ep -Force .\setup-1c-repo.ps1 -Path . -Force -Renormalize @@ -55,6 +57,7 @@ ``` **Использование (macOS / Linux):** + ```bash ./setup-1c-repo.sh --path /projects/uas_ep --force ./setup-1c-repo.sh --path . --force --renormalize @@ -64,7 +67,7 @@ **Опции:** | Опция (sh / ps1) | Описание | -|------------------|----------| +| --- | --- | | `--help` / `-Help` | Справка | | `--version` / `-Version` | Версия скрипта (`1.2.2`) | | `--path DIR` / `-Path DIR` | Папка репозитория (**обязательно**) | @@ -77,10 +80,10 @@ | `--verbose` / `-Verbose` | Подробный вывод | | `--quiet` / `-Quiet` | Только ошибки | -**Что применяется локально (`git config --local`):** +**Что применяется локально (**`git config --local`**):** | Параметр | Значение | Зачем | -|----------|----------|--------| +| --- | --- | --- | | `core.quotepath` | `false` | Кириллические пути без `\320\…` | | `core.longpaths` | `true` | Длинные пути (Windows / глубокие деревья 1С) | | `gui.encoding` | `utf-8` | Кодировка GUI | @@ -90,9 +93,10 @@ | `diff.renames` | `false` | Как в рекомендациях 1С:ГитКонвертер | | `core.precomposeunicode` | `true` | Только macOS (NFD/NFC для имён файлов) | -**`.gitattributes`:** для `*.bsl`, `*.xml`, `*.txt`, `*.html` и др. файлов выгрузки — `text eol=crlf` (рабочая копия как у конфигуратора). Бинарники (`*.cf`, `*.bin`, картинки, …) — `binary`. BOM UTF-8 хранится как часть содержимого файла. +`.gitattributes`**:** для `*.bsl`, `*.xml`, `*.txt`, `*.html` и др. файлов выгрузки — `text eol=crlf` (рабочая копия как у конфигуратора). Бинарники (`*.cf`, `*.bin`, картинки, …) — `binary`. BOM UTF-8 хранится как часть содержимого файла. **После запуска:** + ```bash git add .gitattributes .gitignore git commit -m "Настройки Git для выгрузки конфигуратора 1С" @@ -102,10 +106,11 @@ git commit -m "Настройки Git для выгрузки конфигура ### `register-submodules.sh` -**Описание:** +**Описание:**\ Автоматически находит все вложенные Git-репозитории в текущей папке и регистрирует их как подмодули в `.gitmodules`. Перед регистрацией снимает путь из `.gitignore` (точные правила или исключение `!/path/`). Уже существующие клоны регистрируются без повторного clone. Поддерживает настройку игнорирования состояния подмодулей. **Использование:** + ```bash ./register-submodules.sh [ОПЦИИ] ``` @@ -113,7 +118,7 @@ git commit -m "Настройки Git для выгрузки конфигура **Опции:** | Опция | Описание | -|-------|----------| +| --- | --- | | `--help`, `-h` | Показать справку | | `--version`, `-V` | Показать версию скрипта (`1.0.6`) | | `--dry-run` | Только показать, что будет сделано (без изменений) | @@ -124,16 +129,17 @@ git commit -m "Настройки Git для выгрузки конфигура | `--verbose`, `-v` | Подробный вывод | | `--quiet`, `-q` | Минимальный вывод (только ошибки) | -**Режимы игнорирования (`MODE`):** +**Режимы игнорирования (**`MODE`**):** | Режим | Описание | -|-------|----------| +| --- | --- | | `all` | Полностью скрывает изменения в подмодулях (не показывает ничего) | | `dirty` | Скрывает только изменения в файлах подмодуля | | `untracked` | Скрывает только неотслеживаемые файлы в подмодуле | | `none` | Показывает все изменения (поведение по умолчанию) | **Примеры:** + ```bash # Базовая регистрация ./register-submodules.sh @@ -161,6 +167,7 @@ git commit -m "Настройки Git для выгрузки конфигура ``` **После регистрации:** + ```bash git add .gitmodules git commit -m "Зарегистрированы все подмодули" @@ -168,6 +175,7 @@ git push ``` **При клонировании репозитория с подмодулями:** + ```bash # Вариант 1: сразу с подмодулями git clone --recursive https://git.p7net.ru/tools/git_man.git @@ -255,7 +263,7 @@ git submodule add https://git.p7net.ru/tools/git_man.git tools/git_man Кратко по релизам — см. [CHANGELOG.md](./CHANGELOG.md). | Версия | Дата | Суть | -|--------|------|------| +| --- | --- | --- | | **1.2.2** | 2026-07-27 | `setup-1c-repo`: путь обязателен, без cwd по умолчанию | | **1.2.1** | 2026-07-27 | `setup-1c-repo`: опция `--path` / `-Path` | | **1.2.0** | 2026-07-27 | `setup-1c-repo` — настройки Git под выгрузку конфигуратора 1С | @@ -264,6 +272,7 @@ git submodule add https://git.p7net.ru/tools/git_man.git tools/git_man | **1.0.0** | 2025-07-19 | Первый стабильный релиз | Проверка версии: + ```bash ./setup-1c-repo.sh --version ./register-submodules.sh --version @@ -273,9 +282,10 @@ git submodule add https://git.p7net.ru/tools/git_man.git tools/git_man ## 👤 Автор -**Michael BAG** -- Email: [mk@p7net.ru](mailto:mk@p7net.ru) -- Репозиторий: [https://git.p7net.ru/tools/git_man](https://git.p7net.ru/tools/git_man) +**Michael BAG** + +- Email: [mk@p7net.ru](mailto:mk@p7net.ru) +- Репозиторий: --- @@ -295,23 +305,11 @@ MIT License Copyright (c) 2024-2025 Michael BAG -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --- @@ -322,6 +320,7 @@ git pull origin main ``` Для обновления подмодулей (если используются): + ```bash git submodule update --init --recursive ``` @@ -331,5 +330,5 @@ git submodule update --init --recursive ## 📞 Контакты - **Автор:** Michael BAG ([mk@p7net.ru](mailto:mk@p7net.ru)) -- **Репозиторий:** [https://git.p7net.ru/tools/git_man](https://git.p7net.ru/tools/git_man) -- **Проблемы/Предложения:** [https://git.p7net.ru/tools/git_man/issues](https://git.p7net.ru/tools/git_man/issues) +- **Репозиторий:** +- **Проблемы/Предложения:** \ No newline at end of file