repomap

Overview ¶

Package repomap provides functionality for creating a structured map of a code repository.

Overview ¶

RepoMap creates a comprehensive representation of a code repository, including:

1. Files in the repository
2. Functions, methods, and types in each file
3. Content snippets for each component
4. Importance ranking of components using a PageRank-like algorithm

Usage ¶

Basic usage:

import "codeberg.org/MadsRC/aigent/internal/repomap"

// Create a new repository map with default options
rm, err := repomap.NewRepoMap("/path/to/repo", nil)
if err != nil {
    // Handle error
}

// Get a text representation of the repository map
output := rm.String()
fmt.Println(output)

With custom options:

// Custom options
options := repomap.DefaultTraversalOptions()
options.MaxDepth = 5
options.IgnoreDirs = append(options.IgnoreDirs, "build", "dist")
rm, err := repomap.NewRepoMap("/path/to/repo", options)

Traversal Options ¶

The TraversalOptions struct allows customization of repository traversal:

• MaxDepth: Maximum directory depth to traverse
• IgnoreDirs: Directories to ignore (e.g., .git, node_modules)
• IgnoreFiles: Files to ignore (e.g., package-lock.json)
• IncludeFiles: File extensions or names to include
• FocusFiles: Files that have user's focus (higher importance)
• MentionedIds: Identifiers that were explicitly mentioned (higher importance)
• MaxTokens: Maximum number of tokens for the repo map output
• Tokenizer: Function to count tokens in text

Importance Calculation ¶

The package uses a weighted PageRank algorithm to determine component importance:

1. Builds a weighted graph of component references
2. Applies weights based on identifier characteristics, frequency, and user focus
3. Runs PageRank iterations to calculate importance scores
4. Sorts components and files by importance

Output Formats ¶

RepoMap provides multiple output formats:

• String(): Default output with token limiting
• StringLegacy(): Backward compatible output
• StringGrepAST(): Output compatible with the Python grep_ast.py format

Token Limiting ¶

The package supports token limiting to ensure outputs fit within LLM context windows:

• Uses binary search to find optimal content inclusion
• Respects MaxTokens setting in TraversalOptions
• Prioritizes more important files and components

Tree-sitter Integration ¶

RepoMap uses tree-sitter for accurate code parsing:

• Supports Go and JavaScript languages
• Uses embedded SCM queries for component extraction
• Properly manages tree-sitter resources

Important Notes ¶

When using the go-tree-sitter package, always call Close() on objects that allocate memory from C:

• Parser
• Tree
• TreeCursor
• Query
• QueryCursor
• LookaheadIterator