реестр префиксов перенесён в корень
- реестр покрывает и обвязку тоже (GUIDE.md), поэтому внутри conventions/ он упирался в путь `../GUIDE.md`; теперь пути даются от корня репозитория - README дополнен разделом про префиксы и строкой в таблице обвязки
This commit is contained in:
+1
-1
@@ -99,7 +99,7 @@
|
|||||||
- **Идентификаторы стабильны и не переиспользуются.** Удалённое правило
|
- **Идентификаторы стабильны и не переиспользуются.** Удалённое правило
|
||||||
оставляет дыру в нумерации; занимать её новым нельзя — иначе ссылка из
|
оставляет дыру в нумерации; занимать её новым нельзя — иначе ссылка из
|
||||||
чужого репозитория начнёт указывать на другое утверждение. То же
|
чужого репозитория начнёт указывать на другое утверждение. То же
|
||||||
относится к префиксам: выбывшие хранит `conventions/prefixes.toml`.
|
относится к префиксам: выбывшие хранит `prefixes.toml`.
|
||||||
- Префикс **выбирается под файл, а не выводится по формуле**: он нужен,
|
- Префикс **выбирается под файл, а не выводится по формуле**: он нужен,
|
||||||
чтобы по нему искать, а не чтобы его разбирать. Выводимый префикс вдобавок
|
чтобы по нему искать, а не чтобы его разбирать. Выводимый префикс вдобавок
|
||||||
привязал бы идентификатор к таксономии, которую канон перестраивает, и
|
привязал бы идентификатор к таксономии, которую канон перестраивает, и
|
||||||
|
|||||||
@@ -10,8 +10,9 @@
|
|||||||
| Файл | Что описывает |
|
| Файл | Что описывает |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `README.md` | устройство канона, оси, синхронизация, жизненный цикл |
|
| `README.md` | устройство канона, оси, синхронизация, жизненный цикл |
|
||||||
| [LANGUAGE.md](LANGUAGE.md) | язык записи правил: номера, модальность, «Почему» |
|
| [LANGUAGE.md](LANGUAGE.md) | язык записи правил: идентификаторы, модальность, «Почему» |
|
||||||
| [GUIDE.md](GUIDE.md) | как ведут конвенции: когда заводить, механизация, отступления |
|
| [GUIDE.md](GUIDE.md) | как ведут конвенции: когда заводить, механизация, отступления |
|
||||||
|
| `prefixes.toml` | реестр префиксов правил |
|
||||||
| `conv` | синхронизация копий |
|
| `conv` | синхронизация копий |
|
||||||
|
|
||||||
Обвязка живёт только в каноне и в репозитории не оказывается — `conv`
|
Обвязка живёт только в каноне и в репозитории не оказывается — `conv`
|
||||||
@@ -53,8 +54,8 @@ conventions/
|
|||||||
Пути **файлов** даются относительно `conventions/`: `arch/db-identifiers.md`,
|
Пути **файлов** даются относительно `conventions/`: `arch/db-identifiers.md`,
|
||||||
а не `conventions/arch/…` — так же, как они лягут в `docs/conventions/`
|
а не `conventions/arch/…` — так же, как они лягут в `docs/conventions/`
|
||||||
репозитория. На **правила** ссылаются идентификатором без пути: `KEYS-5`.
|
репозитория. На **правила** ссылаются идентификатором без пути: `KEYS-5`.
|
||||||
Префикс уникален по всему канону (реестр — `conventions/prefixes.toml`),
|
Префикс уникален по всему канону (реестр — `prefixes.toml`), поэтому
|
||||||
поэтому идентификатор не зависит от того, на какой оси файл лежит сегодня.
|
идентификатор не зависит от того, на какой оси файл лежит сегодня.
|
||||||
|
|
||||||
Тест — по тому, замена чего убивает правило:
|
Тест — по тому, замена чего убивает правило:
|
||||||
|
|
||||||
@@ -88,10 +89,9 @@ prefix: KEYS
|
|||||||
```
|
```
|
||||||
|
|
||||||
Четыре заглавные латинские буквы, уникальные по всему канону; реестр —
|
Четыре заглавные латинские буквы, уникальные по всему канону; реестр —
|
||||||
[`conventions/prefixes.toml`](conventions/prefixes.toml). Префикс выбирается
|
[`prefixes.toml`](prefixes.toml). Префикс выбирается под файл, а не выводится
|
||||||
под файл, а не выводится по формуле, и не переиспользуется никогда. Правила
|
по формуле, и не переиспользуется никогда. Правила адресуются идентификатором
|
||||||
адресуются идентификатором `KEYS-5` — без пути к файлу. Подробности формы —
|
`KEYS-5` — без пути к файлу. Подробности формы — `LANGUAGE.md`.
|
||||||
`LANGUAGE.md`.
|
|
||||||
|
|
||||||
## Расширение
|
## Расширение
|
||||||
|
|
||||||
|
|||||||
@@ -18,26 +18,29 @@
|
|||||||
# изменение, а не переименование;
|
# изменение, а не переименование;
|
||||||
# - тот же префикс продублирован в шапке файла (`prefix:`), conv сверяет.
|
# - тот же префикс продублирован в шапке файла (`prefix:`), conv сверяет.
|
||||||
#
|
#
|
||||||
|
# Пути даются от корня репозитория, а не от `conventions/`: реестр покрывает
|
||||||
|
# и обвязку тоже.
|
||||||
|
#
|
||||||
# Локальные правила репозиториев берут свои префиксы и объявляют их в
|
# Локальные правила репозиториев берут свои префиксы и объявляют их в
|
||||||
# `.conventions.toml` копии. Они обязаны не пересекаться с этим реестром.
|
# `.conventions.toml` копии. Они обязаны не пересекаться с этим реестром.
|
||||||
|
|
||||||
[live]
|
[live]
|
||||||
DIRS = "arch/app-directories.md"
|
DIRS = "conventions/arch/app-directories.md"
|
||||||
CONF = "arch/config.md"
|
CONF = "conventions/arch/config.md"
|
||||||
KEYS = "arch/db-identifiers.md"
|
KEYS = "conventions/arch/db-identifiers.md"
|
||||||
TIME = "arch/time.md"
|
TIME = "conventions/arch/time.md"
|
||||||
GCFG = "lang/go/config.md"
|
GCFG = "conventions/lang/go/config.md"
|
||||||
GKEY = "lang/go/db-identifiers.md"
|
GKEY = "conventions/lang/go/db-identifiers.md"
|
||||||
MIGR = "lang/go/db-schema.md"
|
MIGR = "conventions/lang/go/db-schema.md"
|
||||||
GERR = "lang/go/errors.md"
|
GERR = "conventions/lang/go/errors.md"
|
||||||
SLOG = "lang/go/logging.md"
|
SLOG = "conventions/lang/go/logging.md"
|
||||||
GTIM = "lang/go/time.md"
|
GTIM = "conventions/lang/go/time.md"
|
||||||
ANSD = "stack/ansible/app-directories.md"
|
ANSD = "conventions/stack/ansible/app-directories.md"
|
||||||
HTMX = "stack/htmx/web-ui.md"
|
HTMX = "conventions/stack/htmx/web-ui.md"
|
||||||
|
|
||||||
# Обвязка канона: не синхронизируется в репозитории, но правила
|
# Обвязка канона: не синхронизируется в репозитории, но правила
|
||||||
# записаны тем же языком и цитируются по номерам, поэтому префикс нужен.
|
# записаны тем же языком и цитируются по номерам, поэтому префикс нужен.
|
||||||
META = "../GUIDE.md"
|
META = "GUIDE.md"
|
||||||
|
|
||||||
[retired]
|
[retired]
|
||||||
# Пусто. Сюда попадают префиксы удалённых и разделённых файлов вместе с
|
# Пусто. Сюда попадают префиксы удалённых и разделённых файлов вместе с
|
||||||
Reference in New Issue
Block a user