{"id":231156,"date":"2022-12-29T17:55:00","date_gmt":"2022-12-29T14:55:00","guid":{"rendered":"https:\/\/wordpress.mediadoma.com\/?p=231156"},"modified":"2022-12-29T17:56:51","modified_gmt":"2022-12-29T14:56:51","slug":"pisanie-lepszego-kodu-wordpress-phpstan","status":"publish","type":"post","link":"https:\/\/wordpress.mediadoma.com\/pl\/pisanie-lepszego-kodu-wordpress-phpstan\/","title":{"rendered":"Pisanie lepszego kodu WordPress: PHPStan"},"content":{"rendered":"\n

W najnowszym po\u015bcie z tej serii (kt\u00f3ry jest co prawda jaki\u015b czas temu) pisa\u0142em obszernie o Composerze<\/a> i jego pliku blokuj\u0105cym.<\/a><\/p>\n

Polecam przeczytanie dw\u00f3ch poprzednich artyku\u0142\u00f3w, poniewa\u017c Composer w ko\u0144cu odegra rol\u0119 w tym materiale, kt\u00f3rym udost\u0119pnimy ten i przysz\u0142e posty. Ale je\u015bli zdecydujesz si\u0119 ich nie dogoni\u0107 (lub znasz ju\u017c Composer), to sedno poprzednich post\u00f3w jest odpowiednio nast\u0119puj\u0105ce:<\/p>\n

\n

Nie polecam sprawdzania katalogu dostawc\u00f3w w swoim repozytorium. Mo\u017ce to sta\u0107 si\u0119 p\u00f3\u017aniej ogromnym katalogiem i mo\u017ce podwa\u017cy\u0107 ca\u0142y cel Composera.<\/p>\n

Kompozytor<\/a><\/p>\n

Celem jest upewnienie si\u0119, \u017ce ka\u017cdy z nich korzysta z tej samej wersji zale\u017cno\u015bci projektu \u2013 nie starsze wersje, nie nowsze wersje \u2013 ale ta sama wersja.<\/p>\n

Plik blokady kompozytora<\/a><\/p>\n<\/blockquote>\n

Maj\u0105c to na uwadze, istnieje wiele zale\u017cno\u015bci lub pakiet\u00f3w, kt\u00f3re mo\u017cemy zainstalowa\u0107, kt\u00f3re pomog\u0105 nam upewni\u0107 si\u0119, \u017ce piszemy kod najwy\u017cszej mo\u017cliwej jako\u015bci.<\/p>\n

Jasne, niekt\u00f3re z nich mog\u0105 mie\u0107 form\u0119 czego\u015b w rodzaju standard\u00f3w kodowania, ale tak naprawd\u0119 s\u0105 to bardziej zasady ni\u017c elementy pisania wysokiej jako\u015bci kodu (cho\u0107 nie s\u0105dz\u0119, aby by\u0142y pomijane w dyskusji \u2013 po prostu pomini\u0119te w tej chwili \ud83d\ude43).<\/p>\n

Wr\u00f3\u0107 do narz\u0119dzi, o kt\u00f3rych mowa: Jakie s\u0105 narz\u0119dzia, kt\u00f3re pomagaj\u0105 pisa\u0107 wysokiej jako\u015bci kod WordPress? Podziel\u0119 si\u0119 kilkoma z moich ulubionych i opowiem o tym, jak mo\u017cemy je wszystkie wykorzysta\u0107 w oparciu o kod.<\/p>\n

Najpierw sp\u00f3jrzmy na analiz\u0119 statyczn\u0105 za pomoc\u0105 PHPStan<\/a>.<\/p>\n

Lepszy kod WordPress z PHPStan<\/h2>\n

Czym w\u0142a\u015bciwie jest analiza statyczna?<\/h3>\n

Najpierw kilka s\u0142\u00f3w o analizie statycznej. Mianowicie, co to jest? Po pierwsze, to k\u0119s:<\/p>\n

\n

Statyczna analiza kodu (znana r\u00f3wnie\u017c jako analiza kodu \u017ar\u00f3d\u0142owego) jest zwykle wykonywana jako cz\u0119\u015b\u0107 przegl\u0105du kodu (znanego r\u00f3wnie\u017c jako testowanie bia\u0142oskrzynkowe) i jest przeprowadzana na etapie wdra\u017cania cyklu rozwoju zabezpiecze\u0144 (SDL).<\/p>\n

Statyczna analiza kodu zwykle odnosi si\u0119 do uruchamiania narz\u0119dzi statycznej analizy kodu, kt\u00f3re pr\u00f3buj\u0105 wskaza\u0107 mo\u017cliwe luki w \u201estatycznym" (nieuruchamiaj\u0105cym si\u0119) kodzie \u017ar\u00f3d\u0142owym za pomoc\u0105 technik, takich jak analiza defekt\u00f3w i analiza przep\u0142ywu danych.<\/p>\n

Statyczna analiza kodu przez OWASP<\/a><\/p>\n<\/blockquote>\n

Pomy\u015bl o tym w ten spos\u00f3b: jest to spos\u00f3b na analiz\u0119 programu pod k\u0105tem potencjalnych b\u0142\u0119d\u00f3w, kt\u00f3rych mo\u017cesz nie zauwa\u017cy\u0107 podczas pracy z baz\u0105 kodu.<\/p>\n

Oznacza to, \u017ce istniej\u0105 problemy, b\u0142\u0119dy, problemy z bezpiecze\u0144stwem, kt\u00f3re mog\u0105 wyst\u0119powa\u0107, ale nie mo\u017cna ich wykry\u0107 z wielu powod\u00f3w (z kt\u00f3rych najmniejszym jest to, \u017ce jeste\u015b zbyt blisko kodu).<\/p>\n

Jednak z biegiem czasu spo\u0142eczno\u015b\u0107 programist\u00f3w nauczy\u0142a si\u0119 analizowa\u0107 kod, generowa\u0107 zestawy regu\u0142 i budowa\u0107 narz\u0119dzia, kt\u00f3re pomagaj\u0105 znale\u017a\u0107 dok\u0142adnie wszystkie powy\u017csze elementy.<\/p>\n

Analiza statyczna kodu zorientowanego na WordPress<\/h3>\n

I tu w\u0142a\u015bnie pojawia si\u0119 PHPStan.<\/p>\n

\"Pisanie<\/a><\/p>\n

Jak wspomniano, celem pakietu jest identyfikacja b\u0142\u0119d\u00f3w lub b\u0142\u0119d\u00f3w, kt\u00f3re istniej\u0105 w twoim kodzie, zanim tw\u00f3j kod zostanie u\u017cyty przez kogo\u015b innego ni\u017c programi\u015bci, pod\u015bwietlenie ich i umo\u017cliwienie ich naprawienia.<\/p>\n

Poniewa\u017c narz\u0119dzia takie jak to sprawdzaj\u0105 baz\u0119 kodu (w przeciwie\u0144stwie do uruchamiania kodu), nie zawsze jest mo\u017cliwe uzyskanie jasnego obrazu. Oznacza to, \u017ce mo\u017cemy uzyska\u0107 fa\u0142szywe alarmy.<\/p>\n

Wi\u0119cej o tym za chwil\u0119.<\/p>\n

Je\u015bli interesuje Ci\u0119 rozpocz\u0119cie pracy z PHPStan w oparciu o Tw\u00f3j kod, jest to \u0142atwe. Po zainstalowaniu pami\u0119taj tylko, aby skonfigurowa\u0107 go tak, aby nie wygl\u0105da\u0142 w vendor<\/code>katalogu lub, powiedzmy, rdzeniu WordPressa.<\/p>\n

Zamiast tego popro\u015b go o sprawdzenie kodu.<\/p>\n

Instalowanie PHPStan<\/h3>\n

Najpierw w swoim composer.json<\/code>pliku dodaj nast\u0119puj\u0105cy wiersz w require-dev<\/code>sekcji:<\/p>\n

\"phpstan\/phpstan\": \"^0.11.12\"<\/code><\/p>\n

Nast\u0119pnie uruchom composer update<\/code>w swoim terminalu.<\/p>\n

Po zainstalowaniu mo\u017cesz go uruchomi\u0107 na pojedynczym pliku, katalogu lub zestawie katalog\u00f3w. Je\u015bli czyta\u0142e\u015b moje poprzednie posty na temat organizacji kodu, wiesz, \u017ce jestem fanem trzymania wi\u0119kszo\u015bci kodu \u017ar\u00f3d\u0142owego projektu pod r\u0119k\u0105 src<\/code>, mo\u017cesz uruchomi\u0107 co\u015b takiego:<\/p>\n

$ vendor\/bin\/phpstan analyse src<\/code><\/p>\n

Spowoduje to wygenerowanie danych wyj\u015bciowych na podstawie tego, co znajdzie narz\u0119dzie.<\/p>\n

Pami\u0119tasz, kiedy powiedzia\u0142em, \u017ce mo\u017ce znale\u017a\u0107 takie rzeczy, jak fa\u0142szywe alarmy? Oto bardziej szczeg\u00f3\u0142owe zestawienie tego, co mo\u017cesz zobaczy\u0107:<\/p>\n