Generator .prettierrc

Generator konfiguracji Prettier

Prettier automatycznie formatuje kod, kończąc spory o styl. Konfiguracja w pliku .prettierrc lub sekcji prettier w package.json ujednolica projekt.

Najważniejsze opcje

Jak używać?

Zapisz zawartość jako .prettierrc w katalogu głównym projektu. Uruchamiaj npx prettier --write ., a w edytorze włącz formatowanie przy zapisie.

Prettier i ESLint

Aby narzędzia się nie kłóciły, do konfiguracji ESLint dodaj eslint-config-prettier — wyłącza on reguły ESLint dotyczące formatowania.

Jak działa generator .prettierrc

Generator działa jak konwerter wyborów z formularza na obiekt konfiguracji. Każda opcja, którą zaznaczysz lub wpiszesz, jest najpierw sprawdzana pod kątem typu: przełączniki zamieniają się na wartości logiczne true albo false, pola liczbowe na liczby całkowite, a listy rozwijane na dopuszczalne wartości tekstowe. Z tych par klucz-wartość powstaje jeden obiekt, który następnie jest serializowany do formatu JSON. Kolejność kluczy nie ma znaczenia dla Prettiera, ale generator może ustawić ją w stałej kolejności, aby plik był czytelny dla człowieka.

Narzędzie nie ma wbudowanych tablic stałych ani nie narzuca wartości domyślnych. To znaczy, że wynik zależy wyłącznie od danych wprowadzonych w formularzu. Jeśli nie wybierzesz żadnej opcji, otrzymasz pusty obiekt, który dla Prettiera oznacza użycie ustawień domyślnych. Jeśli wybierzesz kilka opcji, w pliku pojawią się tylko te klucze, które faktycznie zaznaczysz lub uzupełnisz.

Gotowy plik .prettierrc jest tylko deklaracją. Prettier odczytuje go przy uruchomieniu, łączy z ustawieniami edytora i najbliższą konfiguracją nadrzędną, a następnie stosuje wybrane reguły podczas formatowania. Generator nie uruchamia Prettiera ani nie sprawdza, czy kod po sformatowaniu będzie zgodny z ESLint. Tworzy wyłącznie warstwę konfiguracyjną, którą możesz wersjonować razem z projektem.

Przykład krok po kroku

1. Otwierasz generator i ustawiasz w formularzu sześć opcji: semi na true, singleQuote na true, tabWidth na 2, printWidth na 80, trailingComma na all oraz arrowParens na always. Wartości 2 i 80 są przykładowymi decyzjami użytkownika, a nie stałymi wbudowanymi w narzędzie.
2. Generator mapuje przełączniki semi i singleQuote na wartości logiczne true. Pozostałe pola pozostają liczbami albo tekstami zgodnymi z typem opcji.
3. Narzędzie buduje jeden obiekt JSON z sześcioma parami klucz-wartość. Nie dodaje komentarzy, ponieważ standard JSON ich nie przewiduje.
4. Wynikowy plik wygląda tak: {"semi": true, "singleQuote": true, "tabWidth": 2, "printWidth": 80, "trailingComma": "all", "arrowParens": "always"}. Łącznie to 6 par klucz-wartość w 1 obiekcie.
5. Zapisujesz zawartość jako .prettierrc w katalogu głównym projektu. Od tego momentu Prettier będzie szukał tego pliku podczas formatowania plików w projekcie.
6. Uruchamiasz formatowanie, na przykład przez npx prettier --write ., i sprawdzasz, czy edytor oraz CI używają tej samej wersji Prettiera. Sam plik nie zmienia kodu, dopóki Prettier nie zostanie wywołany.

Tabela referencyjna opcji

Praktyczne wskazówki użycia

• Wersjonuj plik w repozytorium — dzięki temu każdy członek zespołu i serwer CI korzystają z tych samych reguł formatowania.
• Wybierz jeden nośnik konfiguracji — .prettierrc, .prettierrc.json albo sekcję prettier w package.json. Trzymanie kilku konkurencyjnych plików utrudnia ustalenie, która konfiguracja faktycznie działa.
• Dodaj skrypt sprawdzający w CI — uruchamiaj Prettier w trybie kontroli, aby wykrywać pliki niezgodne z konfiguracją bez automatycznego przepisywania całego kodu.
• Uzupełnij .prettierignore — pomiń katalogi generowane, zależności, build oraz pliki minifikowane, które nie powinny być formatowane.
• Ustal wersję Prettiera w projekcie — konfiguracja bez przypiętej wersji narzędzia może dawać inne wyniki po aktualizacji zależności.

Ograniczenia i czynniki zaburzające wynik

• Nie zastępuje lintera — generator tworzy wyłącznie konfigurację formatowania. Nie wykrywa błędów logicznych, nie ustawia reguł jakościowych i nie naprawia kodu.
• Nie rozstrzyga konfliktów konfiguracji — jeśli w projekcie istnieje kilka plików Prettiera albo ustawienia edytora nadpisują plik projektu, wynik może się różnić od oczekiwanego.
• Nie waliduje semantyki kodu — Prettier zmienia układ, ale nie analizuje, czy kod jest poprawny składniowo w danym środowisku. Błędy składni mogą zatrzymać formatowanie.
• Nie gwarantuje niezmienności między wersjami — nowsze wersje Prettiera mogą inaczej formatować niektóre konstrukcje, nawet przy tej samej konfiguracji. Dlatego warto przypinać wersję narzędzia.

Najczęstsze pytania