Commit-Message-Linter
Prüfen Sie Commit-Messages anhand der Conventional-Commits-Regeln von commitlints config-conventional – mit denselben Regelnamen und Meldungen.
Eingabe
Ergebnis
Das Ergebnis erscheint hier.Conventional Commits – feat(api): add streaming, fix: handle empty responses – ist das Format, das semantic-release, release-please und Changelog-Generatoren auswerten, um die nächste Version festzulegen und Release Notes zu schreiben, und commitlint ist das Werkzeug, mit dem die meisten Projekte es durchsetzen. Fügen Sie eine oder mehrere Nachrichten ein, und diese Prüfung wendet die Regeln von @commitlint/config-conventional an: die erlaubten Typen, ein kleingeschriebener Typ, ein Betreff, der nicht in Sentence Case steht und nicht mit einem Punkt endet, ein Header von höchstens 100 Zeichen, Leerzeilen vor Body und Footer. Jedes Problem wird mit commitlints eigenem Wortlaut und Regelnamen gemeldet, sodass Sie hier genau das beheben, was der Commit-Hook bemängeln würde.
So arbeitet es
- Die Regeln sind aus dem Quellcode von commitlint nachimplementiert, statt commitlint auszuführen, daher läuft die Prüfung in der Seite; Regelsatz, Schweregrade und Meldungen entsprechen config-conventional.
- Trennen Sie mehrere Nachrichten durch eine Zeile, die nur --- enthält. Merge-Commits, Reverts, fixup!/squash!-Commits und reine Release-Versionen werden übersprungen, so wie commitlint sie standardmäßig überspringt.
- Ein Breaking Change – ! nach dem Typ oder ein BREAKING CHANGE:-Footer – wird hervorgehoben, da er für Release-Werkzeuge einen Sprung der Major-Version bedeutet.
- Eine Prüfung, die commitlint nicht vornimmt: Ein kleingeschriebener breaking change:-Footer erhält eine Warnung, weil die Spezifikation das Token in Großbuchstaben verlangt und Parser jede andere Schreibweise ignorieren.
Wohin Ihre Daten gehen
Nirgendwohin. Dieses Werkzeug läuft vollständig in Ihrem Browser: Der eingefügte Text wird von der Seite verarbeitet und weder an einen Server übertragen noch protokolliert.
Dieses Tool ist kostenlos und braucht kein Konto. Die Ergebnisse existieren nur in Ihrer geöffneten Seite und werden nirgends gespeichert.
Was es kostet
Dieses Werkzeug ist kostenlos, ohne Anmeldung und ohne Punkte.
Häufige Fragen
- Welche Typen sind erlaubt?
- Die elf, die config-conventional akzeptiert: build, chore, ci, docs, feat, fix, perf, refactor, revert, style und test. Alles andere – Fix mit großem Anfangsbuchstaben, feature, update – verstößt gegen die Regel type-enum. Projekte können die Liste in ihrer eigenen commitlint-Konfiguration erweitern; diese Prüfung verwendet die Standardkonfiguration.
- Warum ist "feat: Add login page" ein Fehler?
- config-conventional verbietet im Betreff Sentence Case, Start Case, Pascal Case und Upper Case. Er darf also nicht mit einem Großbuchstaben beginnen, es sei denn, das Wort wird immer so geschrieben. Schreiben Sie feat: add login page. Einen Eigennamen können Sie behalten, indem Sie ihn in Anführungszeichen oder Backticks setzen – diese ignoriert die Prüfung der Groß- und Kleinschreibung.
- Sind chinesische Commit-Messages erlaubt?
- Ja. Groß- und Kleinschreibung gibt es nur in Schriften wie der lateinischen, griechischen und kyrillischen, daher besteht ein Betreff wie 更新安装说明 die Regeln zur Schreibweise. Der Typ muss aber weiterhin eines der englischen Schlüsselwörter sein: docs(readme): 更新安装说明 ist gültig, 文档: 更新安装说明 nicht.
- Warum liegt das Header-Limit bei 100 und nicht bei 72?
- 100 ist der Standardwert von config-conventional. Viele Teams bevorzugen 72, damit Header in git log --oneline und in die Commit-Liste von GitHub passen, ohne abgeschnitten zu werden; setzen Sie die maximale Header-Länge auf 72, um stattdessen dagegen zu prüfen.
Das Open Source dahinter
Dieses Werkzeug ist eine eigenständige Implementierung ohne fremde Bibliothek. conventional-changelog/commitlint (MIT) erledigt dieselbe Aufgabe als Bibliothek — wer sie im eigenen Programm braucht, fängt dort an, statt eine Webseite aufzurufen.
conventional-changelog/commitlintAuch bekannt als
- commit message prüfen
- conventional commits checker
- commitlint online
- commit message validieren
- conventional commits format
- git commit message format