Toolverse
Wszystkie skille

code-changelog

autor: bear2u

Automatyczne dokumentowanie zmian kodu z przeglądarką HTML w czasie rzeczywistym

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Autor
bear2u
Kategoria
Frontend

O skillu

Narzędzie do śledzenia wszystkich zmian kodu generowanych przez AI. Każda modyfikacja jest automatycznie zapisywana w folderze reviews jako plik Markdown, a następnie wyświetlana w przeglądarce za pośrednictwem prostego serwera Python. Obsługuje podświetlanie składni, tryb ciemny w stylu GitHub oraz automatyczne generowanie indeksu dokumentów. Idealne dla programistów, którzy chcą mieć przejrzysty zapis historii zmian bez dodatkowych narzędzi.

Jak używać

  1. Upewnij się, że masz zainstalowany Python 3. Nie są wymagane żadne dodatkowe biblioteki — narzędzie działa z wbudowanymi modułami.

  2. W głównym katalogu projektu uruchom skrypt inicjalizacyjny: python3 create_changelog.py. Spowoduje to utworzenie struktury folderów i plików konfiguracyjnych.

  3. W swoim kodzie zaimportuj logger: from code_changelog_tracker import CodeChangeLogger. Utwórz instancję loggera, podając nazwę projektu i opis wymagań: logger = CodeChangeLogger("Nazwa projektu", user_request="Opis zmian").

  4. Po każdej zmianie kodu zaloguj ją za pomocą metod loggera, na przykład logger.log_file_creation("plik.py", "kod", "powód zmiany"), a następnie zapisz: logger.save_and_build(). Każde zapisanie generuje nowy plik Markdown w folderze reviews z datą i godziną.

  5. Aby wyświetlić dokumentację w przeglądarce, przejdź do folderu reviews: cd reviews, a następnie uruchom serwer Python: python3 -m http.server 4000. Otwórz http://localhost:4000 w przeglądarce.

  6. Serwer będzie wyświetlać wszystkie zarejestrowane zmiany w porządku chronologicznym z automatycznie generowanym indeksem. Możesz pracować nad kodem w tle, a każda nowa zmiana pojawi się na liście bez konieczności odświeżania serwera.

Podobne skille