aptu_coder_core/
lib.rs

1// SPDX-FileCopyrightText: 2026 aptu-coder contributors
2// SPDX-License-Identifier: Apache-2.0
3//! Multi-language code structure analysis library using tree-sitter.
4//!
5//! This crate provides core analysis functionality for extracting code structure
6//! from multiple programming languages. It is designed to be used as a library
7//! by MCP servers and other tools.
8//!
9//! # Features
10//!
11//! - **Language support**: Astro, C/C++, C#, CSS, Fortran, Go, HTML, Java, JavaScript, JSON, Kotlin, Markdown, Python, Rust, TOML, TSX, TypeScript, YAML (feature-gated)
12//! - **Schema generation**: Optional JSON schema support via the `schemars` feature
13//! - **Async-friendly**: Uses tokio for concurrent analysis
14//! - **Cancellation support**: Built-in cancellation token support
15//!
16//! # Examples
17//!
18//! ```no_run
19//! use aptu_coder_core::analyze::analyze_directory;
20//! use std::path::Path;
21//!
22//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
23//! let output = analyze_directory(Path::new("src"), None)?;
24//! println!("Files: {:?}", output.files.len());
25//! # Ok(())
26//! # }
27//! ```
28
29#![cfg_attr(test, allow(clippy::unwrap_used))]
30#![cfg_attr(test, allow(clippy::expect_used))]
31
32pub mod analyze;
33pub mod cache;
34pub mod completion;
35mod config;
36pub mod edit;
37pub mod formatter;
38pub mod formatter_defuse;
39pub mod graph;
40pub mod lang;
41pub mod languages;
42pub mod pagination;
43pub mod parser;
44pub mod test_detection;
45pub mod traversal;
46pub mod types;
47
48#[cfg(feature = "schemars")]
49pub mod schema_helpers;
50
51pub const EXCLUDED_DIRS: &[&str] = &[
52    "node_modules",
53    "vendor",
54    ".git",
55    "__pycache__",
56    "target",
57    "dist",
58    "build",
59    ".venv",
60];
61
62// Re-exports of key public APIs
63pub use analyze::{
64    AnalysisOutput, AnalyzeError, CallChainEntry, FileAnalysisOutput, FocusedAnalysisConfig,
65    FocusedAnalysisOutput, analyze_directory, analyze_directory_with_progress, analyze_file,
66    analyze_focused, analyze_focused_with_progress, analyze_focused_with_progress_with_entries,
67    analyze_module_file, analyze_str,
68};
69pub use config::AnalysisConfig;
70pub use edit::{EditError, edit_overwrite_content, edit_replace_block};
71pub use graph::{GraphError, InternalCallChain};
72pub use lang::{language_for_extension, supported_languages};
73pub use pagination::{CursorData, PaginationError};
74pub use parser::ParserError;
75pub use traversal::{TraversalError, WalkEntry};
76pub use types::{
77    AnalysisMode, AnalyzeDirectoryParams, AnalyzeFileField, AnalyzeFileParams, AnalyzeModuleParams,
78    AnalyzeSymbolParams, CallEdge, CallInfo, ClassInfo, DefUseKind, DefUseSite,
79    EditOverwriteOutput, EditOverwriteParams, EditReplaceOutput, EditReplaceParams, FileInfo,
80    FilterRule, FunctionInfo, ImplTraitInfo, ImportInfo, ModuleFunctionInfo, ModuleImportInfo,
81    ModuleInfo, OutputControlParams, PaginationParams, ReferenceInfo, ReferenceType,
82    SemanticAnalysis, SymbolMatchMode,
83};
84
85/// Captures from a custom tree-sitter query.
86#[derive(Debug, Clone, PartialEq, Eq, Hash)]
87pub struct QueryCapture {
88    /// The capture name from the query (without leading `@`).
89    pub capture_name: String,
90    /// The matched source text.
91    pub text: String,
92    /// Start line (0-indexed).
93    pub start_line: usize,
94    /// End line (0-indexed, inclusive).
95    pub end_line: usize,
96    /// Start byte offset.
97    pub start_byte: usize,
98    /// End byte offset.
99    pub end_byte: usize,
100}
101
102/// Execute a custom tree-sitter query against source code.
103///
104/// # Arguments
105///
106/// * `language` - Language name (e.g., "rust", "python"). Must be an enabled language feature.
107/// * `source` - Source code to query.
108/// * `query` - A tree-sitter query string (S-expression syntax).
109///
110/// # Returns
111///
112/// A vector of [`QueryCapture`] results, or a [`ParserError`] if the query is malformed
113/// or the language is not supported.
114///
115/// # Security note
116///
117/// This function accepts user-controlled `query` strings. Pathological queries against
118/// large `source` inputs may cause CPU exhaustion. Callers in untrusted environments
119/// should bound the length of both `source` and `query` before calling this function.
120/// `Query::new()` returns `Err` on malformed queries rather than panicking.
121pub fn execute_query(
122    language: &str,
123    source: &str,
124    query: &str,
125) -> Result<Vec<QueryCapture>, parser::ParserError> {
126    parser::execute_query_impl(language, source, query)
127}
aptu_coder_core/lib.rs

aptu_coder_core/
lib.rs
