Gossiphs

🚀 Gossip Chatty Project Documentation

Gossip Chatty is a project dedicated to building a relationship graph between files in a code repository. It extracts import and export information between files and optimizes these relationships by combining commit history to establish a symbol graph that connects definition and reference nodes.

🚀 Quick Start

Supported Languages

Currently, the project supports the following languages:

Core Components

1. Rule Engine: Defines which symbols need to be imported or exported in different languages.
2. Extractor: Responsible for extracting symbol information from code files.
3. Graph Builder: Converts the extracted symbol information into a directed graph, where nodes represent symbols and edges represent dependency relationships.

Working Principle

Gossip Chatty builds a code dependency graph through the following steps:

1. Extract Imports and Exports: Identify import and export symbols in each file.
2. Establish Connections: Connect relevant symbol nodes according to rules.
3. Optimize Edges Using Commit History: Adjust and optimize the relationships between nodes by analyzing commit records.

Unlike Stack-Graphs, Gossip Chatty omits complex scope analysis and instead uses commit history to optimize edges. This approach significantly reduces the complexity of writing rules, as rules only need to specify the types of symbols that each file should export or import.

Precision Considerations

Static analysis has its limitations, such as the inability to handle dynamic binding issues. Therefore, Gossip Chatty cannot achieve the same level of precision as LSP/LSIF, but in most practical application scenarios, this level of precision is sufficient.

Contribution Guidelines

The project is currently in a very early experimental stage. If you are interested, please leave your ideas in the issues. In the short term, we hope to build better support for more languages.

You need to:

1. Edit rules in src/rule.rs.
2. Test it in src/extractor.rs.
3. Try using your repository in src/graph.rs.

Tree-sitter Playground is a great helper.

📄 License

Apache 2.0