jcb-dotenv: приложение 1
На моих примерах: как я выполняю этот стандарт в своих проектах и на своих технологиях. Не требование — соответствие проверяется только по стандарту.
Загрузка в Node
Заголовок раздела «Загрузка в Node»- Node 20.6+ умеет сам:
process.loadEnvFile(path)иutil.parseEnv(text). На старом Node —dotenv. Если фреймворк читает.envсам — им, но проверить, что он соблюдает нужный приоритет. - Приоритет при разработке «оболочка >
.env.local>.env.development»: грузить сначала.env.local, потом.env.development, не перезаписывая то, что уже задано. - В автопроверках файл главнее оболочки: прочитать файл
util.parseEnvи записать значения поверхprocess.env.
docs/env.md
Заголовок раздела «docs/env.md»Стандарт требует файл и заголовок ### `ИМЯ` на переменную. Внутри раздела удобно так:
### `MAIL_DELIVERY`
Куда идут письма.
| Значение | Что значит ||---|---|| `log` | в лог сервера || `smtp` | отправка по SMTP |
| development | test | сайт ||---|---|---|| log | log | smtp |Переменные — группами («Сервер», «База», «Почта»), в конце — «Что не в .env и почему».
Значения
Заголовок раздела «Значения»- Адрес базы и своих серверов —
127.0.0.1, а неlocalhost:localhostможет уйти в IPv6. - Секрет:
openssl rand -base64 32. В закоммиченных файлах — с говорящим префиксом (dev-secret-only-for-…), чтобы автопроверка отличала их от боевых. Смена секрета подписи cookie выкидывает всех из аккаунтов. - Публичный адрес приложения — как его видит браузер, без
/в конце: от него зависят ссылки в письмах, адреса возврата OAuth иSecureу cookie.
Переключатели
Заголовок раздела «Переключатели»- Тестовые возможности (ручки уборки, капча по заголовку, коды без интервала) — под одним
TEST_HOOKS=on|off, выключенным в шаблоне сервера. - Встроенные лимиты библиотек (например, вход 3 раза за 10 с) мешают разработке и проверкам — свой переключатель; собственные лимиты продукта работают всегда.
PostgreSQL как npm-пакет, данные в папке. Папка задана — dev и проверки поднимают базу сами; пусто — база отдельным
сервером (сайт). У каждого режима своя папка: одну папку не открыть двумя PGlite.
Что не в .env
Заголовок раздела «Что не в .env»- Правила продукта — одинаковы везде: сроки, лимиты писем.
- Списки, которые проверяются вместе с кодом (клиенты и их адреса) — в коде.
- Флаги сборки — ставит скрипт сборки.