code-analyze-core 0.4.1

Multi-language AST analysis library using tree-sitter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

// SPDX-FileCopyrightText: 2026 code-analyze-mcp contributors
// SPDX-License-Identifier: Apache-2.0
//! Multi-language code structure analysis library using tree-sitter.
//!
//! This crate provides core analysis functionality for extracting code structure
//! from multiple programming languages. It is designed to be used as a library
//! by MCP servers and other tools.
//!
//! # Features
//!
//! - **Language support**: Rust, Go, Java, Python, TypeScript, TSX, Fortran, JavaScript, C/C++, C# (feature-gated)
//! - **Schema generation**: Optional JSON schema support via the `schemars` feature
//! - **Async-friendly**: Uses tokio for concurrent analysis
//! - **Cancellation support**: Built-in cancellation token support
//!
//! # Examples
//!
//! ```no_run
//! use code_analyze_core::analyze::analyze_directory;
//! use std::path::Path;
//!
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let output = analyze_directory(Path::new("src"), None)?;
//! println!("Files: {:?}", output.files.len());
//! # Ok(())
//! # }
//! ```

pub mod analyze;
pub mod cache;
pub mod completion;
mod config;
pub mod formatter;
pub mod graph;
pub mod lang;
pub mod languages;
pub mod pagination;
pub mod parser;
pub mod test_detection;
pub mod traversal;
pub mod types;

#[cfg(feature = "schemars")]
pub mod schema_helpers;

pub(crate) const EXCLUDED_DIRS: &[&str] = &[
    "node_modules",
    "vendor",
    ".git",
    "__pycache__",
    "target",
    "dist",
    "build",
    ".venv",
];

// Re-exports of key public APIs
pub use analyze::{
    AnalysisOutput, AnalyzeError, CallChainEntry, FileAnalysisOutput, FocusedAnalysisConfig,
    FocusedAnalysisOutput, analyze_directory, analyze_directory_with_progress, analyze_file,
    analyze_focused, analyze_focused_with_progress, analyze_focused_with_progress_with_entries,
    analyze_module_file, analyze_str,
};
pub use config::AnalysisConfig;
pub use lang::{language_for_extension, supported_languages};
pub use parser::ParserError;
pub use types::*;

/// Captures from a custom tree-sitter query.
#[derive(Debug, Clone)]
pub struct QueryCapture {
    /// The capture name from the query (without leading `@`).
    pub capture_name: String,
    /// The matched source text.
    pub text: String,
    /// Start line (0-indexed).
    pub start_line: usize,
    /// End line (0-indexed, inclusive).
    pub end_line: usize,
    /// Start byte offset.
    pub start_byte: usize,
    /// End byte offset.
    pub end_byte: usize,
}

/// Execute a custom tree-sitter query against source code.
///
/// # Arguments
///
/// * `language` - Language name (e.g., "rust", "python"). Must be an enabled language feature.
/// * `source` - Source code to query.
/// * `query` - A tree-sitter query string (S-expression syntax).
///
/// # Returns
///
/// A vector of [`QueryCapture`] results, or a [`ParserError`] if the query is malformed
/// or the language is not supported.
///
/// # Security note
///
/// This function accepts user-controlled `query` strings. Pathological queries against
/// large `source` inputs may cause CPU exhaustion. Callers in untrusted environments
/// should bound the length of both `source` and `query` before calling this function.
/// `Query::new()` returns `Err` on malformed queries rather than panicking.
pub fn execute_query(
    language: &str,
    source: &str,
    query: &str,
) -> Result<Vec<QueryCapture>, parser::ParserError> {
    parser::execute_query_impl(language, source, query)
}