Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Strona powitalna

Strona powitalna — własna strona Aggrega we własnej karcie edytora, która wyjaśnia, czym jest Aggrega, a następnie wymienia, czego rozszerzenie potrzebuje w tym obszarze roboczym, oznaczając każdy warunek jako Met lub To do. Każdy krok oferuje sposób utworzenia danej rzeczy i sposób wskazania już istniejącej, wyjaśnia warunek, a krok już spełniony o nic nie pyta. Krok oznaczony Met wraca do To do, jeśli jego warunek przestanie obowiązywać. Krok już spełniony otwiera się zwinięty, więc strona otwiera się na pozostałej pracy. Każdy krok pokazuje też swoją bieżącą wartość — katalog główny obszaru roboczego, kompilator, Release, rejestry — większą i grubszą niż wskazówki, poprzedzoną Selected:, pod tytułem, gdy krok jest zwinięty, i tuż nad przyciskami, gdy jest rozwinięty, a jeśli jeszcze nic nie wybrano, mówi o tym słowami — None selected., gdy jest z czego wybierać, None available., gdy nie ma w ogóle z czego wybierać. U dołu znajduje się pole wyboru decydujące, czy strona otwiera się przy starcie — ten sam przełącznik, który zawiera ekran ustawień — pod nim wersje uruchomionego rozszerzenia i kompilatora, a na końcu informacja, czy serwer języka działa i jaką wersję zgłasza. Ikona domu na pasku tytułu panelu Commands w dowolnej chwili ponownie ją otwiera. Nie zajmuje miejsca w widoku Aggrega.

Welcome to Aggrega! otwiera się we własnej karcie edytora. Wyjaśnia, czym jest Aggrega, a następnie wymienia, czego rozszerzenie potrzebuje w otwartym obszarze roboczym:

  1. Obszar roboczy rozpoznawany przez Aggrega — wykrywanie opisane w części Wymagania wstępne.
  2. Kompilator, który ten edytor może uruchomić — plik binarny aggrega wskazany w aggrega.server.binaryPath.
  3. Encja Release, na której ma się działać — budowanie, podgląd i graf topologii działają każde na jednej encji Release.
  4. Rejestr, z którego następuje rozwiązywanie — pobieranie zależności i przeszukiwanie opublikowanego katalogu rozwiązują je względem rejestrów wskazanych w konfiguracji.

Każdy krok wyjaśnia, czemu służy warunek i jak edytor go spełnia, więc strona jest miejscem, w którym można przeczytać o produkcie, a nie tylko listą kontrolną.

Karta Welcome to Aggrega! w folderze, którego Aggrega jeszcze nie rozpoznaje, z pierwszym krokiem, Obszar roboczy rozpoznawany przez Aggrega, oznaczonym jako do zrobienia i rozwiniętym na wyjaśnieniu.

Każdy krok oferuje więcej niż jedną drogę, a jedną z nich jest zawsze „już to mam”. Można utworzyć konfigurację obszaru roboczego lub wskazać edytorowi folder, który już ją zawiera; użyć kompilatora z PATH, wybrać kompilację znajdującą się gdzie indziej lub pobrać ją; utworzyć szkic encji Release lub wybrać jedną z własnych; zainicjować oficjalny hub, wskazać własny rejestr lub dodać rejestr do już istniejącej konfiguracji. Nie ma tu ślepych zaułków, które podsuwają okno dialogowe wyboru pliku i zostawiają krok nadal do wykonania.

Krok już spełniony jest odhaczony i o nic nie pyta. Strona odczytuje rzeczywisty stan, zamiast zadawać wszystkim te same pytania, więc jeśli konfiguracja została zbudowana z wiersza poleceń, a edytor otwarty później, wszystkie kroki są już odhaczone.

Każdy krok można zwinąć, a strona otwiera się, pokazując to, co jest jeszcze potrzebne. Strzałka w prawym górnym rogu każdego kroku rozwija go i zwija. Krok, którego warunek jest już spełniony, otwiera się zwinięty, a niespełniony otwiera się z wyjaśnieniem na wierzchu — dzięki temu czyta się o pracy, która jeszcze pozostała, a nie o tej już wykonanej. Zwinięty krok zachowuje swój tytuł i wszystkie przyciski, ukrywając jedynie wyjaśnienie: gdy wiadomo już, czemu krok służy, można z niego skorzystać bez ponownego czytania.

Układ jest ustalany przy tworzeniu strony, a potem należy do użytkownika. Krok, który zostaje spełniony w trakcie czytania, aktualizuje swój znacznik i pozostaje rozwinięty — nie zwija się pod kursorem — a naciśnięta strzałka pozostaje w ustawionym położeniu, niezależnie od tego, ile razy strona wokół niej się odświeży. Zamknięcie i ponowne otwarcie strony ponownie odczytuje warunki i układa ją od nowa. Tak samo dzieje się ze stroną rysowaną w miejsce otwartej, gdy edytor ponownie uruchamia rozszerzenia — jak wtedy, gdy do okna otwartego na jednym folderze dodaje się folder: dotychczasowa strona zostaje zamknięta, a nowa rysowana w tej samej grupie kart, niezależnie od tego, czy strona ma się otwierać przy starcie, więc okno nadal zawiera jedną stronę, a ta strona podąża za bieżącym obszarem roboczym.

Każdy krok pokazuje też swoją bieżącą wartość, więc strona odpowiada na pytanie który, a nie tylko czy: katalog główny obszaru roboczego, kompilator, Release i rejestry deklarowane przez konfigurację. Wartość jest większa i grubsza niż otaczające ją wyjaśnienie, ponieważ wartości narysowanej tą samą grubością co ściana tekstu trzeba szukać. Zwinięty krok pokazuje ją pod tytułem, dzięki czemu można potwierdzić wybór bez rozwijania czegokolwiek; rozwinięty pokazuje ją na końcu wyjaśnienia, tuż nad przyciskami, gdzie jest ostatnią rzeczą czytaną przed działaniem. Wybraną wartość poprzedza Selected:, mniejsze i jaśniejsze od samej wartości, dzięki czemu etykieta wskazuje na wartość, a nie z nią konkuruje.

Strona powitalna w skonfigurowanym obszarze roboczym, z krokami kompilatora, encji Release i rejestru oznaczonymi jako spełnione i zwiniętymi, z których każdy pokazuje wybraną wartość nad przyciskami, a u dołu pole wyboru uruchamiania, wersje i stan serwera języka.

Jeśli jeszcze nic nie wybrano, krok mówi o tym słowami, zamiast zostawiać pustą linię, która wyglądałaby jak błąd rysowania strony — i rozróżnia dwa stany, na które czytelnik reaguje inaczej. None selected. oznacza, że jest z czego wybierać, ale nic nie wybrano. None available. oznacza, że nie ma tu w ogóle z czego wybierać, więc naciśnięcie „I already have one” w tym kroku pokazałoby tylko pustą listę, a potrzebna jest jego druga droga. Tylko dwa kroki oferujące listę mogą pokazać None available. — obszar roboczy i Release. Kompilator jest wskazywany po nazwie, a rejestr rejestrowany bezpośrednio, więc żaden z tych kroków nie ma listy, która mogłaby być pusta. Krok rejestru ma trzeci odczyt, Not read yet., na wypadek gdy nie można było zapytać kompilatora: stwierdzenie, że niczego nie skonfigurowano, gdy nic nie mogło odpowiedzieć, mówiłoby więcej, niż strona wie.

Znacznik kroku podąża za jego warunkiem w obu kierunkach. Każdy krok podaje swój stan słowami obok znacznika — Met lub To do — ponieważ sam znacznik jest glifem, a sam glif pozostawia swoje znaczenie do odgadnięcia. Krok pokazuje Met, gdy jego warunek staje się prawdziwy, i ponownie To do, jeśli warunek później przestanie obowiązywać — kompilator przestaje odpowiadać, wybór encji Release zostaje cofnięty. Strona przy każdym odświeżeniu odczytuje rzeczywisty stan, zamiast pamiętać, co kiedyś było prawdą, więc nigdy nie zgłasza czegoś, co zostało od tego czasu utracone. Gdy utrata ma znaczenie, jest też zgłaszana tam, gdzie użytkownik już patrzy: pasek stanu pokazuje kompilator, który przestał odpowiadać, a wiersze Project folder, Aggrega workspace i Release u góry panelu Commands wskazują bieżący wybór.

Celowo jest to zwykła karta edytora, a nie okno dialogowe: każdy krok prosi o wskazanie czegoś we własnym obszarze roboczym, a okno dialogowe zasłaniałoby pliki zawierające odpowiedzi. Znajduje się w obszarze edytora, a nie w widoku Aggrega, więc nie zajmuje miejsca na pasku bocznym i może wyjaśnić, czym jest produkt — na co wąska kolumna nie ma miejsca. Jest to własna karta Aggrega, otwierana i zamykana na własnych zasadach, i nie oferuje przejścia do strony powitalnej samego edytora.

Strona ma tę decyzję u dołu, pośrodku, i ma ją również paleta poleceń. Obie zmieniają to jedno ustawienie, aggrega.getStarted.show, zapisywane w ustawieniach użytkownika — nigdy w repozytorium, więc wybór nie trafia do nikogo innego, kto je otworzy. Kontrolka u dołu to pole wyboru z etykietą Show Aggrega welcome page on startup, zaznaczone, gdy strona otwiera się przy starcie — pokazuje więc ustawienie w jego bieżącym stanie, zamiast oferować czynność, która by je zmieniła. Wyłączenie go na ekranie ustawień zmienia pole wyboru; naciśnięcie pola wyboru zmienia ekran ustawień. To jeden przełącznik w dwóch miejscach, a nie dwa przełączniki. Po naciśnięciu pole wyboru zachowuje fokus klawiatury, więc klawisz Space na przemian je zaznacza i odznacza.

Wyłączenie go tylko zatrzymuje otwieranie strony przy starcie, a nie czyni jej niedostępną, i nie są to drzwi w jedną stronę: Aggrega: Get started w palecie poleceń włącza je z powrotem i otwiera stronę, a Aggrega: Stop opening the welcome page on startup to własna droga palety do tego samego ustawienia.

Panel Commands ma drogę powrotu do strony obok koła zębatego. Jest to ikona domu w prawym górnym rogu, a jej etykietka brzmi Open the welcome page — powrót do strony można więc znaleźć, patrząc na widok Aggrega, zamiast trzeba było wiedzieć, co wpisać. Otwiera stronę i pozostawia ustawienie startowe dokładnie tam, gdzie je ustawiono: ponowne obejrzenie strony nie włącza go z powrotem. Robi to polecenie palety, ponieważ ponowne włączenie jest decyzją, a nie rzutem oka.

Strona podaje u dołu, co jest uruchomione. Są tam dwa odczyty wersji: Extension, czyli którą kompilację tego rozszerzenia wczytał edytor, oraz Compiler, czyli co o sobie mówi plik binarny aggrega uruchomiony przez serwer języka. Odczyt Extension jest zapisywany podczas budowania rozszerzenia, na podstawie stanu jego źródeł w tym momencie, w tej samej postaci, w jakiej własna kompilacja kompilatora zapisuje swoją wersję — więc okno deweloperskie, zainstalowana kopia i kopia spakowana z edytowanego drzewa podają, czym każda z nich jest:

  • sam tag wydania, np. 0.2.0, oznacza, że kompilacja jest dokładnie tym wydaniem;
  • tag, po którym następuje liczba i commit, np. 0.2.0-3-g1a2b3c4, oznacza kompilację z commita 1a2b3c4, trzy commity po tym wydaniu — a sam commit, np. 1a2b3c4, oznacza kompilację z tego commita, gdy nie poprzedza go żadne wydanie;
  • przyrostek -dirty przy dowolnym z nich oznacza, że kompilację wykonano z kopii źródeł zawierającej niezatwierdzone zmiany;
  • dev oznacza, że kompilację wykonano tam, gdzie nie można było odczytać historii źródeł.

Żaden z odczytów nie jest zapisany w stronie — oba są odczytywane podczas rysowania strony, więc kompilacja deweloperska zgłasza się jako taka, zamiast nic nie pokazywać, a ponowne uruchomienie z innym kompilatorem zmienia odczyt. Jeśli odczytu nie da się uzyskać — rozszerzenie zbudowano bez zapisania, która to kompilacja, nic nie jest uruchomione, by je zapytać, lub uruchomiony program nie odpowiedział — etykieta pozostaje i informuje, że wersja nie została zgłoszona, więc brakujący odczyt nigdy nie zostanie wzięty za taki, którego nie zauważono.

Ostatni wiersz strony mówi, czy serwer języka działa i która to kompilacja. Brzmi Language server running, starting, not running lub failed to start, tymi samymi słowami, których używają pasek stanu i powiadomienia; failed to start oznacza, że ostatnia próba uruchomienia się nie powiodła i od tego czasu nic nie działało. Przyczynę podaje kanał wyjściowy Aggrega, a także powiadomienie wyświetlane, gdy nie powiedzie się pierwsze uruchomienie lub ponowne uruchomienie. Gdy serwer działa, wiersz dodaje wersję, którą działający serwer zgłosił o sobie, gdy rozszerzenie się z nim połączyło, zapisaną tak, jak wersję zapisuje odczyt Compiler. Odczyt Compiler powyżej to inny fakt: to, co mówi zapytany plik binarny, z którego uruchomiono serwer, a te dwie wartości różnią się, gdy plik pod tą ścieżką zostanie zastąpiony, podczas gdy uruchomiony z niego serwer nadal działa, dlatego strona pokazuje obie. Serwer języka, który nie zgłasza własnej wersji, pokazuje tam version not reported, zamiast zapożyczać wersję pliku binarnego. Wiersz i dwa odczyty nad nim podążają za serwerem, gdy się uruchamia, zatrzymuje, uruchamia ponownie lub kończy się niepowodzeniem, bez ponownego otwierania strony; kroki zachowują swoje znaczniki podczas ponownego uruchomienia.