HowTo: EditorConfig - Editor-übergreifende Formatvorgaben

[LukeWCS]

Das HowTo ist jetzt in der Knowledge Base zu finden:

Knowledge Base - Editor-übergreifende Format-Vorgaben mit EditorConfig

[BNa]

Danke für das klasse Tutorial

[LukeWCS]

HowTo etwas überarbeitet.
Zusätzlichen Unterpunkt bei den Infos hinzugefügt.
Infos in ".editorconfig" und "Allgemein" aufgeteilt.

[Dr.Death]

Danke für die nette und ausführliche Anleitung.

Ich kann bestätigen, das die EditorConfig auch für BBEdit (einem bekannten Notepadd++ Pendant für Macs) funktioniert.

[LukeWCS]

@Dr.Death
Danke für die Rückmeldung. Und laut der Liste auf editorconfig.org unterstützt BBEdit EditorConfig sogar nativ. Besser geht's nicht.

[Mike-on-Tour]

Habe das auch in meinem NP++ installiert, funktioniert wunderbar und erleichtert die Arbeit ungemein - Danke dafür.

[LukeWCS]

HowTo in der KB angelegt, Startbeitrag auf den Link reduziert.

[LukeWCS]

Bedingt durch die Entwicklung von EMP 1.0.8 und ein Gespräch von Kirk und mir im WWH Forum hinsichtlich unnötiger Whitespaces in HTML Dateien, habe ich für mich eine Anpassung des phpBB.de EditorConfig Standards vorgenommen. Dabei werden jetzt unnötige Whitespaces am Zeilenende ebenfalls auch bei HTML Dateien entfernt.

Zu solchen unnötigen Whitespaces am "Zeilenende" kommt es zum Beispiel, wenn man bei einem eingerückten HTML Block mit Enter eine Leerzeile einfügt. Dadurch übernimmt NP++ natürlich die vorherige Einrückung und das ist bei einer Leerzeile komplett sinnfrei.

Damit man sich das besser vorstellen kann, ein relevanter Abschnitt aus dem EMP Template:

Code: Alles auswählen

			{%- endif ~%}
		</span>
	</fieldset>
	
	<form class="extmgrplus_settings" id="version_check_settings" method="post" action="{{ U_ACTION }}" style="display: none;">
		<fieldset>
			<legend>{{ lang('EXTENSIONS_VERSION_CHECK_SETTINGS') }}</legend>

Nach dem </fieldset> hatte ich mit Enter eine Leerzeile eingefügt, die von NP++ durch die Einrückungsautomatik automatisch mit einem Tab versehen wurde, der da eig. nichts zu suchen hat. Solche unnötigen Tabs hatte ich in der betreffenden Datei jede Menge, das ist mir aber erst aufgefallen, als mich Kirk darauf hingewiesen hat. HTML wird beim phpBB Ext Check Modul "phpBB PHP Strict Standard Extensions" ja leider nicht geprüft, was schlicht damit zusammenhängt, dass PHP_CodeSniffer für die Analyse von HTML Dateien gar nicht konzipiert wurde.

Genau das kann aber mit der EditorConfig Option trim_trailing_whitespace = true beim Speichern einer Datei automatisch bereinigt werden, so dass eine solche Leerzeile eben nicht mehr einen oder mehrere unnötige Tabs enthält.

Bevor ich den phpBB.de EditorConfig Standard, mit dem viele von uns seit rund 3 Jahren arbeiten, aber ändere, wollte ich erstmal bei euch nachfragen, ob es irgendeine Situation geben kann, wo Whitespaces am Zeilenende erhalten bleiben müssen. Damit meine ich Leerzeichen und Tabs.

Wenn nicht, würde ich den Standard auf Version 1.1 ändern, so das auch HTML Dateien in diesem Punkt bereinigt werden können und man sich um dieses Detail nicht mehr kümmern muss.

Zum selber probieren, hier meine geänderte Version:

Code: Alles auswählen

# EditorConfig is awesome: https://EditorConfig.org

# phpBB - Editor Vorgaben v1.1 - https://www.phpbb.de/kb/viewarticle?a=93
# 2020 LukeWCS, phpBB.de

root = true

[*]
end_of_line = lf
insert_final_newline = true

[*.{php,js,css,json,html,txt,md,yml}]
charset = utf-8
indent_style = tab
indent_size = 4
trim_trailing_whitespace = true

[*.{txt,md,yml}]
trim_trailing_whitespace = false

[*.yml]
indent_style = space

[Mike-on-Tour]

Ich wüsste jetzt keinen Grund, warum man das bei html-Dateien nicht machen sollte; es gibt ja keine html-Tags mit einem Leerzeichen am Ende und wer unbedingt ein Leerzeichen am Ende eines Textes (der in einer eigenen Zeile steht) braucht, sollte sowieso besser   nutzen.

[Dr.Death]

https://github.com/DrDeath/phpbb-ext-f1 ... e5918d7b57