HowTo: EditorConfig - Editor-übergreifende Formatvorgaben

In diesem Forum gibt es Starthilfe zum neuen Extension-System von phpBB 3.1/3.2. Fragen zur Entwicklung von Extensions und zur Konvertierung von phpBB 3.0.x MODs sind ebenfalls willkommen.
Benutzeravatar
LukeWCS
Supporter
Supporter
Beiträge: 2130
Registriert: 15.12.2014 10:19
Kontaktdaten:

Re: HowTo: EditorConfig - Editor-übergreifende Formatvorgaben

Beitrag von LukeWCS »

IMC hat geschrieben: 26.07.2023 22:37 Wegen diese unterschiedlichen Befindlichkeiten ist der 4te Parameter in json_encode() auch eingeführt worden. Vorher waren 4 Spaces mit dem setzen des pretty flags fix gesetzt.
Er "wäre" eingeführt worden, aber die Umfrage wurde ja mit 21 zu 7 Stimmen abgelehnt. Es gibt nach wie vor nur 3 Parameter:

https://www.php.net/manual/en/function.json-encode.php
Ich finde Tabs auch flexibler da jeder durch seine Einstellungen im Editor seine bevorzugte Einrücktiefe konfigurieren kann ohne Änderungen im Code vorzunehmen.
Genau. Wobei es bei dem Standard hier allerdings um Projekt-Richtlinien geht.
LukeWCS hat geschrieben: 26.07.2023 11:58 Meine Motivation für die Anpassung der .editorconfig war letztendlich dass mit dem 4ten Parameter die Möglichkeit besteht die Anzahl der Leerzeichen vorzugeben, jedoch kein Tab ausgewählt werden kann. Deshalb sehe ich die Leerzeichen als den PHP Standart für JSON-Dateien.
Jupp, wenn man mit der Funktion eine JSON Struktur erzeugt und das JSON_PRETTY_PRINT Flag setzt, werden Spaces für die Einrückung verwendet.
Jetzt sehe ich gerade das Crizzo die Stelle bei com gefunden hat die ich suchte.
Ja, wobei mir Crizzo eben auch sagte, dass das Dokument evtl. veraltet ist, weil phpBB es selbst nicht so macht.

Ich habe eben auch mal ein aktuelles phpBB Paket 3.3.10 angeschaut, da werden bei composer.json im Root und bei phpbb/composer.json Tabs verwendet und somit wäre das auch konsequent. Und das geht, wie ich nachgeschaut habe, auch zurück bis phpBB 3.1.0. Hingegen sind alle composer.json im vendor Ordner allesamt mit Spaces formatiert. Seltsamerweise wird aber auch bei install/schemas/schema.json mit Spaces formatiert und diese Datei stammt wieder unmittelbar von phpBB.

Meine Tendenz war eigentlich, es auf Spaces zu ändern, weil:
  • Titania beim Upload einer Ext in die CDB bei fallweiser Änderung der composer.json mit Spaces neu formatiert.
  • PHP bei der Erzeugung einer JSON Struktur Spaces verwendet (bei JSON_PRETTY_PRINT).
Mit den unterschiedlichen Formaten in einem phpBB Paket plus der JSON und YAML Richtlinie, ist das Ganze allerdings nicht mehr so klar. Es gibt also zuviel Widersprüchliches. Es ist salopp gesagt Käse, wenn es phpBB so macht, Titania aber anders. Entweder es gilt für alles und jeden Tabs ODER Spaces. Aber keinen Mix.

edit: Letztes Update von Crizzo: das Dokument stimmt. Die Formatierung bei phpBB ist wohl eher veraltet. Somit wären Spaces angesagt. Okay, morgen dann, heut wird nix mehr entschieden. :wink:
Möge das Backup mit dir sein. Immer.

Erweiterungen - Infos zur artgerechten Haltung
phpBB Ext Check - Analysesystem für phpBB Erweiterungen (Entwickler Werkzeug)
Benutzeravatar
LukeWCS
Supporter
Supporter
Beiträge: 2130
Registriert: 15.12.2014 10:19
Kontaktdaten:

Re: HowTo: EditorConfig - Editor-übergreifende Formatvorgaben

Beitrag von LukeWCS »

Ergebnis eines Gesprächs zwischen Crizzo und Marc: YAML und JSON Spaces, der Rest Tabs.

Standard auf 1.2 geändert, Standard 1.1 archiviert.

Wer nach Übernahme des Standards 1.2 bestehende JSON Dateien umformatieren möchte, kann dafür zumindest in Notepad++ eine Funktion nutzen, mit der das schnell und unkompliziert erledigt werden kann:

Bearbeiten > Nicht druckbare Zeichen > Tabulatoren in Leerzeichen umwandeln
Möge das Backup mit dir sein. Immer.

Erweiterungen - Infos zur artgerechten Haltung
phpBB Ext Check - Analysesystem für phpBB Erweiterungen (Entwickler Werkzeug)
Antworten

Zurück zu „Extension Bastelstube“