SSPS – Einheitlicher Standard für die Projektstruktur

SSPS – Einheitlicher Standard für die Projektstruktur

80

2 min.

Der SSPS-Standard legt Anforderungen an die Struktur und Benennung von Dateien und Ordnern im Projekt fest.

Überall kebab-case

Die Verwendung von Kleinbuchstaben und Bindestrichen ist für alle Ordner und Dateien des Projekts obligatorisch. Dies sorgt für Einheitlichkeit und gewährleistet, dass keine Probleme auftreten. Dieser Ansatz verhindert Konflikte in verschiedenen Betriebssystemen und Versionskontrollsystemen (Git), in denen die Groß-/Kleinschreibung unterschiedlich behandelt werden kann, was zu Fehlern führen kann.

Die Verwendung von kebab-case löst die folgenden Probleme:

  • Es verhindert Chaos wie getPrice.ts, Price.tsx und Name.test.ts in einem Verzeichnis.
  • Komplizierte Namen wie CuteIDKOKReader werden in lesbare Namen wie cute-id-kok-reader.ts umgewandelt.
  • Es schützt vor Case Sensitive FS-Fehlern.

Warum nicht snake_case:

  • Erfordert übermäßigen Gebrauch der Umschalttaste.
  • Ist im Web schlecht lesbar (wenn die Datei beispielsweise als unterstrichener Link angezeigt wird, verschmilzt das Unterstrichzeichen mit der Linie).
  • Google rät offiziell davon ab, Unterstriche zu verwenden.

Die einzige zulässige Ausnahme bilden Systemdateien im Stammverzeichnis des Repositorys, wie beispielsweise README oder CONTRIBUTING, da deren Großschreibung durch allgemein anerkannte Dokumentationsstandards vorgegeben ist.

Kontext durch Verschachtelung

Der Dateiname sollte keine Informationen wiederholen, die bereits durch die Ordnerstruktur vorgegeben sind. Der Kontext wird durch den Speicherort bestimmt; wenn sich die Datei also in features/auth befindet, ist die Benennung auth-login-form.tsx überflüssig. Richtig wäre login-form.tsx.

Der Übergang von Namen wie HeaderUserMenuAvatar zur Struktur widgets/header/ui/user-menu/avatar ermöglicht es, Dateinamen kurz und präzise zu halten.

Architektonische Prinzipien von FSD

Das Projekt ist in Schichten mit klaren Verantwortungsbereichen aufgebaut. Globale Gruppen (entities, features, widgets) werden immer im Plural benannt. Konkrete Module (Slices) innerhalb dieser Gruppen werden im Singular benannt. Interne Segmente (ui, model, api) bleiben standardmäßig.

Dies schafft eine vorhersehbare Architektur, wobei die Aufgabe, den Warenkorb zu ändern, immer zu features/add-to-cart führt, wo Schnittstelle und Logik klar voneinander getrennt sind. Die Verwendung einer einheitlichen Schreibweise (kebab-case) macht Projekte einheitlich, was eine schnellere Orientierung und Problemlösung ermöglicht.

Der Artikel wird ergänzt werden

Ähnliche Kategorien:

Ähnliche Artikel

  • SSA – Einheitlicher Standard für Akkordeons

    Der SSA-Standard legt Anforderungen an die Semantik, Zugänglichkeit und Funktionsweise von Akkordeons fest

    180

    2 min.

  • Bad Practices für Websites

    Analyse kritischer Fehler im Webdesign. Warum Slider, Autoplay und schwerfällige Seiten die Konversionsrate sowie die Platzierungen bei Google und Yandex verschlechtern

    27

    2 min.

  • SSP – Einheitlicher Standard für die Paginierung

    Der SSP-Standard legt Anforderungen an die Semantik, Zugänglichkeit und Logik der Seitennavigation fest

    131

    1 min.

  • SSV – Einheitlicher Standard für Videos

    Der SSV-Standard legt Anforderungen an die Semantik, die Konfiguration von Hintergrund- und interaktiven Videos, Attribute für Safari, Barrierefreiheitsregeln und das Gewicht von Videos fest

    121

    4 min.

  • Wie man Vite bei aktiviertem VPN verwendet, schnelle Lösung

    Lösung des Problems mit der Funktion von Vite bei aktiviertem VPN, Konfiguration der Verbindung, um zu verhindern, dass lokaler Datenverkehr in den VPN-Tunnel umgeleitet wird

    119

    2 min.

Kontaktieren Sie mich

Projektart*