SourceSage 2.0.0 リリースノート

はじめに

SourceSage 2.0.0のリリースを発表できることを嬉しく思います！このバージョンでは、ツールの使いやすさ、保守性、効率性を向上させるために、いくつかの重要な機能強化と新機能が導入されています。SourceSageは、プロジェクトのソースコードとファイル構造を単一のマークダウンファイルに統合するPythonスクリプトで、大規模な言語モデル（AI）がプロジェクト全体の構造と内容を容易に理解できるようにします。

新機能

• ChangelogGeneratorクラス: コードの可読性と保守性を向上させるために、ChangelogGeneratorクラスを導入しました。このクラスは、get_repo()、get_commits()、format_commit()の各機能を統合し、コードをよりモジュール化し、再利用しやすくしています。
• シンタックスハイライト: SourceSageは、複数のプログラミング言語のシンタックスハイライトをサポートするようになりました。この機能により、生成されたマークダウンファイルの可読性が向上し、ソースコードスニペットの理解が容易になります。
• 柔軟な除外設定: ファイルとフォルダの除外設定を改善し、複数行をサポートするようになりました。これにより、ユーザーは生成されたマークダウンファイルから除外するファイルとフォルダを簡単に指定できます。
• 外部設定ファイル: 設定を別のファイルに外部化し、ツールの動作を管理しカスタマイズしやすくなりました。
• .SourceSageignoreファイル: 自動的に除外するファイルとフォルダを列挙する.SourceSageignoreファイルを導入しました。この機能により、プロジェクトの整理が簡素化され、不要なファイルやフォルダが生成されたマークダウンファイルに含まれないようになります。
• Git変更履歴: SourceSageは、Git変更履歴を自動的に生成してドキュメント化するようになりました。この機能により、開発プロセスの透明性と可視性が向上し、変更の追跡とプロジェクトの進化の理解が容易になります。

改良点

• エラー処理: コード生成時のエラー処理を改善し、ツールをより堅牢でユーザーフレンドリーにしました。
• コードの可読性: コードベースをリファクタリングして、可読性と保守性を向上させました。不要なコメントを削除し、コード構造を最適化して理解しやすくしました。
• READMEの改善: プロジェクトのREADMEファイルを統合し、ツールの機能、使用方法、例をより明確かつ簡潔に説明するように改良しました。

変更履歴

変更とコミットの詳細については、統合された変更履歴(docs/Changelog/CHANGELOG_integrated.md)ファイルを参照してください。

アップグレード手順

SourceSage 2.0.0にアップグレードするには、以下の手順に従ってください：

1. GitHubからリポジトリの最新バージョンをクローンします。
2. 更新されたREADMEファイルを確認し、使用方法や設定に変更がないか確認します。
3. プロジェクトの.SourceSageignoreファイルを更新して、生成されたマークダウンファイルから除外するファイルとフォルダを指定します。
4. SourceSage.pyスクリプトを実行して、更新されたマークダウンファイルとGit変更履歴を生成します。

おわりに

SourceSage 2.0.0は、使いやすさ、保守性、効率性の面で大きな前進を遂げたと考えています。このリリースで導入された新機能と改良点は、ユーザーがプロジェクトをより良く理解し管理するのに役立ち、AI言語モデルがソースコードとファイル構造を分析し処理するのが容易になります。

このリリースを可能にしてくれたすべてのコントリビューターに感謝いたします。ご質問やご意見、問題が発生した場合は、プロジェクトのGitHubリポジトリを通じてお気軽にお問い合わせください。

SourceSageをご利用いただきありがとうございます。バージョン2.0.0の新機能と改良点を楽しんでいただければ幸いです！