nindent a indent w praktyce

YAML używa spacji do wskazywania struktury, dlatego blok wstawiony na niewłaściwym poziomie uszkadza plik. Helm udostępnia pomocnicze funkcje do prawidłowego stosowania indent.

Funkcja indent dodaje stałą liczbę spacji na początku każdego wiersza w ciągu znaków, przesuwając cały blok w prawo.

Jest jednak pewien szczegół: indent przesuwa każdy wiersz, ale nie dodaje początkowego znaku nowego wiersza. Pierwszy wiersz trafia dokładnie tam, gdzie znajduje się akcja.

Funkcja nindent wykonuje takie samo wcięcie, ale najpierw wypisuje znak nowego wiersza, dzięki czemu blok zaczyna się poprawnie w osobnym wierszu.

Początkowy znak nowego wiersza dodawany przez nindent oznacza, że nie trzeba zostawiać końcowej spacji ani zgadywać wyrównania po kluczu znajdującym się w tym samym wierszu.

Po nindent najczęściej sięga się podczas umieszczania bloku toYaml pod kluczem, ponieważ ta funkcja porządnie układa wyrenderowaną mapę poniżej klucza.

Liczbę należy wyznaczać, licząc spacje od nadrzędnego klucza, a nie od kolumny zero. Element zagnieżdżony o dwa poziomy zwykle wymaga nindent 4.

Zwykły indent sprawdza się, gdy blok już zaczyna się w osobnym wierszu, więc nie jest potrzebny dodatkowy znak nowego wiersza przed nim.

Większość poziomów zagnieżdżenia YAML zwiększa wcięcie o dwie spacje. Pomylenie wartości nindent o dwa jest najczęstszą przyczyną nieparsowalnego chartu.

Nie należy zgadywać poziomu zagnieżdżenia. Trzeba uruchomić helm template i odczytać surowy wynik, aby potwierdzić, że wstawiony blok jest wyrównany względem nadrzędnego klucza.

Obie funkcje odczytują ciąg znaków z potoku po swojej lewej stronie, dlatego naturalnie współpracują z toYaml przy formatowaniu całej mapy w manifeście.

Po kluczu w tym samym wierszu zapisano {{ toYaml .Values.env | indent 4 }}, a YAML jest niepoprawny.

Wiadomo już, że indent dodaje wcięcie do bloku, nindent najpierw dodaje znak nowego wiersza, a renderowanie jest najlepszym sposobem potwierdzenia poziomu zagnieżdżenia. 🧹