sourcesage 4.3.0

No project description provided

SourceSage

～Transforming code for AI～

SourceSageは、プロジェクトのソースコードとファイル構成を単一のマークダウンファイルに統合し、AIによる自動修正やドキュメント化を実現するPythonスクリプトです。開発のライフサイクル全体を通して、コードの品質向上と生産性の向上を支援します。

[!IMPORTANT] このリポジトリ自体もSourceSageを活用しており、リリースノートやREADME、コミットメッセージの9割はSourceSage ＋ claude.aiで生成しています。

更新内容

更新内容

• 【2024/05/12】 SourceSage 4.2.0
  • ステージング情報のテンプレートに絵文字とGAIAHに対応
• 【2024/04/30】 SourceSage 4.1.2
  • GitHub ActionsによるPyPIへの自動パブリッシュ設定を追加し、リリースプロセスを自動化
• 【2024/04/07】 SourceSage 4.1.0
  • プロジェクト全体の出力ファイル名と各モジュールの出力フォルダ名を変更
  • PyPIのダウンロードバッジとCodacyのクオリティバッジを追加
  • CLI引数の追加とコアモジュールの修正
  • プロジェクトの構成とファイルの変更によるシンプル化
  • セットアップ手順、実行方法、クイックスタートセクション、テストドキュメントの更新
• 【2024/04/05】 SourceSage 4.0.3
  • README.mdのセットアップ手順と実行手順を簡素化
  • リポジトリのオーナーと名前をコマンドライン引数で指定可能に
  • テスト実行方法のドキュメントを更新
• 【2024/04/01】 SourceSage 3.1.0
  • コードの品質と保守性を向上させるためのリファクタリングと機能改善
  • コミットメッセージのフォーマットとタイプの説明を追加
  • コマンドラインからソースコードのリポジトリパスを取得するように修正
  • 定数の管理方法を改善し、config/constants.pyファイルで一元管理
• 【2024/03/31】 SourceSage 3.0.0
  • IssueWise機能を追加し、GitHubのオープンIssueを取得してAIによる自動修正をサポート
  • CommitCraft機能を追加し、変更差分を追跡してAIが適切なコミットメッセージを生成
  • DocuMind機能を追加し、プロジェクトの概要とGitの変更履歴を組み合わせてドキュメント化
• 【2024/03/30】 SourceSage 2.0.0
  • ChangelogGenerator classを導入し、コードの可読性と保守性を向上
  • 言語ごとのシンタックスハイライト機能を追加
  • .SourceSageignoreファイルを導入し、不要なファイルやフォルダを自動的に除外
• 【2024/03/29】 初期リリース

主な機能

IssueWise（開発前の課題解決）

• GitHubのオープンIssueを自動取得し、AIによる課題の自動修正をサポート
• 課題を効率的に特定し、迅速に解決策を見つけられます

CommitCraft（開発中のコミット管理）

• 変更差分を追跡し、AIが適切なコミットメッセージを自動生成
• コミットの内容を正確に記述でき、変更履歴を明確に管理できます

DocuMind（リリース後のドキュメント化）

• プロジェクトの概要とGitの変更履歴を組み合わせてドキュメント化
• プロジェクトの全体像を把握しやすく、メンテナンス性が向上します

使用方法

セットアップ

SourceSageを使用するには、まずPythonのパッケージマネージャーであるpipを使ってインストールします。以下のコマンドをターミナルまたはコマンドプロンプトで実行してください：

pip install sourcesage

これにより、SourceSageがシステムにインストールされ、コマンドラインから実行できるようになります。

クイックスタート

SourceSageをプロジェクトで使用するには、以下の手順に従ってください：

1. ターミナルまたはコマンドプロンプトを開きます。

2. cdコマンドを使って、解析対象のプロジェクトのルートディレクトリに移動します。例えば、プロジェクトが~/my_projectディレクトリにある場合は、以下のコマンドを実行します：

   cd ~/my_project
   

   Note: cdコマンドは "change directory" の略で、現在のディレクトリを指定したディレクトリに変更するために使用します。

3. 次に、以下のコマンドを実行してSourceSageを起動します：

   sourcesage
   

4. SourceSageが実行されると、以下のファイルがSourceSageAssetsディレクトリに生成されます：

   • DocuMind.md：AIがプロジェクトの構造と内容を理解しやすい形式のマークダウンファイルです。
   • Changelog：Gitの変更履歴を保存するディレクトリです。
   • ISSUES_RESOLVE : Issuesとプロジェクト全体がマージされたファイルを保存するディレクトリです。これらのファイルは、AIがIssueを解決するための重要な情報源となります。
   • COMMIT_CRAFT : 開発中のステージされたコードのファイルを保存するディレクトリです。これらのファイルは、AIが適切なコミットメッセージを生成するために使用されます。
   • open_issues_filtered.json：GitHubからフェッチしたオープンなIssueのJSONファイルです。
   • STAGED_DIFF.md：ステージされた変更の差分情報を含むマークダウンファイルです。

これらのファイルを使って、AIによるプロジェクトの解析や自動修正、ドキュメント化などを行うことができます。

リポジトリのIssueも取得する方法

デフォルトでは、SourceSageは現在のディレクトリをプロジェクトのルートとして解析します。ただし、GitHub上のリポジトリのIssueも取得したい場合は、以下のようにリポジトリのオーナー名とリポジトリ名をコマンドライン引数で指定します：

sourcesage --owner Sunwood-ai-labs --repository SourceSage

上記の例では、Sunwood-ai-labsがリポジトリのオーナー名、SourceSageがリポジトリ名です。これらの引数を指定することで、SourceSageはGitHub APIを使ってリポジトリのオープンなIssueを取得し、open_issues_filtered.jsonファイルに保存します。

[!Note] GitHub APIを使用するには、インターネット接続が必要です。また、リポジトリがプライベートの場合は、適切なアクセストークンを設定する必要があります。

以上が、SourceSageの基本的な使用方法です。ぜひ自分のプロジェクトでSourceSageを活用して、開発効率の向上を体験してみてください！

除外ファイルの指定

作業ディレクトリに.SourceSageignoreファイルを作成することで、任意のファイルやディレクトリを処理から除外できます。このファイルには、除外したいファイルやディレクトリのパターンを1行ずつ記述します。例えば、以下のように指定します：

# .SourceSageignoreの例
node_modules/
*.log
*.tmp

上記の例では、node_modulesディレクトリと、拡張子が.logまたは.tmpのファイルが除外されます。

.SourceSageignoreファイルを使用する場合は、以下のようにコマンドライン引数で指定します：

sourcesage --owner Sunwood-ai-labs --repository SourceSage --ignore-file .SourceSageignore

この機能を使用することで、不要なファイルやディレクトリを処理から除外し、より効率的にSourceSageを実行できます。

1. IssueWise：開発前の課題解決

IssueWiseは、GitHubのオープンなIssue(課題)を自動的に取得し、SourceSageが生成したプロジェクトの概要と組み合わせることで、AIによる課題の自動修正を可能にするツールです。これにより、開発者はプロジェクトの課題を効率的に特定し、解決策を迅速に見つけることができます。

SourceSageAssets/ISSUE_WISE/ISSUES_RESOLVEに生成されるマークダウンファイルを使用します。

例：docs/SAMPLE/SAMPLE_ISSUE_11.md

このマークダウンファイルをそのままAIに入力することで、AIが課題を解決するためのコードを生成します。AIは、Issueの内容とプロジェクトの概要を組み合わせて分析し、適切な修正を提案します。

このマークダウンファイルは、下記のファイルのフォーマットで出力されます。 docs/ISSUES_RESOLVE/ISSUES_RESOLVE_TEMPLATE.md

IssueWiseを使用することで、開発者は手作業でIssueを確認する負担を軽減し、AIによる自動修正の恩恵を受けることができます。

2. CommitCraft：開発中のコミット管理

CommitCraftは、開発中のステージされた変更を追跡し、AIを活用して適切なコミットメッセージを自動生成するツールです。これにより、開発者はコミットの内容を正確に記述することができ、プロジェクトの変更履歴をより明確に管理できます。

SourceSageAssets/COMMIT_CRAFT/STAGED_DIFF.mdに生成されるマークダウンファイルを使用します。

例：docs/SAMPLE/SAMPLE_STAGE_INFO_AND_PROMT.md

このマークダウンファイルをそのままAIに入力することで、AIがコミットメッセージを生成します。AIは、ステージされた変更の差分を分析し、その内容を要約したコミットメッセージを提案します。

絵文字を活用した視覚的に分かりやすいコミットメッセージの例はこちらです。

例：docs/SAMPLE/SAMPLE_STAGE_INFO_AND_PROMT_EMOJI.md

このファイルでは、コミットメッセージのフォーマットに絵文字を取り入れ、変更内容をより直感的に表現しています。

また、Gaiah用のコミットメッセージ生成を支援するテンプレートの例はこちらです。

例：docs/SAMPLE/SAMPLE_STAGE_INFO_AND_PROMT_GAIAH.md

このテンプレートでは、効果的で意味のあるコミットメッセージを作成するためのベストプラクティスに従ったガイドラインを提供しています。主要な変更とその目的に焦点を当て、コミットで行われた変更を明確かつ簡潔に説明するように促します。

Issueとマージされたファイルの例はこちらです。

例：docs/SAMPLE/SAMPLE_STAGE_INFO_AND_ISSUES_AND_PROMT.md

このファイルには、ステージされた変更の差分とオープンなIssueの情報が含まれています。AIはこれらの情報を組み合わせて分析し、より包括的なコミットメッセージを生成します。

CommitCraftを使用することで、開発者はコミットメッセージを考える負担を軽減し、一貫性のある適切なコミットメッセージを自動的に生成できます。絵文字の活用やGaiahのテンプレートを利用することで、よりわかりやすく効果的なコミットメッセージの作成が可能になります。

3. DocuMind：リリース後のドキュメント化

DocuMindは、リリース後のプロジェクトの統合とドキュメント化を支援するツールです。SourceSageが生成するプロジェクトの概要と、自動生成されたGitの変更履歴を組み合わせることで、プロジェクトの全体像を明確に把握できます。これにより、開発者はプロジェクトのドキュメントを効率的に作成し、メンテナンス性を向上させることができます。

SourceSageAssets/DocuMind.mdに生成されるマークダウンファイルを使用します。

例：docs/SAMPLE/SAMPLE_DocuMind.md

また、SourceSageAssets/Changelogに生成されるコミットメッセージのマークダウンファイルを使用します。

例：docs/SAMPLE/SAMPLE_CHANGELOG_release_4.1.0.md

この2つのマークダウンファイルをそのままAIに入力することで、AIがプロジェクトの構造と変更内容を理解し、リリースノートやドキュメントを生成することができます。AIは、プロジェクトの概要とGitの変更履歴を分析し、プロジェクトの主要な機能や変更点を要約します。

DocuMindを使用することで、開発者はドキュメント作成の負担を軽減し、常に最新の状態を反映したドキュメントを自動的に生成できます。

開発者向け

単体テスト

このドキュメントでは、テストを実行するためのコマンドラインについて説明します。

tests/README.md

テストの実行

ユニットテストを実行するには、以下のコマンドを使用します。

pytest tests/test_sourcesage.py

このコマンドにより、tests/test_sourcesage.pyファイルに定義されたテストケースが実行されます。

パッケージリリースガイド

このドキュメントでは、GitHub Actions CI/CDを使用してPythonパッケージをPyPIに自動的に公開する方法について説明します。

docs/package_release/README.md

前提条件

• PyPIのアカウントを作成済みであること
• プロジェクトのGitHubリポジトリが存在すること

貢献

SourceSageの改善にご協力ください！バグの報告や機能追加の提案がある場合は、GitHubリポジトリでIssueを開くかプルリクエストを送信してください。

ライセンス

このプロジェクトはMITライセンスの下で公開されています。