PromptMap

PromptMap is a powerful .NET console application that streamlines the process of providing context to AI coding assistants like ChatGPT. This tool scans Visual Studio solution files (.sln) or directories containing .cs files and generates a structured map of your project, detailing files, namespaces, classes, methods, and properties.

With the output specifically designed to be AI-friendly, users can easily paste this structured information into ChatGPT to enhance the quality of coding assistance and to ensure accurate and relevant responses while discussing project details.

Key Features

• Recursively parses .sln files or directories, making it comprehensive and easy to use.
• Maps out namespaces, classes, methods, and properties to provide a complete overview of the project structure.
• Options available to include private members and constructors to return a more detailed mapping based on user needs.
• Outputs the generated map to a file or displays it in standard output for immediate use.
• Operates locally without reliance on external services, ensuring user privacy and data security.

Usage Example

To use PromptMap, simply run:

promptmap --solution <path-to.sln> [options]
promptmap --dir <path-to-directory> [options]

Options

The application provides several command-line options for flexibility:

Example Output

Here’s an example of PromptMap generating a structure for itself:

PromptMap
 └─ PromptMap
     ├─ <global namespace>
     │   └─ Program
     │       ├─ Method Task<int> Main(string[] args) [public]
     ├─ PromptMap.Cli
     │   ├─ ArgParser
     │   │   ├─ Method Options Parse(string[] args) [public]
     │   │   ├─ Method void PrintHelp(bool error) [public]
     │   ├─ Node
     │   │   ├─ Property string Name { get; } [public]
     │   │   ├─ Property SortedDictionary<string, Node> Children { get; } [public]
     │   │   ├─ Property List<string> Lines { get; } [public]
     │   └─ Options
     │       ├─ Property string? SolutionPath { get; set; } [public]
     │       ├─ Property string? DirPath { get; set; } [public]
     │       ├─ Property string? OutPath { get; set; } [public]
     │       ├─ Property bool IncludePrivate { get; set; } [public]
     │       ├─ Property bool IncludeCtors { get; set; } [public]
     ├─ PromptMap.Cli.Analysis
     │   └─ RoslynWalker
     │       ├─ Method Task<Node> FromSolutionAsync(string solutionPath, bool includePrivate, bool includeCtors, CancellationToken ct) [public]
     │       ├─ Method Node FromDirectory(string dirPath, bool includePrivate, bool includeCtors, CancellationToken ct) [public]
     └─ PromptMap.Cli.Printing
         └─ TreePrinter
             ├─ Method string Print(Node root) [public]

Why Use PromptMap?

Providing the right context to AI coding assistants is essential for effective collaboration. Rather than manually describing project structures or pasting in files, PromptMap offers a comprehensive overview in a condensed, easy-to-read format, ensuring that AI tools can assist users more accurately and effectively.