lint commit

Charbonne

Description

Cet outil CLI aide à automatiser le processus de génération de messages de validation et de gestion d'un référentiel GIT. Il guide l'utilisateur en initialisant un référentiel GIT (s'il n'est pas déjà initialisé), en sélectionnant des fichiers pour commettre, en générant des messages de validation assistés par AI et en poussant éventuellement des modifications dans un référentiel distant.

Caractéristiques

• Initialiser un nouveau référentiel GIT s'il n'est pas déjà initialisé
• Sélectionnez des fichiers à engager dans la liste des fichiers modifiés
• Générer des messages de validation assistés par AI à l'aide de l'API Generative Generative Google
• Poussez éventuellement les modifications au référentiel distant

Condition préalable

• Node.js (v14.x ou version ultérieure)
• Git installé sur votre système
• Github CLI ( gh ) installé
• Google Generative AI API Key: Google AI Studio

Installation

1. Installez le comité de peluche à l'échelle mondiale:

npm install -g lint-commit

2. Enregistrez votre gemini_api_key:

lint-commit register

3. Alternativement, vous pouvez cloner ce référentiel et exécuter le script localement:

git clone https://github.com/techwithmanuel/lint-commit.git
cd lint-commit
npm install
node register.js
node index.js

Comment obtenir votre clé API Gemini

1. Connectez-vous à Google AI Studio

2. Sélectionnez Get API key dans le menu latéral

3. Sélectionnez Create API key puis suivez l'invite pour créer la clé

4. Une fois terminé, copiez la clé, exécutez cette commande après l'installation de Lint-Commit

 lint-commit register

Entrez ensuite la clé

Usage

Une fois que vous avez installé et répondu à votre GEMINI_API_KEY , pour commencer avec Lint-Commit, exécutez simplement:

lint-commit

Suivez les invites pour initialiser un référentiel GIT, ajouter des fichiers et créer un engagement avec un message conforme à commitlint.

Contributif

Les contributions sont les bienvenues! Veuillez suivre ces étapes pour contribuer:

1. Fourk le référentiel.
2. Créez une nouvelle branche (Branch de fonctionnalité Git Checkout -B).
3. Faites vos modifications et les engagez-les (git commet -am «Ajouter une nouvelle fonctionnalité»).
4. Poussez à la branche (Branch Git Push Origin).
5. Créez une nouvelle demande de traction.

Contact

Pour toute question ou suggestion, veuillez ouvrir un problème.