Jak tworzyć szablony projektów i rozszerzenia dla Visual Studio 2019

Cześć!

Ostatnio stworzyłem dwa szablony projektów dla Vue JS + Asp.Net Core, oba jako rozszerzenia Visual Studio 2019. Zostały udostępnione na rynku Visual Studio, jak widać pod linkiem poniżej:

  • Szablon Vue JS + Asp.Net Core 3.1

Czy chcesz wiedzieć, jak utworzyć własne rozszerzenie i opublikować własny szablon? Jeśli tak, reszta artykułu to krok po kroku, jak to zrobić.

Tworzenie projektu

Pierwszą rzeczą, którą musisz zrobić, to stworzyć projekt, który chcesz udostępnić jako szablon. W tym artykule pokażę krok po kroku, korzystając z projektu Vue JS + Asp.Net Core, który już opublikowałem.

Eksport projektu

Po utworzeniu projektu w Visual Studio 2019 przejdź do opcji menu Projekt i wybierz opcję „Eksportuj szablon”:

Istnieją dwa typy szablonów: Szablon projektu i Szablon elementu. Ponieważ w naszym przypadku tworzymy szablon projektu, wybrałem podstawową opcję:

Następnym krokiem jest skonfigurowanie nazwy, opisu, ikony, która będzie pokazywana użytkownikom oraz podgląd obrazu. Naprawdę ważne jest prawidłowe ustawienie tych informacji, tak wysoko jak to możliwe, ponieważ będą one widoczne dla użytkowników końcowych, którzy pobiorą i zainstalują twój szablon / rozszerzenie.

I odznacz opcję „Automatycznie importuj do Visual Studio”. W ten sposób będziesz mógł zainstalować tworzone rozszerzenie.

Na koniec proces wygeneruje zwarty folder, który zawiera sam szablon, ale to nie koniec tworzenia:

Definicja tagów

Kiedy tworzymy nowy projekt w Visual Studio 2019, szablony pojawiają się wraz z niektórymi określonymi znacznikami, które pomagają nam filtrować szablony:

Od najnowszej wersji programu Visual Studio 2019 tagi te są obowiązkowe dla tych, którzy chcą opublikować rozszerzenie. Bez nich rozszerzenie zostanie zainstalowane, ale szablon nigdy nie będzie wyświetlany na liście, nawet jeśli użytkownik go przeszuka.

Aby utworzyć te tagi, otwórz folder kompaktowy wygenerowany za pomocą szablonu w ostatnim kroku i otwórz plik .vstemplate za pomocą edytora tekstu:

W sekcji „Dane szablonu” dodaj po znaczniku „ProvideDefaultName” odwołanie do listy znaczników do szablonu, takie jak platforma, typ projektu, język itp. W moim przypadku podałem w następujący sposób:

Pełna dostępna lista tagów znajduje się pod linkiem poniżej:

Utworzenie rozszerzenia

Po utworzeniu szablonu i ustawieniu tagów nadszedł czas, aby utworzyć plik instalacyjny rozszerzenia.

W tym celu wystarczy utworzyć projekt typu VSIX Project:

To jest podstawowa struktura projektu:

PS: jednak nazwa projektu została utworzona przy użyciu pewnych znaków specjalnych jako „+”, tylko w celach dydaktycznych, unikaj tego w prawdziwych scenariuszach. Lepiej jest tworzyć bez pustych spacji i znaków specjalnych, takich jak: TemplateVueJSAspNetCoreArtigoMedium, zamiast nazwy, którą umieszczam. Zapobiegnie to problemom z kompilacją, ponieważ VS wygeneruje automatycznie przestrzenie nazw i klasy przy użyciu tej nazwy.

Uwzględnij w katalogu głównym odniesienie folderu kompaktowego do szablonu. Ważne jest, aby folder kompaktowy zawierał zmiany pliku .vstemplate przy użyciu tagów, o których wspomniałem wcześniej. Nie zapomnij o tym.

Ten projekt ma plik manifestu, który będzie zawierał informacje na temat instrukcji instalacji rozszerzenia e.

Jeśli klikniesz dwukrotnie ten plik, zostanie on otwarty jak formularz, który możesz wypełnić pole po polu.

Zmieniaj ostrożnie wszystkie niezbędne informacje o jakości, ponieważ pojawią się one również dla użytkownika końcowego w instalacji i na rynku. Konieczne jest również prawidłowe określenie pola „Autor”, ponieważ zwykle ma on nazwę LAPTOP.

Następnie kliknij „Zasoby”:

Usuń istniejące zasoby, jeśli są, i kliknij „Nowy”:

Wybierz opcje, które umieściłem, aw ścieżce określ folder kompaktowy dodany do projektu.

Pokolenie

Aby utworzyć plik instalacyjny, wystarczy zbudować projekt w trybie wydania. Wygeneruje plik .exe użyty do zainstalowania rozszerzenia na VS.

Gotowe! Nasze rozszerzenie zostało utworzone. Możesz to przetestować teraz, zanim opublikujesz na rynku Visual Studio marketplace, aby sprawdzić, czy wszystko działa poprawnie.

Visual Studio Market Publish

Jeśli chcesz opublikować swoje rozszerzenie publicznie, możesz to zrobić w Visual Studio Marketplace.

Aby to zrobić, przejdź do marketplace.visualstudio.com, a po zalogowaniu się na swoje konto Microsoft przejdź do poniższych opcji:

Prześlij plik .exe swojego rozszerzenia:

Wypełnij formularz szablonem i informacjami o rozszerzeniu. Ponieważ informacje te będą publiczne, zwróć szczególną uwagę.

Po zakończeniu procesu zapisz i poczekaj na proces zatwierdzenia. To może potrwać kilka minut.

Wniosek

Mam nadzieję, że ten artykuł ci pomógł. Dziękuję za przeczytanie.

Poniżej znajdują się moje profile w mediach społecznościowych. Skontaktuj się i zadaj pytanie. W tych profilach często udostępniam treści na temat technologii internetowych i wydarzeń IT.

Twitter: https://twitter.com/alemalavasi Linkedin: https://www.linkedin.com/in/alexandremalavasi/

Niedawno utworzyłem również kanał na YouTube, aby wspierać społeczność techniczną również przy użyciu tej platformy, skupiając się na .NET Core, Vue JS, Azure i innych. Jeśli jesteś zainteresowany tymi tematami, polecam subskrybować. Wkrótce będą regularnie udostępniane treści, a ja konfiguruję audio, wideo i treści, aby zapewnić Ci wysoką jakość.

Link: https://www.youtube.com/channel/UC-KFGgYiot1eA8QFqIgLmqA