organize-modules

Skill do organizacji modułów Rust zgodnie z najlepszymi praktykami. Pomaga zastosować wzór prywatnych modułów z publicznymi re-eksportami (barrel export), który ukrywa wewnętrzną strukturę i udostępnia stabilne API. Zawiera wskazówki dotyczące warunkowej widoczności dla dokumentacji i testów. Użyj przy tworzeniu nowych modułów, refaktoryzacji struktury mod.rs lub przed commitami zmian modułów.

1. Zidentyfikuj moduł lub plik mod.rs, który chcesz zorganizować. Skill działa najlepiej przy tworzeniu nowych modułów, refaktoryzacji istniejącej struktury lub przed commitami zmian dotyczących organizacji kodu.

2. Zastosuj wzór prywatnych modułów z publicznymi re-eksportami: zadeklaruj moduły jako prywatne (mod constants; mod types;), a następnie udostępnij je publicznie poprzez pub use (pub use constants::*;). To ukrywa wewnętrzną strukturę i zapewnia czysty interfejs dla użytkowników.

3. Jeśli pracujesz z dużym plikiem mod.rs, gdzie ręczne wyrównanie i organizacja mają znaczenie semantyczne, dodaj dyrektywę #![rustfmt::skip] na początku pliku, aby zapobiec automatycznemu przeformatowaniu.

4. Pogrupuj powiązane elementy logicznie: moduły stałych razem, moduły typów razem, moduły pomocnicze razem. Ta organizacja ułatwia czytanie i utrzymanie kodu.

5. Sprawdź, czy wszystkie publiczne re-eksporty są celowe i nie narażają niepotrzebnie wewnętrznych szczegółów implementacji. Celem jest zapewnienie stabilnego API, które można refaktoryzować wewnętrznie bez zmian dla użytkowników.

6. Przed committem zmian modułów upewnij się, że struktura jest spójna i że dokumentacja (jeśli istnieje) prawidłowo odzwierciedla publiczny interfejs.