Skip to content

ide: add basic find refs support #760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 2 commits into from
Dec 24, 2025
Merged

ide: add basic find refs support #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
561733b
ide: add basic find refs support
sbdchd Dec 24, 2025
947360c
fix
sbdchd Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
345 changes: 345 additions & 0 deletions crates/squawk_ide/src/find_references.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,345 @@
use crate::binder::{self, Binder};
use crate::offsets::token_from_offset;
use crate::resolve;
use rowan::{TextRange, TextSize};
use squawk_syntax::{
SyntaxNodePtr,
ast::{self, AstNode},
match_ast,
};

pub fn find_references(file: &ast::SourceFile, offset: TextSize) -> Vec<TextRange> {
let binder = binder::bind(file);
let Some(target) = find_target(file, offset, &binder) else {
return vec![];
};

let mut refs = vec![];

for node in file.syntax().descendants() {
match_ast! {
match node {
ast::NameRef(name_ref) => {
if let Some(found) = resolve::resolve_name_ref(&binder, &name_ref)
&& found == target
{
refs.push(name_ref.syntax().text_range());
}
},
ast::Name(name) => {
let found = SyntaxNodePtr::new(name.syntax());
if found == target {
refs.push(name.syntax().text_range());
}
},
_ => (),
}
}
}

refs.sort_by_key(|range| range.start());
refs
}

fn find_target(file: &ast::SourceFile, offset: TextSize, binder: &Binder) -> Option<SyntaxNodePtr> {
let token = token_from_offset(file, offset)?;
let parent = token.parent()?;

if let Some(name) = ast::Name::cast(parent.clone()) {
return Some(SyntaxNodePtr::new(name.syntax()));
}

if let Some(name_ref) = ast::NameRef::cast(parent.clone())
&& let Some(ptr) = resolve::resolve_name_ref(binder, &name_ref)
{
return Some(ptr);
}

None
}

#[cfg(test)]
mod test {
use crate::find_references::find_references;
use crate::test_utils::fixture;
use annotate_snippets::{AnnotationKind, Level, Renderer, Snippet, renderer::DecorStyle};
use insta::assert_snapshot;
use squawk_syntax::ast;

#[track_caller]
fn find_refs(sql: &str) -> String {
let (mut offset, sql) = fixture(sql);
offset = offset.checked_sub(1.into()).unwrap_or_default();
let parse = ast::SourceFile::parse(&sql);
assert_eq!(parse.errors(), vec![]);
let file: ast::SourceFile = parse.tree();

let references = find_references(&file, offset);

let offset_usize: usize = offset.into();

let labels: Vec<String> = (1..=references.len())
.map(|i| format!("{}. reference", i))
.collect();

let mut snippet = Snippet::source(&sql).fold(true).annotation(
AnnotationKind::Context
.span(offset_usize..offset_usize + 1)
.label("0. query"),
);

for (i, range) in references.iter().enumerate() {
snippet = snippet.annotation(
AnnotationKind::Context
.span((*range).into())
.label(&labels[i]),
);
}

let group = Level::INFO.primary_title("references").element(snippet);
let renderer = Renderer::plain().decor_style(DecorStyle::Unicode);
renderer
.render(&[group])
.to_string()
.replace("info: references", "")
}

#[test]
fn simple_table_reference() {
assert_snapshot!(find_refs("
create table t();
drop table t$0;
"), @r"
╭▸
2 │ create table t();
│ ─ 1. reference
3 │ drop table t;
│ ┬
│ │
│ 0. query
╰╴ 2. reference
");
}

#[test]
fn multiple_references() {
assert_snapshot!(find_refs("
create table users();
drop table users$0;
table users;
"), @r"
╭▸
2 │ create table users();
│ ───── 1. reference
3 │ drop table users;
│ ┬───┬
│ │ │
│ │ 0. query
│ 2. reference
4 │ table users;
╰╴ ───── 3. reference
");
}

#[test]
fn find_from_definition() {
assert_snapshot!(find_refs("
create table t$0();
drop table t;
"), @r"
╭▸
2 │ create table t();
│ ┬
│ │
│ 0. query
│ 1. reference
3 │ drop table t;
╰╴ ─ 2. reference
");
}

#[test]
fn with_schema_qualified() {
assert_snapshot!(find_refs("
create table public.users();
drop table public.users$0;
table users;
"), @r"
╭▸
2 │ create table public.users();
│ ───── 1. reference
3 │ drop table public.users;
│ ┬───┬
│ │ │
│ │ 0. query
│ 2. reference
4 │ table users;
╰╴ ───── 3. reference
");
}

#[test]
fn temp_table_shadows_public() {
assert_snapshot!(find_refs("
create table t();
create temp table t$0();
drop table t;
"), @r"
╭▸
3 │ create temp table t();
│ ┬
│ │
│ 0. query
│ 1. reference
4 │ drop table t;
╰╴ ─ 2. reference
");
}

#[test]
fn different_schema_no_match() {
assert_snapshot!(find_refs("
create table foo.t();
create table bar.t$0();
"), @r"
╭▸
3 │ create table bar.t();
│ ┬
│ │
│ 0. query
╰╴ 1. reference
");
}

#[test]
fn with_search_path() {
assert_snapshot!(find_refs("
set search_path to myschema;
create table myschema.users$0();
drop table users;
"), @r"
╭▸
3 │ create table myschema.users();
│ ┬───┬
│ │ │
│ │ 0. query
│ 1. reference
4 │ drop table users;
╰╴ ───── 2. reference
");
}

#[test]
fn temp_table_with_pg_temp_schema() {
assert_snapshot!(find_refs("
create temp table t();
drop table pg_temp.t$0;
"), @r"
╭▸
2 │ create temp table t();
│ ─ 1. reference
3 │ drop table pg_temp.t;
│ ┬
│ │
│ 0. query
╰╴ 2. reference
");
}

#[test]
fn case_insensitive() {
assert_snapshot!(find_refs("
create table Users();
drop table USERS$0;
table users;
"), @r"
╭▸
2 │ create table Users();
│ ───── 1. reference
3 │ drop table USERS;
│ ┬───┬
│ │ │
│ │ 0. query
│ 2. reference
4 │ table users;
╰╴ ───── 3. reference
");
}
#[test]
fn case_insensitive_part_2() {
// we should see refs for `drop table` and `table`
assert_snapshot!(find_refs(r#"
create table actors();
create table "Actors"();
drop table ACTORS$0;
table actors;
"#), @r#"
╭▸
2 │ create table actors();
│ ────── 1. reference
3 │ create table "Actors"();
4 │ drop table ACTORS;
│ ┬────┬
│ │ │
│ │ 0. query
│ 2. reference
5 │ table actors;
╰╴ ────── 3. reference
"#);
}

#[test]
fn case_insensitive_with_schema() {
assert_snapshot!(find_refs("
create table Public.Users();
drop table PUBLIC.USERS$0;
table public.users;
"), @r"
╭▸
2 │ create table Public.Users();
│ ───── 1. reference
3 │ drop table PUBLIC.USERS;
│ ┬───┬
│ │ │
│ │ 0. query
│ 2. reference
4 │ table public.users;
╰╴ ───── 3. reference
");
}

#[test]
fn no_partial_match() {
assert_snapshot!(find_refs("
create table t$0();
create table temp_t();
"), @r"
╭▸
2 │ create table t();
│ ┬
│ │
│ 0. query
╰╴ 1. reference
");
}

#[test]
fn identifier_boundaries() {
assert_snapshot!(find_refs("
create table foo$0();
drop table foo;
drop table foo1;
drop table barfoo;
drop table foo_bar;
"), @r"
╭▸
2 │ create table foo();
│ ┬─┬
│ │ │
│ │ 0. query
│ 1. reference
3 │ drop table foo;
╰╴ ─── 2. reference
");
}
}
18 changes: 18 additions & 0 deletions crates/squawk_ide/src/goto_definition.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ pub fn goto_definition(file: ast::SourceFile, offset: TextSize) -> Option<TextRa
}
}

if let Some(name) = ast::Name::cast(parent.clone()) {
return Some(name.syntax().text_range());
}

if let Some(name_ref) = ast::NameRef::cast(parent.clone()) {
let binder_output = binder::bind(&file);
if let Some(ptr) = resolve::resolve_name_ref(&binder_output, &name_ref) {
Expand Down Expand Up @@ -303,6 +307,20 @@ drop table pg_temp.t$0;
");
}

#[test]
fn goto_table_definition_returns_self() {
assert_snapshot!(goto("
create table t$0(x bigint, y bigint);
"), @r"
╭▸
2 │ create table t(x bigint, y bigint);
│ ┬
│ │
│ 2. destination
╰╴ 1. source
");
}

#[test]
fn goto_drop_temp_table_shadows_public() {
// temp tables shadow public tables when no schema is specified
Expand Down
1 change: 1 addition & 0 deletions crates/squawk_ide/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ mod binder;
pub mod code_actions;
pub mod column_name;
pub mod expand_selection;
pub mod find_references;
mod generated;
pub mod goto_definition;
mod offsets;
Expand Down
Loading
Loading