ae::xtr

High-performance documentation extraction tool

vv1.0.0 Since 2024-08-15

Overview

ae-xtr is a high-performance documentation extraction tool built with Rust that automatically generates comprehensive markdown documentation from source code. It parses codebases across multiple languages using tree-sitter AST parsing to extract specially decorated comments (@ae::dx) and transforms them into structured documentation.

Tech Stack

RustTree-sitterCLI ToolsMarkdownAST Parsing

Features

  • Multi-Language Support for 9+ programming languages using tree-sitter AST parsing
  • JSDoc Compatibility with full support for JavaScript/TypeScript documentation
  • Parallel Processing using Rayon for lightning-fast concurrent file parsing
  • Git-Aware Scanning that respects .gitignore patterns and Git configuration
  • Watch Mode for continuous documentation updates during development
  • Decorator System with flexible @ae::dx syntax and multiple tag types
  • Comprehensive CLI with professional command structure (generate, watch, stats, check)
  • Smart Output Structure that mirrors source code directory organization

Status

Active development with core functionality complete and recent enhancements for special character escaping, multiline signature detection, and type annotation handling.