Skip to content

test: verify all keywords of grammar are available in completions #701

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
juleswritescode merged 5 commits into from
Mar 6, 2026
Merged

test: verify all keywords of grammar are available in completions #701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ab05f1
Initial
juleswritescode Mar 1, 2026
ceacc88
beaut
juleswritescode Mar 1, 2026
14a7da6
much better approach
juleswritescode Mar 1, 2026
69e39ac
removed unreachable keywords
juleswritescode Mar 1, 2026
105779b
Merge branch 'main' into test/keyword-creation
juleswritescode Mar 6, 2026
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
103 changes: 93 additions & 10 deletions crates/pgls_completions/src/providers/keywords.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("boolean"),
SqlKeyword::new("brin"),
SqlKeyword::new("btree"),
SqlKeyword::new("buffer_usage_limit"),
SqlKeyword::new("buffers"),
SqlKeyword::new("by"),
SqlKeyword::new("bytea"),
SqlKeyword::new("cache"),
Expand All @@ -77,7 +79,6 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("check"),
SqlKeyword::new("collate"),
SqlKeyword::new("column"),
SqlKeyword::new("columns"),
SqlKeyword::new("comment").starts_statement(),
SqlKeyword::new("commit").starts_statement(),
SqlKeyword::new("committed"),
Expand All @@ -89,6 +90,7 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("constraints"),
SqlKeyword::new("copy").starts_statement(),
SqlKeyword::new("cost"),
SqlKeyword::new("costs"),
SqlKeyword::new("create").starts_statement(),
SqlKeyword::new("cross"),
SqlKeyword::new("csv"),
Expand All @@ -109,7 +111,6 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("delete").starts_statement(),
SqlKeyword::new("delimiter"),
SqlKeyword::new("desc"),
SqlKeyword::new("disable_page_skipping"),
SqlKeyword::new("distinct"),
SqlKeyword::new("do").starts_statement(),
SqlKeyword::new("double"),
Expand Down Expand Up @@ -149,6 +150,7 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("function"),
SqlKeyword::new("functions"),
SqlKeyword::new("generated"),
SqlKeyword::new("generic_plan"),
SqlKeyword::new("gin"),
SqlKeyword::new("gist"),
SqlKeyword::new("grant").starts_statement(),
Expand All @@ -159,12 +161,12 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("having"),
SqlKeyword::new("header"),
SqlKeyword::new("if"),
SqlKeyword::new("ignore"),
SqlKeyword::new("immediate"),
SqlKeyword::new("immutable"),
SqlKeyword::new("in").require_prefix(),
SqlKeyword::new("increment"),
SqlKeyword::new("index"),
SqlKeyword::new("index_cleanup"),
SqlKeyword::new("inet"),
SqlKeyword::new("inherit"),
SqlKeyword::new("initially"),
Expand Down Expand Up @@ -194,14 +196,15 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("limit"),
SqlKeyword::new("list"),
SqlKeyword::new("local"),
SqlKeyword::new("location"),
SqlKeyword::new("log_verbosity"),
SqlKeyword::new("logged"),
SqlKeyword::new("main"),
SqlKeyword::new("maintain"),
SqlKeyword::new("match"),
SqlKeyword::new("matched"),
SqlKeyword::new("materialized"),
SqlKeyword::new("maxvalue"),
SqlKeyword::new("memory"),
SqlKeyword::new("merge").starts_statement(),
SqlKeyword::new("minvalue"),
SqlKeyword::new("money"),
Expand All @@ -213,7 +216,6 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("none"),
SqlKeyword::new("not").require_prefix(),
SqlKeyword::new("nothing"),
SqlKeyword::new("nowait"),
SqlKeyword::new("null").require_prefix(),
SqlKeyword::new("nulls"),
SqlKeyword::new("numeric"),
Expand All @@ -224,6 +226,7 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("oids"),
SqlKeyword::new("old"),
SqlKeyword::new("on"),
SqlKeyword::new("on_error"),
SqlKeyword::new("only").require_prefix(),
SqlKeyword::new("option"),
SqlKeyword::new("or").require_prefix(),
Expand All @@ -238,19 +241,16 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("owner"),
SqlKeyword::new("parallel"),
SqlKeyword::new("partition"),
SqlKeyword::new("partitioned"),
SqlKeyword::new("password"),
SqlKeyword::new("permissive"),
SqlKeyword::new("plain"),
SqlKeyword::new("policy"),
SqlKeyword::new("precedes"),
SqlKeyword::new("preceding"),
SqlKeyword::new("precision"),
SqlKeyword::new("primary"),
SqlKeyword::new("privileges"),
SqlKeyword::new("procedure"),
SqlKeyword::new("procedures"),
SqlKeyword::new("process_toast"),
SqlKeyword::new("program"),
SqlKeyword::new("public"),
SqlKeyword::new("quote"),
Expand All @@ -264,10 +264,10 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("regnamespace"),
SqlKeyword::new("regproc"),
SqlKeyword::new("regtype"),
SqlKeyword::new("reject_limit"),
SqlKeyword::new("rename"),
SqlKeyword::new("repeatable"),
SqlKeyword::new("replace"),
SqlKeyword::new("replication"),
SqlKeyword::new("reset").starts_statement(),
SqlKeyword::new("restart"),
SqlKeyword::new("restrict"),
Expand All @@ -277,7 +277,6 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("returning"),
SqlKeyword::new("returns"),
SqlKeyword::new("revoke").starts_statement(),
SqlKeyword::new("rewrite"),
SqlKeyword::new("right"),
SqlKeyword::new("role"),
SqlKeyword::new("rollback").starts_statement(),
Expand All @@ -296,7 +295,10 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("session_user"),
SqlKeyword::new("set").starts_statement(),
SqlKeyword::new("setof"),
SqlKeyword::new("settings"),
SqlKeyword::new("share"),
SqlKeyword::new("show").starts_statement(),
SqlKeyword::new("silent"),
SqlKeyword::new("similar").require_prefix(),
SqlKeyword::new("skip_locked"),
SqlKeyword::new("smallint"),
Expand All @@ -309,9 +311,12 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("statement"),
SqlKeyword::new("statistics"),
SqlKeyword::new("stdin"),
SqlKeyword::new("stdout"),
SqlKeyword::new("stop"),
SqlKeyword::new("storage"),
SqlKeyword::new("stored"),
SqlKeyword::new("strict"),
SqlKeyword::new("summary"),
SqlKeyword::new("support"),
SqlKeyword::new("system"),
SqlKeyword::new("table"),
Expand All @@ -325,6 +330,7 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("time"),
SqlKeyword::new("timestamp"),
SqlKeyword::new("timestamptz"),
SqlKeyword::new("timing"),
SqlKeyword::new("to"),
SqlKeyword::new("transaction"),
SqlKeyword::new("trigger"),
Expand Down Expand Up @@ -353,13 +359,15 @@ pub static ALL_KEYWORDS: &[SqlKeyword] = &[
SqlKeyword::new("version"),
SqlKeyword::new("view"),
SqlKeyword::new("volatile"),
SqlKeyword::new("wal"),
SqlKeyword::new("when"),
SqlKeyword::new("where"),
SqlKeyword::new("window"),
SqlKeyword::new("with").starts_statement(),
SqlKeyword::new("without"),
SqlKeyword::new("write"),
SqlKeyword::new("xml"),
SqlKeyword::new("yaml"),
SqlKeyword::new("zone"),
];

Expand Down Expand Up @@ -409,17 +417,92 @@ pub fn complete_keywords<'a>(

#[cfg(test)]
mod tests {
use std::collections::HashSet;

use pgls_test_utils::QueryWithCursorPosition;
use regex::Regex;
use sqlx::PgPool;
use tree_sitter::Language;

use crate::{
CompletionItemKind,
providers::keywords::ALL_KEYWORDS,
test_helper::{
CompletionAssertion, TestCompletionsCase, TestCompletionsSuite,
assert_complete_results, assert_no_complete_results,
},
};

#[test]
fn has_all_keywords_from_treesitter_grammar() {
let expected_keywords = keywords_from_treesitter_grammar();
let actual_keywords = all_keywords_set();

let mut missing_keywords = expected_keywords
.difference(&actual_keywords)
.cloned()
.collect::<Vec<_>>();
missing_keywords.sort_unstable();

assert!(
missing_keywords.is_empty(),
"Found {} keyword(s) from tree-sitter grammar that are missing from ALL_KEYWORDS.\n\
Add missing entries to ALL_KEYWORDS in crates/pgls_completions/src/providers/keywords.rs.\n\
Missing keywords:\n{}",
missing_keywords.len(),
missing_keywords.join("\n")
);
}

#[test]
fn has_no_extra_keywords_outside_treesitter_grammar() {
let expected_keywords = keywords_from_treesitter_grammar();
let actual_keywords = all_keywords_set();

let mut extra_keywords = actual_keywords
.difference(&expected_keywords)
.cloned()
.collect::<Vec<_>>();
extra_keywords.sort_unstable();

assert!(
extra_keywords.is_empty(),
"Found {} keyword(s) in ALL_KEYWORDS that are not tree-sitter grammar keywords.\n\
Remove these from ALL_KEYWORDS or add matching keyword_* symbols to grammar.js.\n\
Extra keywords:\n{}",
extra_keywords.len(),
extra_keywords.join("\n")
);
}

fn all_keywords_set() -> HashSet<String> {
ALL_KEYWORDS
.iter()
.map(|keyword| keyword.name.to_string())
.collect::<HashSet<_>>()
}

fn keywords_from_treesitter_grammar() -> HashSet<String> {
let language: Language = pgls_treesitter_grammar::LANGUAGE.into();
// Tree-sitter generates auxiliary symbol names like `keyword_int_token2` for keyword
// rules that use `choice(...)`. Strip the suffix to compare canonical keyword names.
let generated_token_suffix =
Regex::new(r"_token\d+$").expect("valid regex for generated token suffix");
let mut keywords = HashSet::new();

for id in 0..language.node_kind_count() {
let Some(kind) = language.node_kind_for_id(id as u16) else {
continue;
};
if let Some(keyword) = kind.strip_prefix("keyword_") {
let keyword = generated_token_suffix.replace(keyword, "").to_string();
keywords.insert(keyword);
}
}

keywords
}

#[sqlx::test]
async fn completes_stmt_start_keywords(pool: PgPool) {
let setup = r#"
Expand Down
8 changes: 0 additions & 8 deletions crates/pgls_treesitter_grammar/grammar.js
View file
Open in desktop
Copy link
Copy Markdown
Collaborator Author

@juleswritescode juleswritescode Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these keywords were unreachable 👍🏻

Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@ module.exports = grammar({
keyword_tables: (_) => make_keyword("tables"),
keyword_view: (_) => make_keyword("view"),
keyword_column: (_) => make_keyword("column"),
keyword_columns: (_) => make_keyword("columns"),
keyword_materialized: (_) => make_keyword("materialized"),
keyword_tablespace: (_) => make_keyword("tablespace"),
keyword_sequence: (_) => make_keyword("sequence"),
Expand Down Expand Up @@ -263,7 +262,6 @@ module.exports = grammar({
keyword_check: (_) => make_keyword("check"),
keyword_option: (_) => make_keyword("option"),
keyword_vacuum: (_) => make_keyword("vacuum"),
keyword_nowait: (_) => make_keyword("nowait"),
keyword_attribute: (_) => make_keyword("attribute"),
keyword_authorization: (_) => make_keyword("authorization"),
keyword_action: (_) => make_keyword("action"),
Expand Down Expand Up @@ -300,7 +298,6 @@ module.exports = grammar({
keyword_timing: (_) => make_keyword("timing"),
keyword_summary: (_) => make_keyword("summary"),
keyword_memory: (_) => make_keyword("memory"),
keyword_serialize: (_) => make_keyword("serialize"),
keyword_skip_locked: (_) => make_keyword("skip_locked"),
keyword_buffer_usage_limit: (_) => make_keyword("buffer_usage_limit"),

Expand Down Expand Up @@ -373,7 +370,6 @@ module.exports = grammar({
keyword_constraints: (_) => make_keyword("constraints"),
keyword_snapshot: (_) => make_keyword("snapshot"),
keyword_characteristics: (_) => make_keyword("characteristics"),
keyword_precedes: (_) => make_keyword("precedes"),
keyword_each: (_) => make_keyword("each"),
keyword_instead: (_) => make_keyword("instead"),
keyword_of: (_) => make_keyword("of"),
Expand All @@ -388,11 +384,7 @@ module.exports = grammar({

keyword_external: (_) => make_keyword("external"),
keyword_stored: (_) => make_keyword("stored"),
keyword_replication: (_) => make_keyword("replication"),
keyword_statistics: (_) => make_keyword("statistics"),
keyword_rewrite: (_) => make_keyword("rewrite"),
keyword_location: (_) => make_keyword("location"),
keyword_partitioned: (_) => make_keyword("partitioned"),
keyword_comment: (_) => make_keyword("comment"),
keyword_format: (_) => make_keyword("format"),
keyword_delimiter: (_) => make_keyword("delimiter"),
Expand Down
Loading