Dies ist eine alte Version des Dokuments!
LU01b - Linting & Formatting
Formatting
Formatter sorgen dafür, dass der gemeinsame Code einheitlich formatiert wird. Oftmals besitzen IDE bereits eine Standard-Formattierung oder die Möglichkeit, Formatierungsregeln mit Entwicklern mit denselber IDE auszutauschen.
Beispiele von IDE-spezifischen Formatierungen:
- IntelliJ: Code Style XML unter
.idea/codeStyles/… - Visual Studio Code: Settings unter
.vscode/settings.json - Eclipse: Code Style Formatter: Eclipse Code Formatter XML
- Diverse IDE: .editorconfig (aber nicht alle Regeln funktionieren aber bei allen IDE's)
| IntelliJ Project.xml | VS Code settings.json | Eclipse java-formatter.xml | .editorconfig |
|---|---|---|---|
...<\WRAP> | <WRAP>... test ...<\WRAP> | <WRAP>... <profile kind="CodeFormatterProfile" name="Project Formatter" version="12">
<!-- Tab size --> <setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/> <setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/> <setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
<!-- New line at end of file --> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing" value="true"/>
</profile> ...<\WRAP> | <WRAP>... test ...<\WRAP> |
Beispiele von Formatter-Bibliotheken
- Javascript, Typescript, HTML, CSS, JSON → Prettier
- Python → black, pep8, …
- Java → Google Java Format
Linting
Linting (dt. „fusseln“) bezeichnet das automatische finden und teilweise sogar korrigieren von möglichen Fehlern o.Ä. anhand von einem definierten Regelset. Entsprechende Bibliotheken sind für diverse Sprachen erhältlich.
Gängige Linter-Bibliotheken
- Javascript, Typescript → ESLint(https://eslint.org/) ,
TSLint wurde eingestellt und ist daher nicht mehr empfohlen - Python → Pylint (https://www.pylint.org/)
- Java → PMD (https://pmd.github.io/)
- Diverse Sprachen → SonarQube for IDE (SonarLint)