Jak utrzymywać ADL z wykorzystaniem VSCode?

21.11.2022

Jako programista często wykorzystuję różne narzędzia. Tak było tym razem, gdy MS wypuścił swoje nowe LEKKIE narzędzie Visual Studio Code. Nie czekałem zbyt długo by skosztować.

I wiesz co? Nie żałuję. VSCode wpadło do mojego kanonu narzędzi. I bardzo sobie go cenie.

Zwłaszcza że można bardzo mocno rozszerzać jego możliwości.

Takim ciekawym rozszerzeniem jest adr-tools.

O ADRach pisałem więcej w moim poście tutaj -> Jak używać ADL i ADR w projekcie?.

To rozszerzenie pozwala na utrzymywanie ADL z wykorzystaniem VSCode.

Trochę automatyzacji nie zaszkodzi…

Jak przygotować VSCode?

Oczywiście trzeba zainstalować dodatek.

Jest to bardzo proste. Wystarczy użyć ikonki extensions i następnie wyszukać adr-tools.

Instalacja dodatku adr-tools w VSCode Po instalacji powinieneś mieć dostęp do polecenia adr-tools w Command Palette.

Command Palette po instalacji adr-tools

Utworzenie ADL z wykorzystaniem adr-tools.

Pierwsze użycie będzie wiązało się z użyciem polecenia ADR Init.

Po wyborze otrzymasz pytanie gdzie składować Twoja dokumentację?

Ustawianie katalogu dla ADLa

Ustawiasz wedle uznania. Ja wybrałem katalog doc\adl

Następnie trzeba wskazać domyślną templatkę dla wpisów ADR.

Ustawianie templatki dla ADRów

Ja użyję tej sugerowanej. Twój wybór może być oczywiście inny. Możesz przygotować własną templatke zgodnie z własnymi upodobaniami.

Ostatni krok to wskazanie katalogu, w którym znajdzie się templatka. Ja tutaj też zatwierdzam enterem i przechodzę dalej.

To był ostatni krok i moim oczom ukazały się dwa katalogi jak na zrzucie.

Po utworzeniu ADLa

Jest templatka i poniżej pierwszy wpis z numerem 0000…

Tworzenie ADRów.

Dodawanie kolejnego wpisu to już użycie ADR New.

Dodawanie nowego ADRa

Po wyborze polecenia dodawania ADRa.

Należy wprowadzić jego nazwę, jaka będzie znajdować się po kolejnym numerze identyfikacyjnym.

Ustawianie nazwy nowego ADRa

Następnie określić status.

Ustawienie statusu ADRa

Możemy wskazać relację do jakiegoś innego wpisu. Ja tutaj wybieram None.

Ustawienie relacji z innym ADRem

Natomiast jeżeli wybierzesz inną opcję. To będziesz musiał wskazać powiązanego ADRa.

I tak oto dodałem kolejny wpis.

Nowy wpis dodany

Pozostałe polecenia

Oczywiście pozostałe polecenia także są pomocne. Możesz na przykład powiązać istniejące ADRy przy pomocy polecenia ADR Link. Wskazujesz wówczas: ADR źródłowy, relację i ADR docelowy.

Możliwa jest też zmiana statusu przy pomocy ADR Status. Wówczas wskazujesz ADRa do zmiany i ustawiasz status, jaki chcesz.

Możesz też wygenerować dokumentację z wykorzystaniem Adr Generate documentations. To jednak już pozostawiam Twoim własnym eksperymentom.

O konfiguracji

Konfiguracja, jaką ustawiłeś podczas użycia ADR Init. Znajduje się w .vscode/settings.json.

Konfigurowanie adr-tools

Możesz ją zmienić jeżeli, jest taka potrzeba.

PS: Co sądzisz o ADLach w VSCode i samym narzędziu adr-tools?

PS: Więcej o ADL i ADR znajdziesz w moim poście: Jak używać ADL i ADR w projekcie?

PS: Zainteresował cię temat? Zajrzyj do mojego newslettera: Model C4.


Zapisz się na listę :)