SSG – Einheitlicher Standard für Git

Definitionen

Der SSG-Standard legt Anforderungen an die Semantik, Barrierefreiheit und Funktionslogik von Git fest.

Herkömmliche Commits – Struktur von Commits

Eine Commit-Meldung sollte wie folgt aufgebaut sein:

<Typ>([Geltungsbereich]): <kurze Beschreibung>

[Commit-Text]

[Fußzeile(n)]

Überschrift – obligatorischer Bestandteil

Typ – Klassifizierung des Commits:

Gültigkeitsbereich (optional) gibt den betroffenen Teil des Projekts an (z. B. ui, api, auth):

feat(api): Neuer Endpunkt für Benutzer hinzugefügt

Beschreibung beschreibt die Änderungen, vorzugsweise im Imperativ, maximal 50 Zeichen.

Haupttext und Fußzeile, optionale Abschnitte

Der Haupttext erläutert, was und warum geändert wurde.

Die Fußzeile wird für Breaking Changes verwendet, inkompatible Änderungen werden mit BREAKING CHANGE: oder feat! gekennzeichnet, zum Beispiel feat!: veraltete api-methoden entfernt, sowie für Verweise auf Issues, zum Beispiel Closes #123.

Einrichten der Pipeline für einen sicheren Commit-Prozess

Die Pipeline sorgt für die Formatierung, die Überprüfung der Commits und das sichere Zusammenführen von Branches.

Erforderliche Abhängigkeiten

npm i -D \
  husky \
  lint-staged \
  @commitlint/cli \
  @commitlint/config-conventional \
  @commitlint/types \
  conventional-changelog-conventionalcommits \
  @archoleat/commitlint-define-config

Konfiguration von lint-staged

Lint-staged überprüft nur indizierte Änderungen:

export default {
  '*': 'prettier --write',
  'src/**/*.{tsx,ts}': 'eslint --fix',
  'src/**/*.scss': 'stylelint --fix',
};

Konfiguration von Commitlint

Commitlint überprüft das Format der Commits und die zulässigen Typen:

import { defineConfig } from '@archoleat/commitlint-define-config';

export default defineConfig({
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      [
        'build',
        'chore',
        'ci',
        'docs',
        'feat',
        'fix',
        'perf',
        'refactor',
        'revert',
        'spec',
        'style',
      ],
    ],
  },
});

Das Plugin für defineConfig finden Sie hier

Konfiguration von Git-Hooks (Husky)

In Husky gibt es einen Fehler, bei dem Änderungen manchmal verloren gehen können, wenn der Commit die Überprüfung nicht besteht!

Der gesamte Commit-Prozess

• Änderungen in den Staging-Bereich aufnehmen:

  git add .
  

• Commit erstellen:

  git commit -m "feat(header): Schaltfläche zum Wechseln des Themes hinzugefügt"
  

• Pre-Commit:

  lint-staged wird gestartet, Prettier, ESLint und Stylelint beheben Fehler in den indizierten Dateien, anschließend werden die korrigierten Dateien erneut in den Index aufgenommen.

• commit-msg:

  commitlint überprüft, ob der Commit-Titel den Regeln von Conventional Commits entspricht.

• Ergebnis:

  Der Commit ist erfolgreich abgeschlossen, wenn alle Prüfungen bestanden wurden, andernfalls wird der Commit mit einer Fehlermeldung abgelehnt.