Что такое файл .env?

Файл .env (dotenv) — это текстовый файл конфигурации, используемый для хранения переменных окружения для приложений. Он содержит пары ключ-значение, которые определяют настройки, такие как URL базы данных, API-ключи, номера портов и другие конфигурационные значения, которые должны оставаться отдельно от вашего кода. Формат возник из методологии Twelve-Factor App, которая рекомендует хранить конфигурацию в переменных окружения, чтобы держать конфиденциальные данные вне исходного кода и делать приложения легко переносимыми между различными средами (разработка, тестирование, производство).

Зачем проверять файлы .env?

Файлы переменных окружения следуют строгим правилам синтаксиса: имена переменных должны использовать заглавные буквы, цифры и подчеркивания (начинаясь с буквы или подчеркивания), и каждое присваивание должно следовать формату KEY=value. Неверный синтаксис, дублирующиеся переменные или ошибки форматирования могут привести к тому, что приложения не запустятся или будут вести себя непредсказуемо. Проверка файлов .env перед развертыванием помогает выявить эти проблемы на ранней стадии, предотвращает ошибки выполнения и гарантирует правильное форматирование конфигурации.

Описание инструмента

Валидатор Dotenv — это специализированный инструмент для проверки синтаксиса и структуры файлов .env. Он проверяет, что файл переменных окружения следует правильному формату, определяет синтаксические ошибки с указанием конкретных номеров строк, обнаруживает дублирующиеся объявления переменных и предоставляет статистику о вашем файле конфигурации. Валидатор помогает разработчикам убедиться, что их файлы .env правильно отформатированы перед использованием в приложениях.

Возможности

  • Проверка синтаксиса: Проверяет, что все объявления переменных следуют формату KEY=value
  • Проверка имен переменных: Гарантирует, что имена переменных используют только заглавные буквы, цифры и подчеркивания
  • Обнаружение дубликатов: Выявляет дублирующиеся имена переменных и показывает их расположение

Правила валидации

Валидатор применяет следующие стандарты файлов .env:

  • Имена переменных должны начинаться с буквы (A-Z) или подчеркивания (_)
  • Имена переменных могут содержать только заглавные буквы, цифры и подчеркивания
  • Каждая переменная должна следовать формату KEY=value
  • Дублирующиеся имена переменных не допускаются
  • Комментарии (строки, начинающиеся с #) и пустые строки игнорируются
  • Каждое присваивание переменной должно быть на отдельной строке