composer.json
.Voraussetzungen-Prüfung
Kürzlich bin ich auf der Suche nach etwas anderem auf einen Beitrag von Crizzo gestossen, bei dem es um ein Tool zur Prüfung dieser für phpBB und EC wichtigen Datei geht. Ich hatte dann erste Tests mit diesem Tool in der Shell vorgenommen und festgestellt, dass der Prüf-Umfang durchaus dabei hilfreich sein kann, Fehler bei der technischen Struktur zu erkennen und Details zu ermitteln. EC selber konnte bisher nur feststellen, ob die Datei eine gültige Struktur hat oder nicht, jedoch im Fehlerfall keinerlei Details nennen, da PHP selber eben auch nur zurückgibt ob die Datei gültig ist oder nicht, ohne im Fehlerfall Details zu liefern.
Nachdem ich in EC für Composer Validator ein passendes Prüf-Modul geschrieben und so das Tool in EC einbinden konnte, habe ich umfangreiche Tests innerhalb EC durchgeführt um sicher zu gehen, dass das Zusammenspiel von EC und Composer Validator problemlos ist. Dabei habe ich auch viele Stichproben von Exts von phpBB.de genommen und da das Tool eben auch auch Warnungen und Hinweise bezüglich inhaltlicher Struktur geben kann, gab es dabei auch kleinere Auffälligkeiten bei ein paar Exts. Nachfolgend die entsprechenden Ausschnitte aus dem Log, reduziert auf den technischen Namen und Version der jeweiligen Ext und dem zugehörigen Composer Validator Ergebnis Code (2 = Warnung, 3 = Fehler).
chris1278_jsclock_1-0-3 CVAL=3
imcger_imgupload_1-4-6 CVAL=3
kirk_bbcodepage_3-0-0 CVAL=3
hjw_calendar_1-1-3 CVAL=3
moemorox_qaip_1-0-3 CVAL=2
Wer die Details wissen will, lässt die besagte Ext einfach mit EC 1.9.4 erneut prüfen. Fragen zu den Meldungen kann man wie gehabt hier besprechen.
Zum Composer Validator muss aber klar gesagt werden:
- Ich habe Composer Validator nicht wegen der Prüfung auf inhaltliche Struktur eingebaut (was ohnehin schon von EPV erledigt wird), sondern wegen Prüfung der technischen Struktur, da EC diesen Punkt bezüglich Details bislang nicht abdecken konnte.
- Composer Validator ist, wie Variable Analysis, kein auf phpBB Exts spezialisiertes Tool. Der Composer Validator prüft eine
composer.json
mit Schwerpunkt auf die Befindlichkeiten von Composer und https://packagist.org und ist somit für uns nur bedingt relevant, was die inhaltliche Struktur angeht.
phpBB PHP Strict Standard Extensions
Dann noch etwas anderes: PPSSE wird zukünftig keine
*.css
und *.js
mehr prüfen können sobald CodeSniffer 4.0 zur Verfügung steht und bei EC eingebunden ist. Aufgefallen im Rahmen meines Bug Reports bezüglich veralteter phpBB CodeSniffer Regelwerke: PHPBB-17510. Der relevante Changelog Eintrag bei CS 3.13.0 wäre das hier:Quelle: DeprecatedDeprecated
- Sniffs which don't listen for PHP, like JS/CSS specific sniffs. [#894]
Ich habe das auch bereits mit CS 4.0 Beta1 vorab getestet und das hat die Ankündigung bestätigt. Da wird dann beim Versuch PPSSE auf diese Dateitypen anzuwenden die Meldung ausgegeben, dass diese Dateien keine Strukturen enthalten, die geprüft werden könnten. Deshalb muss ich diese Dateitypen dann bei PPSSE entfernen, um diese dann unnötigen Meldungen zu vermeiden.
Diejenigen Entwickler die noch nicht unseren EditorConfig Standard eingerichtet haben, sollten das also nachholen, damit die von PPSSE bisher gemeldeten Fehler bei diesen beiden Dateitypen gar nicht erst entstehen können.