Gossiphs

🚀 Gossip話し屋プロジェクトドキュメント

Gossip話し屋は、コードリポジトリ内のファイル間の関係グラフを構築することに特化したプロジェクトです。ファイル間のインポートとエクスポート情報を抽出し、コミット履歴を組み合わせてこれらの関係を最適化することで、定義と参照のノードを接続するシンボルグラフを構築します。

✨ 主な機能

サポートする言語

現在、このプロジェクトは以下の言語をサポートしています。

核心コンポーネント

1. ルールエンジン：異なる言語でどのシンボルをインポートまたはエクスポートする必要があるかを定義します。
2. 抽出器：コードファイルからこれらのシンボル情報を抽出します。
3. グラフ構築器：抽出されたシンボル情報を有向グラフに変換します。ノードはシンボルで、エッジは依存関係を表します。

動作原理

Gossip話し屋は以下の手順でコード依存関係グラフを構築します。

1. インポートとエクスポートの抽出：各ファイル内のインポートとエクスポートシンボルを識別します。
2. 接続の確立：ルールに基づいて関連するシンボルノードを接続します。
3. コミット履歴を利用したエッジの最適化：コミット記録を分析することで、ノード間の関係を調整および最適化します。

Stack - Graphsとは異なり、Gossip話し屋は複雑なスコープ分析を省略し、代わりにコミット履歴を使用してエッジを最適化します。この方法は、ルールが各ファイルがエクスポートまたはインポートするシンボルのタイプを指定するだけで済むため、ルールの作成の複雑さを大幅に軽減します。

精度に関する考慮事項

静的分析には限界があり、たとえば動的バインディングの問題を処理できません。したがって、Gossip話し屋はLSP/LSIFのような精度を達成することはできませんが、ほとんどの実際のアプリケーションシナリオではこの精度で十分です。

🤝 貢献ガイド

このプロジェクトは現在非常に初期の実験段階にあります。もしあなたが興味を持っている場合は、問題を通じてあなたの考えを残してください。短期的には、より多くの言語に対するサポートを強化することを目指しています。

あなたは以下のことが必要です。

1. src/rule.rs でルールを編集します。
2. src/extractor.rs でテストを行います。
3. src/graph.rs であなたのリポジトリを試してみます。

[Tree - sitter Playground](https://tree - sitter.github.io/tree - sitter/playground) は便利なツールです。

📄 ライセンス

Apache 2.0