commitlint

Fangen Sie an | Webseite

Lint begehen Nachrichten

Demo mit SVG-Term-CLI erzeugt

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• Ein gutes commitizen sein

• Gemeinsame Konfiguration über npm teilen

• Tippen Sie auf conventional-changelog

Inhalt

• Fangen Sie an | Webseite

• Installieren und ausführen

• Veröffentlichungen

• Vorteile der Verwendung von CommningLint

• Inhalt

• Was ist Commitlint

• Erste Schritte

• Cli

• Konfiguration

• Gemeinsame Konfiguration

• Dokumentation

• API

• Werkzeuge

• Roadmap

• Versionsunterstützung und Veröffentlichungen

• Verwandte Projekte

• Lizenz

• Entwicklung

---

Was ist Commitlint

CommitLint -Überprüfungen Wenn Ihre Commit -Nachrichten das herkömmliche Commit -Format erfüllen.

Im Allgemeinen sieht das Muster hauptsächlich so aus:

 Typ (Umfang?): Subjekt #Scope ist optional; Mehrere Bereiche werden unterstützt (aktuelle Trennzeichenoptionen: "/", "" und ",")

Beispiele für reale Welt können so aussehen:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Gemeinsame Typen nach Komitee-Config-Konfiguration (basierend auf der Winkelkonvention) können sein:

• bauen

• Aufgabe

• CI

• Dokumente

• feat

• Fix

• Perf

• Refaktor

• zurückkehren

• Stil

• prüfen

Diese können durch Ihre eigene Konfiguration geändert werden.

Vorteile der Verwendung von CommningLint

• Warum konventionelle Commits verwenden?

• "Die Vorteile des Vergehens mit Konventionen" (Talk -Folien)

Erste Schritte

• Lokale Setup - Lintnachrichten im Vergehen mit Husky

• CI -Setup - Lintnachrichten während der CI -Builds

Cli

• Primärer Weg, um mit Commitlint zu interagieren.

• npm install --save-dev @commitlint/cli

• Pakete: CLI

Konfiguration

• Die Konfiguration erfolgt von:

• .commitlintrc

• .commitlintrc.json

• .commitlintrc.yaml

• .commitlintrc.yml

• .commitlintrc.js

• .commitlintrc.cjs

• .commitlintrc.mjs

• .commitlintrc.ts

• .commitlintrc.cts

• commitlint.config.js

• commitlint.config.cjs

• commitlint.config.mjs

• commitlint.config.ts

• commitlint.config.cts

• commitlint -Feld in package.json

• commitlint in package.yaml

• Pakete: CLI, Kern

• In den Regeln finden Sie eine vollständige Liste möglicher Regeln

• Eine Beispielkonfiguration finden Sie unter @commitintint/config-konventionell

Gemeinsame Konfiguration

Eine Reihe gemeinsamer Konfigurationen stehen zur Installation und Verwendung mit commitlint zur Verfügung:

• @commesentlint/config-Angular

• @commesentlint/config-konventionell

• @commitintint/config-lerna-scopes

• @commesentlint/config-nx-scopes

• @commitintint/config-patternplate

• konventionelle Changelog-Lint-Config-Atom

• konventionelle Changelog-Lint-Config-kanonische

Euen emoji-log Sie Ihre eigene gemeinsam commitlint-config-emoji-log Konfiguration veröffentlichen möchten commitlint-config-your-config-name stellen Sie sicher oder your-config-name .

Dokumentation

Überprüfen Sie die Hauptwebsite.

API

• Alternative, programmatische Methode zur Interaktion mit commitlint

• Pakete:

• Format - Format -Komitee -Berichte

• Lint - Lint eine Zeichenfolge gegen Komitee -Regeln

• Laden - Last Shared Commitlinint -Konfiguration laden

• LESEN - Lesen Sie die Festungsnachrichten aus einem bestimmten Bereich oder zuletzt bearbeiten

• Eine vollständige Liste von Methoden und Beispielen finden Sie in API

Werkzeuge

• Komitee -Adapter

• prompt

Roadmap

commitlint wird als stabil angesehen und in verschiedenen Projekten als Entwicklungsinstrument verwendet.

Ideen : konventionelle Changelog/Commitlint#94

Versionsunterstützung und Veröffentlichungen

• Node.js lts >= 18

• Git >= 2.13.2

Veröffentlichungen

Sicherheitspatches werden auf Versionen angewendet, die noch nicht EOL sind.
Funktionen werden nur auf die aktuelle Hauptversion angewendet.

Freigeben	Erstveröffentlichung
v19	02/2024
v18	10/2023

EOL ist normalerweise nach ungefähr einem Jahr.

Wir sind kein gesponsertes OSS -Projekt. Daher können wir nicht versprechen, dass wir Patch -Versionen für ältere Veröffentlichungen rechtzeitig veröffentlichen werden.
Wenn Sie an einer älteren Version festsitzen und einen Sicherheitspatch benötigen, sind wir glücklich, wenn Sie eine PR bereitstellen können.

Verwandte Projekte

• herkömmlicher Changelog erzeugt einen ChangeLog aus der konventionellen Festungsgeschichte

• Commitizen einfache Begehörigkeitskonventionen für Internetbürger

• CREATE-Semantic-Modul CLI für die schnelle Integration von Komitee und Komitee in neue oder bestehende Projekte

Lizenz

Copyright von @Marionebl. Alle commitlint werden unter der MIT -Lizenz veröffentlicht.

Entwicklung

commitlint wird in einem Mono -Repository entwickelt.

Installieren und ausführen

 git clone [email protected]: konventionell-changelog/commessing.gitcd commessint
Garn
Yarn Run Build # Run Build TaskSynarn Start # Run -Tests, erneut bei Changeyarn Run commesentum # run cli

Weitere Informationen zum Beitrag zum Beitrag finden Sie in unseren Beitragsanleitung.