commitlint

Commencez | Site web

Messages de charme

Démo généré avec SVG-terme-CLI

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

• Être un bon commitizen

• Partager la configuration via npm

• Puiser dans conventional-changelog

Contenu

• Commencez | Site web

• Installer et exécuter

• Sorties

• Avantages de l'utilisation de commitlint

• Contenu

• Qu'est-ce que COMMISSION

• Commencer

• CLI

• Configurer

• Configuration partagée

• Documentation

• API

• Outils

• Feuille de route

• Prise en charge de la version et versions

• Projets connexes

• Licence

• Développement

---

Qu'est-ce que COMMISSION

Commitlint vérifie si vos messages de validation respectent le format de validation conventionnel.

En général, le modèle ressemble principalement à ceci:

 Type (Scope?): Le sujet #Scope est facultatif; Plusieurs portées sont prises en charge (options de délimiteur actuelles: "/", "" et ",")

Des exemples du monde réel peuvent ressembler à ceci:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Les types courants selon le commissaire-conventionnel de commitlint (basé sur la convention angulaire) peuvent être:

• construire

• corvée

• CI

• docs

• exploit

• réparer

• perf

• refacteur

• revenir

• style

• test

Ceux-ci peuvent être modifiés par votre propre configuration.

Avantages de l'utilisation de commitlint

• Pourquoi utiliser les commits conventionnels?

• "Les avantages de s'engager avec les conventions" (talk-diapositives)

Commencer

• Configuration locale - Messages de peluche sur Commit with Husky

• Configuration CI - Messages de peluche pendant les constructions CI

CLI

• Principal moyen d'interagir avec Commitlint.

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

• Packages: CLI

Configurer

• La configuration est ramassée à partir de:

• .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 COMMANDE dans package.json

• commitlint COMMANDE dans package.yaml

• Packages: CLI, noyau

• Voir les règles pour une liste complète des règles possibles

• Un exemple de configuration peut être trouvé à @ commitlint / config-conventionnel

Configuration partagée

Un certain nombre de configurations partagées sont disponibles pour installer et utiliser avec commitlint :

• @ commitlint / config-angulaire

• @ commitlint / config-conventionnel

• @ commitlint / config-Lerna-Scopes

• @ commitlint / config-nx-scopes

• @ commitlint / config-satternplate

• conventionnel-changelo-lint-config-atome

• conventionnel-changelo-lint-config-canonique

️ Si vous souhaitez publier votre propre configuration partageable, assurez-vous qu'elle a un nom qui s'aligne sur le modèle commitlint-config-emoji-log ou commitlint-config-your-config-name - alors en étendant tout ce que vous avez à écrire est emoji-log ou your-config-name .

Documentation

Consultez le site Web principal.

API

• Moyen alternatif et programmatique d'interagir avec commitlint

• Packages:

• Format - Rapports de commit Format

• peluche - peluche une chaîne contre les règles de commiss

• Charge - Charger la configuration de commit partagée

• Lire - Lire les messages de validation d'une plage spécifiée ou du dernier modification

• Voir l'API pour une liste complète des méthodes et des exemples

Outils

• adaptateur de commissation

• rapide

Feuille de route

commitlint est considéré comme stable et est utilisé dans divers projets comme outil de développement.

Idées : Changelog conventionnel / commitlint # 94

Prise en charge de la version et versions

• Node.js lts >= 18

• git >= 2.13.2

Sorties

Des correctifs de sécurité seront appliqués aux versions qui ne sont pas encore EOL.
Les fonctionnalités ne seront appliquées qu'à la version principale actuelle.

Libérer	Libération initiale
v19	02/2024
v18	10/2023

L'EOL est généralement après environ un an.

Nous ne sommes pas un projet OSS sponsorisé. Par conséquent, nous ne pouvons pas promettre que nous publierons des versions de correctifs pour les versions plus anciennes en temps opportun.
Si vous êtes coincé sur une version plus ancienne et que vous avez besoin d'un correctif de sécurité, nous sommes satisfaits si vous pouvez fournir un RP.

Projets connexes

• Le changelog conventionnel génère un modifice à partir de l'histoire de la validation conventionnelle

• Commizenm Simple Commit Conventions pour les citoyens Internet

• CLI de création de module sémantique pour intégrer rapidement le commiss et le commissaire dans des projets nouveaux ou existants

Licence

Copyright par @marionebl. Tous les forfaits commitlint sont publiés sous la licence MIT.

Développement

commitlint est développé dans un référentiel mono.

Installer et exécuter

 git clone [email protected]: conventionnel-changelog / commitlint.gitcd commitlint
fil
yarn run build # run build tasksyarn start # run tests, encore une fois sur changeyarn run commitlint # run CLI

Pour plus d'informations sur la façon de contribuer, veuillez consulter notre guide de contribution.