Hur man utesluter filer från PHP CodeSniffer

När du arbetar med PHP CodeSniffer, och du gör det i terminalen, är du sannolikt ute efter att mata ut fel till något annat än din IDE.

Jag menar, om det var fallet, skulle du bara ha det igång i din editor, eller hur?

Men det finns tillfällen då du kanske är intresserad av att hitta problemen i andras kod. Kanske är det ett beroende, kanske är det en programvara från tredje part, eller kanske är det en tjänst.

Hur som helst, om du har ställt in projektkatalogen på ett sätt som använder Composer för att inkludera PHP CodeSniffer och du använder WordPress Coding Standards, kommer du sannolikt att behöva utesluta filer från PHP CodeSniffer när du kör program.

Och så här kan du göra det.

Innan du går in i de kommandon som är nödvändiga, antar jag att du har en kataloginställning ungefär så här:

En potentiell katalogstruktur.

Det vill säga, du har:

• ett gäng PHP-filer (och underkataloger som innehåller PHP-filer),
• en composer.json -fil för att ta med PHP CodeSniffer i projektet
• en leverantörskatalog som innehåller beroenden för PHP CodeSniffer

Om du har WordPress-kodningsstandarderna installerade men inte har dem inställda för PHP CodeSniffer, utfärda detta kommando:

$ ./vendor/bin/phpcs --config-set installed_paths ~/path/to/wpcs

Så här är problemet:

Du vill utesluta filer från PHP CodeSniffer, men du har många filer att sniffa (nämligen sedan du introducerade leverantörskatalogen). Hur utesluter vi filer från PHP CodeSniffer samtidigt som vi får de resultat vi vill ha?

Du behöver några ytterligare kommandon:

1. se till att du har inkluderat WordPress-kodningsstandarderna som en del av konfigurationen,
2. berätta uttryckligen för PHP CodeSniffer att använda WordPress-standarden
3. tala om för PHP CodeSniffer vilka kataloger som ska ignoreras och vilka filer som ska bearbetas

Låter det komplicerat? Kommandot är väldigt enkelt:

$ ./vendor/bin/phpcs --ignore=*/vendor/* --standard=WordPress .

Och terminalen borde se ut så här:

Nettoresultatet av att sniffa endast PHP-filer för den aktuella katalogen.

Vid det här laget bör du kunna se felen i din terminal (förhoppningsvis finns det inga, eller hur? 😏) eller så kan du överföra dem till en annan fil för att granska i ett annat program eller vid ett senare tillfälle.