Co to jest plik .env?

Plik .env (dotenv) jest zwykłym plikiem tekstowym służącym do przechowywania zmiennych środowiskowych aplikacji. Zawiera pary klucz‑wartość definiujące ustawienia, takie jak adresy URL baz danych, klucze API, numery portów oraz inne wartości konfiguracyjne, które powinny być oddzielone od kodu. Format pochodzi z metodologii Twelve‑Factor App, która zaleca przechowywanie konfiguracji w zmiennych środowiskowych, aby chronić wrażliwe dane przed umieszczeniem w kodzie źródłowym i ułatwić przenoszenie aplikacji pomiędzy różnymi środowiskami (development, staging, production).

Dlaczego warto walidować pliki .env?

Pliki zmiennych środowiskowych podlegają ścisłym regułom składni: nazwy zmiennych muszą składać się z wielkich liter, cyfr i podkreśleń (rozpoczynając od litery lub podkreślenia), a każde przypisanie musi mieć format KEY=value. Nieprawidłowa składnia, duplikaty zmiennych lub błędy formatowania mogą powodować, że aplikacje przestają działać cicho lub zachowują się nieprzewidywalnie. Walidacja plików .env przed wdrożeniem pozwala wykryć te problemy wcześnie, zapobiega błędom w czasie wykonywania i zapewnia prawidłowe formatowanie konfiguracji.

Opis narzędzia

Dotenv Validator jest specjalistycznym narzędziem do sprawdzania składni i struktury plików .env. Waliduje, czy plik ze zmiennymi środowiskowymi spełnia prawidłowy format, identyfikuje błędy składni wraz z konkretnymi numerami linii, wykrywa duplikaty deklaracji zmiennych oraz dostarcza statystyki dotyczące pliku konfiguracyjnego. Walidator pomaga programistom upewnić się, że ich pliki .env są poprawnie sformatowane przed użyciem ich w aplikacjach.

Funkcje

  • Walidacja składni: Sprawdza, czy wszystkie deklaracje zmiennych mają format KEY=value
  • Sprawdzanie nazw zmiennych: Zapewnia, że nazwy zmiennych składają się wyłącznie z wielkich liter, cyfr i podkreśleń
  • Wykrywanie duplikatów: Identyfikuje powtarzające się nazwy zmiennych i wskazuje ich lokalizację
  • Analiza linia po linii: Raportuje konkretne numery linii, w których wykryto błędy składni
  • Statystyki: Wyświetla łączną liczbę linii oraz liczbę prawidłowych zmiennych środowiskowych
  • Obsługa komentarzy: Poprawnie obsługuje linie komentarzy zaczynające się od #
  • Obsługa pustych linii: Ignoruje puste linie podczas walidacji

Przypadki użycia

  • Walidacja przed wdrożeniem: Sprawdza pliki .env przed wdrożeniem aplikacji, aby zapewnić brak błędów konfiguracyjnych
  • Współpraca zespołowa: Waliduje współdzielone pliki .env.example, aby utrzymać spójność wśród członków zespołu
  • Projekty migracyjne: Weryfikuje pliki zmiennych środowiskowych przy przechodzeniu między różnymi platformami wdrożeniowymi
  • Audyt konfiguracji: Przegląda i waliduje konfiguracje środowiskowe wielu usług
  • Integracja CI/CD: Waliduje pliki środowiskowe jako część zautomatyzowanych procesów budowania
  • Nauka i szkolenia: Pomaga programistom poznać prawidłowy format pliku .env oraz zasady składni
  • Rozwiązywanie problemów: Szybko identyfikuje problemy składniowe powodujące problemy z konfiguracją aplikacji

Zasady walidacji

  • Nazwy zmiennych muszą zaczynać się od litery (A‑Z) lub podkreślenia (_)
  • Nazwy zmiennych mogą zawierać wyłącznie wielkie litery, cyfry i podkreślenia
  • Każda zmienna musi mieć format KEY=value
  • Duplikaty nazw zmiennych nie są dozwolone
  • Komentarze (linijki zaczynające się od #) oraz puste linie są ignorowane
  • Każde przypisanie zmiennej powinno znajdować się w osobnej linii