Lägga till flera kodningsstandarder med Composer

Det är en sak att använda PHP CodeSniffer manuellt, men om du använder ett verktyg som GrumPHP för att kontrollera ditt arbete innan du överför det till förvaret, kommer du sannolikt att vilja använda den version som du installerar med din projekt.

Detta förutsätter att:

1. Du installerar PHP CodeSniffer lokalt i ditt projekt,
2. Du vill installera en specifik uppsättning kodningsstandarder som ska köras mot din kod.

Kom ihåg att detta också görs i samband med att man vill köra automatiserade skript under commit-processen och i en lokal miljö (mot en global miljö) med Composer.

Composer erbjuder möjligheten att skriva skript under körning. Från manualen :

Ett skript, i Composers termer, kan antingen vara en PHP-återuppringning (definierad som en statisk metod) eller vilket som helst körbart kommando på kommandoraden. Skript är användbara för att köra ett pakets anpassade kod eller paketspecifika kommandon under Composer-körningsprocessen.

För att installera flera kodningsstandarder med Composer så att vi kan göra vad vi med GrumPHP och alla pre-commit processer, måste vi dra fördel av pre-install-cmd och pre-update-cmd skripten. Om du gör detta säkerställer du att rätt kodningsstandarder ställs in för binären på projektnivå i PHP CodeSniffer.

Fall i punkt :

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
},

Notera i exemplet ovan, jag ser till att lägga till WordPress-kodningsstandarderna till PHP CodeSniffer.

Men du kan lägga till flera versioner av kodningsstandarder, så här:

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
},

Och du kan lägga till alla andra standarder du har så att du kan peka skriptet på rätt plats där de är installerade.

När du gör det kommer standarderna att tillämpas på PHP CodeSniffer och kommer att utföras under både installationen och uppdateringen Composer-processer.