Categorygithub.com/msageha/prompt_generator
repositorypackage
0.0.0-20241228083806-662106f9376e
Repository: https://github.com/msageha/prompt_generator.git
Documentation: pkg.go.dev

# README

Prompt Generator

このリポジトリは、指定されたディレクトリ内のテキストファイルを収集し、指示文に基づいてプロンプトを生成するツールです。生成されたプロンプトは、リポジトリの内容と指示文を組み合わせたものとなります。

機能概要

  • 指定した拡張子のテキストファイルを対象にファイル内容を収集
  • 無視するディレクトリを指定可能
  • UTF-8テキストファイルを判定して無効なファイルを除外
  • 標準入力から指示文を受け取り、プロンプトを生成
  • 生成したプロンプトをコンソールに出力(オプションでクリップボードにコピー可能)

使用方法

  1. リポジトリをクローンします。
git clone https://github.com/msageha/prompt_generator.git
cd prompt_generator
  1. 必要な依存関係をインストールします。
go mod tidy
  1. コマンドを実行します。
go run main.go -p <ディレクトリパス> -e <対象ファイル拡張子>

オプション:

  • -p: 入力ディレクトリのパス(デフォルトはカレントディレクトリ)
  • -e: 対象とするファイルの拡張子(デフォルトは.py)
  • -h: ヘルプメッセージを表示
  1. 実行後、指示文を入力します。

標準入力から変更指示文を入力し、終了するにはCtrl+Dを押します。

  1. 結果として生成されたプロンプトがコンソールに出力されます。

依存ライブラリ

以下のGoパッケージを使用しています。

  • golang.design/x/clipboard: クリップボード操作

注意点

  • 無視するディレクトリはignoreDirsに定義されています。必要に応じてコード内で調整してください。
  • 対象ファイルのエンコーディングはUTF-8である必要があります。

今後の改善案

  • 生成されたプロンプトのクリップボードへのコピー機能のオプションをコマンドライン引数で有効化
  • 他のエンコーディング形式への対応
  • ユーザーが無視するディレクトリやファイルの条件をカスタマイズ可能にする