tools/git_man
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: заменить percent-кодированные якоря в оглавлении на русский текст

Browse Source
This commit is contained in:
mihailkudravcev
2026-09-24 10:44:09 +03:00
parent fd93e08579
commit 94fa189cfa
1 changed files with 30 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -29
View File
@@ -26,6 +26,7 @@
Данный репозиторий содержит вспомогательные скрипты для работы с Git в проектах, где используется множество вложенных репозиториев (монорепозиторий с подмодулями), а также настройка репозиториев под выгрузку конфигуратора 1С. Данный репозиторий содержит вспомогательные скрипты для работы с Git в проектах, где используется множество вложенных репозиториев (монорепозиторий с подмодулями), а также настройка репозиториев под выгрузку конфигуратора 1С.
Основные задачи: Основные задачи:
- Автоматическая регистрация вложенных репозиториев как подмодулей - Автоматическая регистрация вложенных репозиториев как подмодулей
- Снятие путей из `.gitignore` при регистрации - Снятие путей из `.gitignore` при регистрации
- Централизованное управление множеством репозиториев - Централизованное управление множеством репозиториев
@@ -39,15 +40,16 @@
### `setup-1c-repo` — настройка репозитория под 1С ### `setup-1c-repo` — настройка репозитория под 1С
**Описание:** **Описание:**\
Включает локальные настройки Git в **указанной папке** (`--path` / `-Path`, **обязательно**) под выгрузку конфигурации/расширения из **конфигуратора 1С**: UTF-8 с BOM, CRLF в рабочей копии для файлов выгрузки, корректные пути с кириллицей, длинные пути, `.gitattributes` и `.gitignore`. Без пути скрипт не выполняется. Включает локальные настройки Git в **указанной папке** (`--path` / `-Path`, **обязательно**) под выгрузку конфигурации/расширения из **конфигуратора 1С**: UTF-8 с BOM, CRLF в рабочей копии для файлов выгрузки, корректные пути с кириллицей, длинные пути, `.gitattributes` и `.gitignore`. Без пути скрипт не выполняется.
| Платформа | Скрипт | | Платформа | Скрипт |
|-----------|--------| | --- | --- |
| **Windows** | `setup-1c-repo.ps1` или `setup-1c-repo.cmd` | | **Windows** | `setup-1c-repo.ps1` или `setup-1c-repo.cmd` |
| **macOS / Linux** | `setup-1c-repo.sh` | | **macOS / Linux** | `setup-1c-repo.sh` |
**Использование (Windows):** **Использование (Windows):**
```powershell ```powershell
.\setup-1c-repo.ps1 -Path D:\projects\uas_ep -Force .\setup-1c-repo.ps1 -Path D:\projects\uas_ep -Force
.\setup-1c-repo.ps1 -Path . -Force -Renormalize .\setup-1c-repo.ps1 -Path . -Force -Renormalize
@@ -55,6 +57,7 @@
``` ```
**Использование (macOS / Linux):** **Использование (macOS / Linux):**
```bash ```bash
./setup-1c-repo.sh --path /projects/uas_ep --force ./setup-1c-repo.sh --path /projects/uas_ep --force
./setup-1c-repo.sh --path . --force --renormalize ./setup-1c-repo.sh --path . --force --renormalize
@@ -64,7 +67,7 @@
**Опции:** **Опции:**
| Опция (sh / ps1) | Описание | | Опция (sh / ps1) | Описание |
|------------------|----------| | --- | --- |
| `--help` / `-Help` | Справка | | `--help` / `-Help` | Справка |
| `--version` / `-Version` | Версия скрипта (`1.2.2`) | | `--version` / `-Version` | Версия скрипта (`1.2.2`) |
| `--path DIR` / `-Path DIR` | Папка репозитория (**обязательно**) | | `--path DIR` / `-Path DIR` | Папка репозитория (**обязательно**) |
@@ -77,10 +80,10 @@
| `--verbose` / `-Verbose` | Подробный вывод | | `--verbose` / `-Verbose` | Подробный вывод |
| `--quiet` / `-Quiet` | Только ошибки | | `--quiet` / `-Quiet` | Только ошибки |
**Что применяется локально (`git config --local`):** **Что применяется локально (**`git config --local`**):**
| Параметр | Значение | Зачем | | Параметр | Значение | Зачем |
|----------|----------|--------| | --- | --- | --- |
| `core.quotepath` | `false` | Кириллические пути без `\320\…` | | `core.quotepath` | `false` | Кириллические пути без `\320\…` |
| `core.longpaths` | `true` | Длинные пути (Windows / глубокие деревья 1С) | | `core.longpaths` | `true` | Длинные пути (Windows / глубокие деревья 1С) |
| `gui.encoding` | `utf-8` | Кодировка GUI | | `gui.encoding` | `utf-8` | Кодировка GUI |
@@ -90,9 +93,10 @@
| `diff.renames` | `false` | Как в рекомендациях 1С:ГитКонвертер | | `diff.renames` | `false` | Как в рекомендациях 1С:ГитКонвертер |
| `core.precomposeunicode` | `true` | Только macOS (NFD/NFC для имён файлов) | | `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 ```bash
git add .gitattributes .gitignore git add .gitattributes .gitignore
git commit -m "Настройки Git для выгрузки конфигуратора 1С" git commit -m "Настройки Git для выгрузки конфигуратора 1С"
@@ -102,10 +106,11 @@ git commit -m "Настройки Git для выгрузки конфигура
### `register-submodules.sh` ### `register-submodules.sh`
**Описание:** **Описание:**\
Автоматически находит все вложенные Git-репозитории в текущей папке и регистрирует их как подмодули в `.gitmodules`. Перед регистрацией снимает путь из `.gitignore` (точные правила или исключение `!/path/`). Уже существующие клоны регистрируются без повторного clone. Поддерживает настройку игнорирования состояния подмодулей. Автоматически находит все вложенные Git-репозитории в текущей папке и регистрирует их как подмодули в `.gitmodules`. Перед регистрацией снимает путь из `.gitignore` (точные правила или исключение `!/path/`). Уже существующие клоны регистрируются без повторного clone. Поддерживает настройку игнорирования состояния подмодулей.
**Использование:** **Использование:**
```bash ```bash
./register-submodules.sh [ОПЦИИ] ./register-submodules.sh [ОПЦИИ]
``` ```
@@ -113,7 +118,7 @@ git commit -m "Настройки Git для выгрузки конфигура
**Опции:** **Опции:**
| Опция | Описание | | Опция | Описание |
|-------|----------| | --- | --- |
| `--help`, `-h` | Показать справку | | `--help`, `-h` | Показать справку |
| `--version`, `-V` | Показать версию скрипта (`1.0.6`) | | `--version`, `-V` | Показать версию скрипта (`1.0.6`) |
| `--dry-run` | Только показать, что будет сделано (без изменений) | | `--dry-run` | Только показать, что будет сделано (без изменений) |
@@ -124,16 +129,17 @@ git commit -m "Настройки Git для выгрузки конфигура
| `--verbose`, `-v` | Подробный вывод | | `--verbose`, `-v` | Подробный вывод |
| `--quiet`, `-q` | Минимальный вывод (только ошибки) | | `--quiet`, `-q` | Минимальный вывод (только ошибки) |
**Режимы игнорирования (`MODE`):** **Режимы игнорирования (**`MODE`**):**
| Режим | Описание | | Режим | Описание |
|-------|----------| | --- | --- |
| `all` | Полностью скрывает изменения в подмодулях (не показывает ничего) | | `all` | Полностью скрывает изменения в подмодулях (не показывает ничего) |
| `dirty` | Скрывает только изменения в файлах подмодуля | | `dirty` | Скрывает только изменения в файлах подмодуля |
| `untracked` | Скрывает только неотслеживаемые файлы в подмодуле | | `untracked` | Скрывает только неотслеживаемые файлы в подмодуле |
| `none` | Показывает все изменения (поведение по умолчанию) | | `none` | Показывает все изменения (поведение по умолчанию) |
**Примеры:** **Примеры:**
```bash ```bash
# Базовая регистрация # Базовая регистрация
./register-submodules.sh ./register-submodules.sh
@@ -161,6 +167,7 @@ git commit -m "Настройки Git для выгрузки конфигура
``` ```
**После регистрации:** **После регистрации:**
```bash ```bash
git add .gitmodules git add .gitmodules
git commit -m "Зарегистрированы все подмодули" git commit -m "Зарегистрированы все подмодули"
@@ -168,6 +175,7 @@ git push
``` ```
**При клонировании репозитория с подмодулями:** **При клонировании репозитория с подмодулями:**
```bash ```bash
# Вариант 1: сразу с подмодулями # Вариант 1: сразу с подмодулями
git clone --recursive https://git.p7net.ru/tools/git_man.git 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). Кратко по релизам — см. [CHANGELOG.md](./CHANGELOG.md).
| Версия | Дата | Суть | | Версия | Дата | Суть |
|--------|------|------| | --- | --- | --- |
| **1.2.2** | 2026-07-27 | `setup-1c-repo`: путь обязателен, без cwd по умолчанию | | **1.2.2** | 2026-07-27 | `setup-1c-repo`: путь обязателен, без cwd по умолчанию |
| **1.2.1** | 2026-07-27 | `setup-1c-repo`: опция `--path` / `-Path` | | **1.2.1** | 2026-07-27 | `setup-1c-repo`: опция `--path` / `-Path` |
| **1.2.0** | 2026-07-27 | `setup-1c-repo` — настройки Git под выгрузку конфигуратора 1С | | **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 | Первый стабильный релиз | | **1.0.0** | 2025-07-19 | Первый стабильный релиз |
Проверка версии: Проверка версии:
```bash ```bash
./setup-1c-repo.sh --version ./setup-1c-repo.sh --version
./register-submodules.sh --version ./register-submodules.sh --version
@@ -274,8 +283,9 @@ git submodule add https://git.p7net.ru/tools/git_man.git tools/git_man
## 👤 Автор ## 👤 Автор
**Michael BAG** **Michael BAG**
- Email: [mk@p7net.ru](mailto:mk@p7net.ru) - Email: [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>
--- ---
@@ -295,23 +305,11 @@ MIT License
Copyright (c) 2024-2025 Michael BAG Copyright (c) 2024-2025 Michael BAG
Permission is hereby granted, free of charge, to any person obtaining a copy 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:
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 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 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.
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 ```bash
git submodule update --init --recursive git submodule update --init --recursive
``` ```
@@ -331,5 +330,5 @@ git submodule update --init --recursive
## 📞 Контакты ## 📞 Контакты
- **Автор:** Michael BAG ([mk@p7net.ru](mailto:mk@p7net.ru)) - **Автор:** 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>
- **Проблемы/Предложения:** [https://git.p7net.ru/tools/git_man/issues](https://git.p7net.ru/tools/git_man/issues) - **Проблемы/Предложения:** <https://git.p7net.ru/tools/git_man/issues>