lint commit

リントコミット

説明

このCLIツールは、コミットメッセージを生成し、GITリポジトリの管理プロセスを自動化するのに役立ちます。 GITリポジトリの初期化（まだ初期化されていない場合）、コミットするファイルの選択、AIアシストのコミットメッセージの生成、およびオプションでリモートリポジトリへの変更をプッシュすることでユーザーをガイドします。

特徴

• まだ初期化されていない場合は、新しいgitリポジトリを初期化します
• 変更されたファイルのリストからコミットするファイルを選択します
• Google GenerativeAI APIを使用してAIアシストのコミットメッセージを生成する
• オプションで、変更をリモートリポジトリにプッシュします

前提条件

• node.js（v14.x以降）
• システムにgitがインストールされています
• Github CLI（ gh ）インストール
• Google Generative AI APIキー：Google AI Studio

インストール

1. Lint-Commitをグローバルにインストールする：

npm install -g lint-commit

2。GEMINI_API_KEYを登録：

lint-commit register

3.あるいは、このリポジトリをクローンして、スクリプトをローカルに実行できます。

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

Gemini APIキーを取得する方法

1。Google AI Studioにサインインします

2。[サイド]メニューでGet API key選択します

3. Create API keyを選択し、プロンプトに従ってキーを作成します

4.完了したら、キーをコピーして、Lint-Commitをインストールした後にこのコマンドを実行します

 lint-commit register

次に、キーを入力します

使用法

GEMINI_API_KEYをインストールして再設計したら、Lint-commitを開始するために、単に実行してください。

lint-commit

プロンプトに従って、gitリポジトリを初期化し、ファイルを追加し、commitlint-conformantメッセージを使用してコミットを作成します。

貢献

貢献は大歓迎です！貢献するには、次の手順に従ってください。

1. リポジトリをフォークします。
2. 新しいブランチを作成します（git checkout -b feature -branch）。
3. 変更を加えてコミットします（git commit -am '新機能を追加）。
4. ブランチにプッシュします（gitプッシュオリジン機能 - ブランチ）。
5. 新しいプルリクエストを作成します。

接触

質問や提案については、問題を開いてください。