Readme.md extended with two commands, convert XML configuration to PHP

[dgodglueck]

No description provided.

[Tomcraft1980]

Kannst du ein wenig genauer erklären, was das bewirkt?

[dgodglueck]

Kannst du ein wenig genauer erklären, was das bewirkt?

Gerne

Die Dokumentation die ich für PHP-CS-Fixer kenne, befindet sich unter https://cs.symfony.com/doc/config.html
und dort sind die Konfigurationsmöglichkeiten sehr gut dokumentiert und meiner Meinung nach auch besser lesbar.
Die XML Konfiguration wirkt für mich nur unnötig aufgeblasen und daher der kleine Verbesserungsvorschlag.

Ansonsten wäre die Erweiterung der Readme um den Punkt Best practices auch hilfreich, bzw. würde team-intern auch einiges verbessern. Zum Beispiel die Verwendung von Ticketnummern als Präfix [1234] und die Verwendung von englischer Sprache.
Example: [3050] feat: Uniform EU label for warranty and guarantee starting in 2026

[Tomcraft1980]

Danke dir!
Kann die Datei auch nach .github verschoben werden oder muss die im Root liegen?

Ansonsten wäre die Erweiterung der Readme um den Punkt Best practices auch hilfreich, bzw. würde team-intern auch einiges verbessern. Zum Beispiel die Verwendung von Ticketnummern als Präfix [1234] und die Verwendung von englischer Sprache. Example: [3050] feat: Uniform EU label for warranty and guarantee starting in 2026

Kannst du dafür auch noch einen PR erstellen?

[dgodglueck]

Danke dir! Kann die Datei auch nach .github verschoben werden oder muss die im Root liegen?

Ansonsten wäre die Erweiterung der Readme um den Punkt Best practices auch hilfreich, bzw. würde team-intern auch einiges verbessern. Zum Beispiel die Verwendung von Ticketnummern als Präfix [1234] und die Verwendung von englischer Sprache. Example: [3050] feat: Uniform EU label for warranty and guarantee starting in 2026

Kannst du dafür auch noch einen PR erstellen?

Kommt sofort :)

[Tomcraft1980]

Kann die Datei auch nach .github verschoben werden oder muss die im Root liegen?

Das hatte ich noch gefragt.

[dgodglueck]

Kann die Datei auch nach .github verschoben werden oder muss die im Root liegen?

Das hatte ich noch gefragt.

Möglich ist es, aber PHP-CS-Fixer schaut ins root-Verzeichnis um die Konfiguration zu lesen.
Alternativ kann man die Konfiguration aber auch als Parameter angegeben werden -c ./gitconfig/.php-cs-fixer.dist.php
Darüber hinaus kann durch eine eigenserstelle Konfig ohne .dist die .dist inkludiert und überschrieben werden, würde ich aber für CS-Fixer lassen.

[Tomcraft1980]

Danke dir!

[RobinTheHood]

@dgodglueck @Tomcraft1980

1. Man könnte noch auf die .github/CONTROBUTION... verweisen in der Readme.md

2. Deine php fixer php geht leider nur für php cs fixer. Ich glaube aber, das sie nicht für das linting Tool phpcs (ohne fixer) geht. Das ist aber auch wichtig, besonders wenn man in VS Code direkt beim Schreiben von Code linting Informationen angezeigt haben möchte und für die GitHub Action / Workflow in .github

PS: @dgodglueck kennt man dich im Forum?

PPS: das war nicht als negative Kritik geschrieben. Du machst nur so eine versierten Eindruck, da habe ich mich kurz gehalten.

[dgodglueck]

@dgodglueck @Tomcraft1980

1. Man könnte noch auf die .github/CONTROBUTION... verweisen in der Readme.md

2. Deine php fixer php geht leider nur für php cs fixer. Ich glaube aber, das sie nicht für das linting Tool phpcs (ohne fixer) geht. Das ist aber auch wichtig, besonders wenn man in VS Code direkt beim Schreiben von Code linting Informationen angezeigt haben möchte und für die GitHub Action / Workflow in .github

PS: @dgodglueck kennt man dich im Forum?

PPS: das war nicht als negative Kritik geschrieben. Du machst nur so eine versierten Eindruck, da habe ich mich kurz gehalten.

Ich fliege im Forum unter dem Radar, bin nur Hobby-Schrauber für eigene Zwecke 😀
Das sollte VS Code laut der Dokumentation https://github.com/PHP-CS-Fixer/ mit entsprechender Konfiguration können.

Das passt schon so, ich halte mich auch meist sehr kurz. Da hat nichts negativ mitgeschwungen 😀

[Tomcraft1980]

1. Man könnte noch auf die .github/CONTROBUTION... verweisen in der Readme.md

Würdest du das übernehmen?

PPS: das war nicht als negative Kritik geschrieben. Du machst nur so eine versierten Eindruck, da habe ich mich kurz gehalten.

Ich glaube wir sind alle froh über eher kurze und knackige Texte. 😉

[dgodglueck]

1. Man könnte noch auf die .github/CONTROBUTION... verweisen in der Readme.md

Würdest du das übernehmen?

PPS: das war nicht als negative Kritik geschrieben. Du machst nur so eine versierten Eindruck, da habe ich mich kurz gehalten.

Ich glaube wir sind alle froh über eher kurze und knackige Texte. 😉

Sobald die Git Operationen wieder lauffähig sind, kommt der neue Commit.
Wobei ich mir nicht sicher bin, ob das in die Readme rein gehört, da ein separater Contribution-Tab sichtbar ist.

[Tomcraft1980]

Welche Git Operationen waren denn nicht lauffähig?

[dgodglueck]

Welche Git Operationen waren denn nicht lauffähig?

Gestern Abend, wahrscheinlich durch die Cloudflare Probleme, war auf der Seite https://www.githubstatus.com/ der Punkt "Git Operationen" rot, also es liefen keinerlei Befehle wie z.B. fetch usw.

[RobinTheHood]

@dgodglueck ich bin mir gerade nicht sicher ob wir von denselben Werkzeugen sprechen. Ich nutze php cs fixer für die automatische Formatierung und phpcs für die unmittelbare Anzeige von Fehlern im Editor wie im GIF zu sehen ist.

Nach meinem aktuellen Stand kann php cs fixer das nicht wobei ich mich natürlich irren kann. phpcs arbeitet nur mit der .phpcs.xml.dist und kann die php cs fixer Konfiguration nicht lesen. In der GitHub Action läuft ebenfalls phpcs als automatische Prüfung daher wird die .phpcs.xml.dist früher oder später ohnehin gebraucht.

[dgodglueck]

@dgodglueck ich bin mir gerade nicht sicher ob wir von denselben Werkzeugen sprechen. Ich nutze php cs fixer für die automatische Formatierung und phpcs für die unmittelbare Anzeige von Fehlern im Editor wie im GIF zu sehen ist.

Nach meinem aktuellen Stand kann php cs fixer das nicht wobei ich mich natürlich irren kann. phpcs arbeitet nur mit der .phpcs.xml.dist und kann die php cs fixer Konfiguration nicht lesen. In der GitHub Action läuft ebenfalls phpcs als automatische Prüfung daher wird die .phpcs.xml.dist früher oder später ohnehin gebraucht.

Ja, da haben wir wohl einander vorbei geschrieben. Der PHP-CS-Fixer kann kein Live-Linting, finde ich persönlich aber auch sehr mühselig. Bei dem PHP-CS-Fixer kann mit dem VS Code Plugin dafür "Format on save" eingestellt werden. Ich habe mal den Fork um meine Konfiguration aktualisiert und auch die Github Actions getestet, ist für mich tatsächlich auch mal was neues. Bin eher auf Gitlab unterwegs. Theoretisch könnte das Setting auch so gestaltet werden, dass der PHP-CS-Fixer für die Pipeline automatische Formatierungen vornimmt, aber das halte ich auch für gefährlich.

Zu der bereits gelöschten XML, ich meine die Konfigurationen können parallel laufen wenn das gewünscht wird, erzeugt aber bei Änderungen der Team Coding Standards doppelte Anpassungen. Da das aber eher seltener passiert, wäre das völlig in Ordnung. Und am Ende ist tatsächlich alles nur Geschmackssache.

Ich bin auf jeden Fall gerade sehr dankbar, dass so viel Feedback kommt, welches mich herausfordert 💪

[Tomcraft1980]

@RobinTheHood
Sollte die XML wiederhergestellt werden?

[RobinTheHood]

@dgodglueck ich sehe das genauso. Die automatische Formatierung mit Format on save über die php cs fixer Erweiterung in VS Code ist sehr angenehm. (Für Mitleser: Man kann mit php cs fixer selbst auch die gesamte Codebasis auf einmal formatieren was im Alltag viel Arbeit spart.) Ich nutze das selbst gern um erst einmal schnell und etwas unsauber zu schreiben und beim Speichern sorgt php cs fixer dann für eine saubere Darstellung. Du hast recht damit, dass man am Ende zwei Konfigurationen pflegt. Wenn man das einzeln betrachtet wirkt das nicht ideal, wenn man aber berücksichtigt, dass sich beide Dateien nach der ersten Einrichtung nur selten ändern sollten, ist das gut machbar. Beide Werkzeuge können so ihre jeweiligen Stärken einbringen und phpcs übernimmt zusätzlich die automatische Prüfung im Pull Request.

@Tomcraft1980 die .phpcs.xml.dist kann wiederhergestellt werden und die .php-cs-fixer.dist.php Konfiguration sollte ebenfalls erhalten bleiben.

[Tomcraft1980]

Könntest du die bitte wiederherstellen? Bin mir nicht sicher, wie ich das anstelle. 🤔

[dgodglueck]

Könntest du die bitte wiederherstellen? Bin mir nicht sicher, wie ich das anstelle. 🤔

Das mach ich :)

[Tomcraft1980]

Danke dir! 👍