• jakubsporna

terraform-docs zsh plugin

Pracując z terraform'em tworząc moduły chcąc dopełnić całość dokumentacją skorzystałem z terraform-docs.

Jest to narzędzie, które na podstawie kodu generuje dokumentację zawierającą opis:

  • zmiennych wejściowych (inputs),

  • wyjściowych (outputs) ,

  • dostawców (providers)

  • wymagań (requirements)

Samo użycie narzędzie jest bardzo proste:

terraform-docs markdown table . > README.md

dzięki czemu zostanie wygenerowana dokumentacja do pliku README.md w formacie markdown w postaci tabel na postawie plików .tf w bieżącym katalogu.


Stworzyłem wtyczkę do zsh, uzupełniającą komendy i flagi. Postanowiłem jej kod udostępnić publicznie w serwisie Github:


https://github.com/jsporna/terraform-docs-zsh-plugin


PS

Samo narzędzie posiada komendę completetion do skonfigurowania bash i zsh ale zostało dodane później niż powstała ta wtyczka.

20 wyświetlenia
  • LinkedIn

©2020 by Jasper Solutions. Proudly created with Wix.com