Composer für WordPress, Teil 2

In diesem Beitrag fasse ich zusammen, was ich gestern zu teilen begonnen habe: Die Verwendung der Tools und Bibliotheken, die ich in Verbindung mit Composer geteilt habe, um Ihre Commits während der Entwicklung zu schnüffeln, bevor der Code das Repository erreicht.

Idealerweise möchten Sie immer so etwas in Ihrem Terminal sehen, wenn Sie Ihren Code übertragen:

Aber das ist nicht immer der Fall. Wie bei den meisten Dingen werden Sie sich jedoch umso mehr daran gewöhnen, Code zu schreiben, der automatisch die verschiedenen Sniffs durch die verschiedenen Regeln (und ihre Anpassungen) weiterleitet, je mehr Sie üben.

Zuvor müssen Sie jedoch GrumPHP in Ihrem Repository konfigurieren.

Composer für WordPress: Sniffing-Commits

Gestern habe ich ein Beispiel bereitgestellt, composer.json also schauen wir uns heute eine Beispiel-GrumPHP-Konfigurationsdatei an und sehen uns an, was jeder Teil tut.

Es ist wichtig zu beachten, dass, obwohl einiges von dem, was Sie sehen werden, nicht untypisch für ein Projekt ist, Sie dies für jedes Projekt, das Sie verwenden, beliebig fein abstimmen können. Manchmal möchten Sie vielleicht, dass es fokussierter ist als jetzt; In anderen Fällen interessieren Sie sich möglicherweise nicht für einige der angebotenen Sniffs.

Eine Erstkonfiguration

Allerdings wird nach der Installation von GrumPHP eine fast leere grumphp.ymlDatei erstellt, die konfiguriert werden kann. Zum Beispiel sollten Sie Folgendes sehen :

parameters:
    git_dir:. bin_dir: vendor/bin
    tasks:

Beachten Sie, dass es nichts anderes gibt, als Folgendes anzugeben:

• der Standort des Depots,
• den Speicherort der über Composer installierten Binärdateien,
• die auszuführenden Aufgaben.

Beachten Sie, dass ich immer ‘.’ für den Speicherort meines Repositorys, weil ich es noch nie in dem Repository installiert habe, an dem ich arbeite.

Dasselbe gilt für die Composer-Binärdateien. Das heißt, nachdem ich alles über Composer installiert habe, lasse ich sie an ihren ursprünglichen Speicherorten.

Und schließlich ist die anfängliche tasksDirektive leer, weil noch nichts ausgeführt werden muss. Das werde ich mir im nächsten Schritt ansehen.

GrumPHP konfigurieren

Sobald Sie Ihre Bibliotheken installiert haben und bereit sind, ein wenig zu konfigurieren, können Sie vielleicht so etwas tun :

parameters:
    git_dir:. bin_dir: vendor/bin
    tasks:
      securitychecker:
      composer:
      jsonlint:
      xmllint:
      yamllint:
      phpstan:
      phplint:
      phpunit:
      phpcs:
      phpcpd:
      phpmnd:
      phpparser:
        visitors:
          no_exit_statements: ~
          never_use_else: ~
          forbidden_function_calls:
            blacklist:
              - "die"
              - "var_dump"
              - "exit"
      phpversion:
        project: '7.0'
       phpmd:
         ruleset: ['phpmd.xml.dist']

Ich werde oben nicht alles skizzieren (weil es nicht viel zu skizzieren gibt), aber es gibt noch ein paar Dinge, auf die hingewiesen werden sollte:

• Beachten Sie, dass es eine viel längere Liste von Aufgaben gibt, als im ursprünglichen Verzeichnis definiert wurde. Das ist normal und bedeutet, dass wir diese Tools mit der Standardkonfiguration für jedes dieser Tools ausführen möchten.
• ~Neben einigen Regeln steht ein. Dies hängt von der jeweiligen Aufgabe ab, bedeutet jedoch normalerweise, dass wir die Standardkonfiguration verwenden möchten.
• Es gibt solche Aufgaben phpparser, die Unteraufgaben haben. Einige von ihnen verwenden, wie Sie oben sehen können, das Standardverhalten. Andere entscheiden sich dafür, Begriffe wie die, var_dump, exit, und mehr auf die schwarze Liste zu setzen. Das bedeutet, als ob die Direktive nicht klar genug wäre, werden wir GrumPHP zum Scheitern bringen, wenn eine dieser Anweisungen erkannt wird.
• Schauen Sie sich in ähnlicher Weise an phpmd. Dies weist auf die Regeln hin, die wir verwenden, wenn wir nach verschiedenen Fehlern im Code suchen. In diesem Fall zeigt es auf eine dist Datei, kann aber auch auf einen beliebigen benutzerdefinierten Regelsatz verweisen, den Sie definiert haben.

Dies ist nur ein Beispiel dafür, was Sie mit GrumPHP machen können. Das heißt, Sie können einige Bibliotheken über Composer installieren, sie installieren und dann GrumPHP so anpassen, dass Sie die bereitgestellten Funktionen nutzen.

Wie bei anderen ähnlichen Projekten empfehle ich dringend, die Dokumentation zu lesen, die für die verschiedenen Aufgaben vorhanden ist, die sich in GrumPHP integrieren lassen.

Das ist Composer für WordPress?

Ja und nein. Composer ist ein Allzweck-Paketmanager für PHP-Projekte; Wir scheinen es jedoch nicht oft in der Welt von WordPress zu sehen. Das soll nicht heißen, dass es nicht verwendet wird (das wird es), aber es reicht nicht aus, sich einfach bewusst zu sein, dass Composer und wie man es benutzt.

Stattdessen denke ich, dass es wichtig ist zu wissen, wie man Composer für WordPress verwendet, damit wir in der Lage sind, den höchstmöglichen Qualitätscode zu schreiben und gleichzeitig sicherzustellen, dass wir uns an die Codierungsstandards halten, für die wir uns auch entschieden haben .