cruxlines 0.3.0

Ranks symbol definitions by cross-file references 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

use std::path::Path;

use tree_sitter::Node;

use crate::find_references::{Location, location_from_node, walk_tree};

pub(crate) const EXTENSIONS: &[&str] = &["go"];
pub(crate) const REFERENCE_KINDS: &[&str] = &["identifier", "type_identifier", "field_identifier"];

pub(crate) fn language() -> tree_sitter::Language {
    tree_sitter_go::LANGUAGE.into()
}

pub(crate) fn emit_definitions(
    path: &Path,
    source: &str,
    tree: &tree_sitter::Tree,
    mut emit: impl FnMut(Location),
) {
    walk_tree(tree, |node| match node.kind() {
        "function_declaration" | "method_declaration" => {
            if is_top_level(node)
                && let Some(name) = node.child_by_field_name("name")
                && let Some(location) = location_from_node(path, source, name)
            {
                emit(location);
            }
        }
        "type_spec" | "const_spec" | "var_spec" => {
            if is_top_level_spec(node)
                && let Some(name) = node.child_by_field_name("name")
                && let Some(location) = location_from_node(path, source, name)
            {
                emit(location);
            }
        }
        _ => {}
    });
}

pub(crate) fn emit_references(
    path: &Path,
    source: &str,
    tree: &tree_sitter::Tree,
    mut emit: impl FnMut(Location),
) {
    walk_tree(tree, |node| {
        if REFERENCE_KINDS.contains(&node.kind())
            && let Some(location) = location_from_node(path, source, node)
        {
            emit(location);
        }
    });
}

fn is_top_level(node: Node) -> bool {
    node.parent()
        .map(|parent| parent.kind() == "source_file")
        .unwrap_or(false)
}

fn is_top_level_spec(node: Node) -> bool {
    // type_spec, const_spec, var_spec can be:
    // 1. Direct children of *_declaration (single declaration)
    // 2. Inside *_spec_list which is inside *_declaration (grouped declaration)
    let Some(parent) = node.parent() else {
        return false;
    };

    // Check for direct parent being a declaration
    if matches!(
        parent.kind(),
        "type_declaration" | "const_declaration" | "var_declaration"
    ) {
        return is_top_level(parent);
    }

    // Check for grouped declarations: spec -> spec_list -> declaration
    if matches!(
        parent.kind(),
        "type_spec_list" | "const_spec_list" | "var_spec_list"
    ) {
        if let Some(grandparent) = parent.parent() {
            return matches!(
                grandparent.kind(),
                "type_declaration" | "const_declaration" | "var_declaration"
            ) && is_top_level(grandparent);
        }
    }

    false
}