av
840904d454
- реестр покрывает и обвязку тоже (GUIDE.md), поэтому внутри conventions/ он упирался в путь `../GUIDE.md`; теперь пути даются от корня репозитория - README дополнен разделом про префиксы и строкой в таблице обвязки
48 lines
2.9 KiB
TOML
48 lines
2.9 KiB
TOML
# Реестр префиксов правил.
|
|
#
|
|
# Префикс — четыре заглавные латинские буквы, уникальные по всему канону.
|
|
# Он выбирается под файл, а не выводится по формуле: префикс нужен, чтобы
|
|
# по нему искать, а не чтобы его разбирать. Поэтому подходящее слово лучше
|
|
# закономерности.
|
|
#
|
|
# Правила реестра:
|
|
#
|
|
# - префикс не переименовывается и не переиспользуется никогда — ссылка
|
|
# из чужого репозитория обязана продолжать указывать на то же место;
|
|
# - при удалении или разделении файла префикс уходит в [retired], а не
|
|
# освобождается;
|
|
# - переезд файла между осями префикс не меняет: идентификатор правила
|
|
# не зависит от таксономии;
|
|
# - вынос части правил в новый файл — это новый префикс и новая
|
|
# нумерация: перенос правила между документами есть смысловое
|
|
# изменение, а не переименование;
|
|
# - тот же префикс продублирован в шапке файла (`prefix:`), conv сверяет.
|
|
#
|
|
# Пути даются от корня репозитория, а не от `conventions/`: реестр покрывает
|
|
# и обвязку тоже.
|
|
#
|
|
# Локальные правила репозиториев берут свои префиксы и объявляют их в
|
|
# `.conventions.toml` копии. Они обязаны не пересекаться с этим реестром.
|
|
|
|
[live]
|
|
DIRS = "conventions/arch/app-directories.md"
|
|
CONF = "conventions/arch/config.md"
|
|
KEYS = "conventions/arch/db-identifiers.md"
|
|
TIME = "conventions/arch/time.md"
|
|
GCFG = "conventions/lang/go/config.md"
|
|
GKEY = "conventions/lang/go/db-identifiers.md"
|
|
MIGR = "conventions/lang/go/db-schema.md"
|
|
GERR = "conventions/lang/go/errors.md"
|
|
SLOG = "conventions/lang/go/logging.md"
|
|
GTIM = "conventions/lang/go/time.md"
|
|
ANSD = "conventions/stack/ansible/app-directories.md"
|
|
HTMX = "conventions/stack/htmx/web-ui.md"
|
|
|
|
# Обвязка канона: не синхронизируется в репозитории, но правила
|
|
# записаны тем же языком и цитируются по номерам, поэтому префикс нужен.
|
|
META = "GUIDE.md"
|
|
|
|
[retired]
|
|
# Пусто. Сюда попадают префиксы удалённых и разделённых файлов вместе с
|
|
# причиной и датой, чтобы их нельзя было выдать повторно.
|