Regeln für den Code | Placing-Me-Wiki

# Regeln für den Code

Wir folgen (soweit es geht) den Richtlinien, bzw. Vorgaben von Laravel (PSR-2) im Backend und Javadscript im Frontend.

Im Backend/PHP-Dateien wird der Code durch Intelephense (opens new window) formatiert. Dies funktioniert prima in Kombination mit dem VSCode-Plugin (opens new window). Die Blade-Dateien werden (nicht optimal) mit dem Plugin Blade-Formatter (opens new window). Vielleicht gibt es bald ein Prettier-Plugin (opens new window).

.eslint.rc

module.exports = {
    extends: ['eslint:recommended', 'standard', 'plugin:prettier/recommended'],
    globals: {
    fetch: true,
    Event: true,
    $store: true,
    $dispatch: true,
    path: true,
    },
};

# Grobe Regel für das Schreiben von Code

Der Code sollte möglichst nach folgender Regel geschrieben werden (kann nicht automatisch vom Formatter gefixt werden):

Sichtbarkeit
- Ordne alle Funktionen/Variablen/Methoden/... den Sichtbarkeiten public, protected und private Typen zusammen
Zugehörigkeit
- suche die Richtige Zugehörigkeit (z.B. Relationship, Modelfunction, ...)
alphabetisch
- die neue Funktion/Variable/Methode/... an die richtige Stelle der alphabetischen Sortierung setzen

# weiterführende Links

3.1.1 Laravel
3.1.2 Javascript
3.1.3 CSS

# übergeordnetes Thema

Codeinfos und Richtlinien