Generator .prettierignore

Generator pliku .prettierignore

Prettier formatuje kod automatycznie, ale nie każdy plik powinien być ruszany. Plik .prettierignore wskazuje katalogi i pliki, które mają pozostać nietknięte.

Co pomijać?

Dlaczego to ważne?

Formatowanie wygenerowanych plików to strata czasu i nieczytelne różnice w repozytorium. Pominięcie ich przyspiesza Prettier i utrzymuje diffy czyste.

Przykład

Projekt Laravel z frontendem powinien pominąć vendor/, node_modules/, public/build/ i composer.lock. Dzięki temu npx prettier --write . formatuje tylko kod źródłowy.

Jak działa generator .prettierignore

Generator nie skanuje repozytorium — działa na liście wzorców. Zaznaczasz grupy plików, a narzędzie zamienia każde zaznaczenie na jedną lub kilka linii tekstu i skleja je w gotowy plik .prettierignore. Wynik to zwykły plik tekstowy, który wrzucasz do katalogu głównego projektu i trzymasz razem z kodem. Kolejność linii ma znaczenie, bo Prettier stosuje ostatni wzorzec pasujący do ścieżki — wpis ogólny umieszczony wyżej może zostać nadpisany przez wyjątek umieszczony niżej.

Składnia wzorców jest taka sama jak w .gitignore. Gwiazdka * zastępuje dowolny ciąg znaków w obrębie jednego segmentu ścieżki, podwójna gwiazdka ** przechodzi przez wiele katalogów, znak zapytania ? dopasowuje pojedynczy znak, a wykrzyknik ! na początku linii odwraca regułę i przywraca plik do formatowania. Wzorzec zakończony ukośnikiem, na przykład coverage/, obejmuje całe drzewo katalogu. Wzorzec bez ukośnika pasuje do danego segmentu ścieżki na dowolnym poziomie, dlatego warto świadomie decydować, czy kotwiczyć wpis do katalogu pliku .prettierignore.

Prettier czyta .prettierignore z katalogu, w którym uruchamiasz polecenie, a inną ścieżkę wskazujesz flagą --ignore-path. Sam plik nie zmienia reguł formatowania — nie ustawia średników, cudzysłowów ani szerokości wcięć. Odpowiada wyłącznie za to, które pliki w ogóle trafią do parsera. Dlatego pominięcie katalogu nie psuje stylu kodu, a jedynie skraca czas pracy Prettiera i ogranicza liczbę plików w diffie.

Przykład: od zaznaczeń do gotowego pliku

1. Pracujesz nad projektem Laravel z frontendem. Zaznaczasz grupę Zależności — generator wypisuje dwie linie: node_modules/ oraz vendor/.
2. Dokładasz grupę Artefakty i lista rośnie o trzy linie: dist/, build/ oraz public/build/. Łącznie masz już 2 + 3 = 5 linii.
3. Włączasz grupę Pokrycie — dochodzi jedna linia coverage/, co daje 5 + 1 = 6 linii.
4. Zaznaczasz Pliki blokad — pojawiają się package-lock.json i composer.lock, czyli 6 + 2 = 8 linii.
5. Na końcu włączasz grupę Zminifikowane — dopisują się *.min.js oraz *.min.css. Plik liczy 8 + 2 = 10 linii wzorców.
6. Chcesz jednak formatować jeden plik z katalogu dist. Dodajesz wyjątek !dist/keep.js i ustawiasz go po wpisie dist/. Wynik to 11 linii: 10 wzorców pomijających i 1 reguła przywracająca. Efekt netto: Prettier nadal pomija wszystko wskazane przez te 10 wzorców, poza dist/keep.js.

Tabela referencyjna wzorców

Jak używać pliku w praktyce

• Trzymaj plik w katalogu głównym — wtedy polecenie uruchomione z korzenia projektu widzi go bez dodatkowych flag i działa tak samo lokalnie oraz w CI.
• Grupuj wpisy i opisuj je komentarzami — linia zaczynająca się od znaku # jest komentarzem, a puste linie są pomijane, więc możesz rozdzielić zależności, artefakty i pliki blokad bez wpływu na wynik.
• Wyprzedzaj wyjątki po wzorcach ogólnych — reguła z wykrzyknikiem działa tylko wtedy, gdy stoi niżej niż wpis, który chce przywrócić; odwrotna kolejność daje efekt bez zmian.
• Sprawdzaj wynik komendą kontrolną — npx prettier --check . pokaże, które pliki wciąż wymagają formatowania, a --list-different wypisze same ścieżki. To najszybszy sposób weryfikacji, czy nowy wpis działa.
• Nie duplikuj ustawień Prettiera — .prettierignore nie zastępuje pliku .prettierrc; jeden pilnuje listy plików, drugi reguł stylu i nie należy ich mieszać.

Ograniczenia i pułapki

• Brak analizy repozytorium — generator nie wie, które katalogi faktycznie istnieją w twoim projekcie. Wpis dla nieistniejącej ścieżki jest po prostu nieszkodliwy, ale zaśmieca plik i myli kolejnych czytających.
• Brak wiedzy o konfiguracji Prettiera — .prettierrc, nadpisania per katalog i wybór parsera nie są brane pod uwagę, a właśnie one decydują, czy dany plik w ogóle jest formatowany.
• Tylko Prettier — ESLint, Stylelint czy narzędzia do CSS mają własne listy pomijania. Ten plik nie wpływa na ich działanie, mimo że składnia wzorców bywa łudząco podobna.
• Zależność od katalogu uruchomienia — jeśli polecenie puścisz z podkatalogu, Prettier może wziąć pod uwagę inny plik ignore albo żaden. W monorepo ustal jedną ścieżkę i podawaj ją jawnie flagą --ignore-path.

Najczęstsze pytania