Skip to content

chore(splinter): initial commit #594

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
merged 15 commits into from
Nov 7, 2025
Merged

chore(splinter): initial commit #594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
59d1c1d
chore(splinter): initial commit
psteinroe Nov 1, 2025
9d34d82
progress
psteinroe Nov 1, 2025
f3fd30c
progress
psteinroe Nov 1, 2025
964de40
progress
psteinroe Nov 1, 2025
09c5718
progress
psteinroe Nov 1, 2025
bc721f7
fix: test
psteinroe Nov 1, 2025
92005d8
refactor: use categories as group
psteinroe Nov 1, 2025
1dcb8d7
refactor: use categories as group
psteinroe Nov 1, 2025
60fd54e
fix: format
psteinroe Nov 1, 2025
e7a2dd5
fix: unknown url and add groups to categories
psteinroe Nov 1, 2025
c35affc
fix: unknown url and add groups to categories
psteinroe Nov 1, 2025
81b811c
fix: lint
psteinroe Nov 1, 2025
7959d9e
progress
psteinroe Nov 7, 2025
d91f55b
progress
psteinroe Nov 7, 2025
a747f39
progress
psteinroe Nov 7, 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
2 changes: 2 additions & 0 deletions .github/workflows/pull_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,8 @@ jobs:
run: cargo run -p xtask_codegen -- configuration
- name: Run the bindings codegen
run: cargo run -p xtask_codegen -- bindings
- name: Run the splinter codegen
run: cargo run -p xtask_codegen -- splinter
- name: Run the docs codegen
run: cargo run -p docs_codegen
- name: Check for git diff -- run "just ready" if you see an error
Expand Down
74 changes: 74 additions & 0 deletions .sqlx/query-b869d517301aaf69d382f092c09d5a53712d68afd273423f9310cd793586f532.json
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ pgls_query = { path = "./crates/pgls_query", version = "0.0.0"
pgls_query_ext = { path = "./crates/pgls_query_ext", version = "0.0.0" }
pgls_query_macros = { path = "./crates/pgls_query_macros", version = "0.0.0" }
pgls_schema_cache = { path = "./crates/pgls_schema_cache", version = "0.0.0" }
pgls_splinter = { path = "./crates/pgls_splinter", version = "0.0.0" }
pgls_statement_splitter = { path = "./crates/pgls_statement_splitter", version = "0.0.0" }
pgls_suppressions = { path = "./crates/pgls_suppressions", version = "0.0.0" }
pgls_text_edit = { path = "./crates/pgls_text_edit", version = "0.0.0" }
Expand Down
155 changes: 31 additions & 124 deletions crates/pgls_completions/src/providers/roles.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,31 @@ mod tests {
);
"#;

fn expected_roles() -> Vec<CompletionAssertion> {
vec![
CompletionAssertion::LabelAndKind("anon".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"authenticated".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"service_role".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind("test_login".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
]
}

#[sqlx::test(migrator = "pgls_test_utils::MIGRATIONS")]
async fn works_in_drop_role(pool: PgPool) {
assert_complete_results(
format!("drop role {}", QueryWithCursorPosition::cursor_marker()).as_str(),
vec![
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
Some(SETUP),
&pool,
)
Expand All @@ -71,17 +81,7 @@ mod tests {
async fn works_in_alter_role(pool: PgPool) {
assert_complete_results(
format!("alter role {}", QueryWithCursorPosition::cursor_marker()).as_str(),
vec![
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
Some(SETUP),
&pool,
)
Expand All @@ -94,17 +94,7 @@ mod tests {

assert_complete_results(
format!("set role {}", QueryWithCursorPosition::cursor_marker()).as_str(),
vec![
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
None,
&pool,
)
Expand All @@ -116,17 +106,7 @@ mod tests {
QueryWithCursorPosition::cursor_marker()
)
.as_str(),
vec![
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
None,
&pool,
)
Expand All @@ -140,24 +120,14 @@ mod tests {
assert_complete_results(
format!(
r#"create policy "my cool policy" on public.users
as restrictive
as restrictive
for all
to {}
using (true);"#,
QueryWithCursorPosition::cursor_marker()
)
.as_str(),
vec![
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
None,
&pool,
)
Expand All @@ -171,17 +141,7 @@ mod tests {
QueryWithCursorPosition::cursor_marker()
)
.as_str(),
vec![
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
None,
&pool,
)
Expand All @@ -200,18 +160,7 @@ mod tests {
QueryWithCursorPosition::cursor_marker()
)
.as_str(),
vec![
// recognizing already mentioned roles is not supported for now
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
None,
&pool,
)
Expand All @@ -225,18 +174,7 @@ mod tests {
QueryWithCursorPosition::cursor_marker()
)
.as_str(),
vec![
// recognizing already mentioned roles is not supported for now
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
None,
&pool,
)
Expand All @@ -248,18 +186,7 @@ mod tests {
QueryWithCursorPosition::cursor_marker()
)
.as_str(),
vec![
// recognizing already mentioned roles is not supported for now
CompletionAssertion::LabelAndKind("owner".into(), crate::CompletionItemKind::Role),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
expected_roles(),
None,
&pool,
)
Expand Down Expand Up @@ -298,27 +225,7 @@ mod tests {
];

for query in queries {
assert_complete_results(
query.as_str(),
vec![
// recognizing already mentioned roles is not supported for now
CompletionAssertion::LabelAndKind(
"owner".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_login".into(),
crate::CompletionItemKind::Role,
),
CompletionAssertion::LabelAndKind(
"test_nologin".into(),
crate::CompletionItemKind::Role,
),
],
None,
&pool,
)
.await;
assert_complete_results(query.as_str(), expected_roles(), None, &pool).await;
}
}
}
31 changes: 31 additions & 0 deletions crates/pgls_diagnostics_categories/src/categories.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,30 @@ define_categories! {
"lint/safety/runningStatementWhileHoldingAccessExclusive": "https://pg-language-server.com/latest/rules/running-statement-while-holding-access-exclusive",
"lint/safety/transactionNesting": "https://pg-language-server.com/latest/rules/transaction-nesting",
// end lint rules
// splinter rules start
"splinter/performance/authRlsInitplan": "https://supabase.com/docs/guides/database/database-linter?lint=0003_auth_rls_initplan",
"splinter/performance/duplicateIndex": "https://supabase.com/docs/guides/database/database-linter?lint=0009_duplicate_index",
"splinter/performance/multiplePermissivePolicies": "https://supabase.com/docs/guides/database/database-linter?lint=0006_multiple_permissive_policies",
"splinter/performance/noPrimaryKey": "https://supabase.com/docs/guides/database/database-linter?lint=0004_no_primary_key",
"splinter/performance/tableBloat": "https://supabase.com/docs/guides/database/database-linter?lint=0020_table_bloat",
"splinter/performance/unindexedForeignKeys": "https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys",
"splinter/performance/unusedIndex": "https://supabase.com/docs/guides/database/database-linter?lint=0005_unused_index",
"splinter/security/authUsersExposed": "https://supabase.com/docs/guides/database/database-linter?lint=0002_auth_users_exposed",
"splinter/security/extensionInPublic": "https://supabase.com/docs/guides/database/database-linter?lint=0014_extension_in_public",
"splinter/security/extensionVersionsOutdated": "https://supabase.com/docs/guides/database/database-linter?lint=0022_extension_versions_outdated",
"splinter/security/fkeyToAuthUnique": "https://supabase.com/docs/guides/database/database-linter?lint=0021_fkey_to_auth_unique",
"splinter/security/foreignTableInApi": "https://supabase.com/docs/guides/database/database-linter?lint=0017_foreign_table_in_api",
"splinter/security/functionSearchPathMutable": "https://supabase.com/docs/guides/database/database-linter?lint=0011_function_search_path_mutable",
"splinter/security/insecureQueueExposedInApi": "https://supabase.com/docs/guides/database/database-linter?lint=0019_insecure_queue_exposed_in_api",
"splinter/security/materializedViewInApi": "https://supabase.com/docs/guides/database/database-linter?lint=0016_materialized_view_in_api",
"splinter/security/policyExistsRlsDisabled": "https://supabase.com/docs/guides/database/database-linter?lint=0007_policy_exists_rls_disabled",
"splinter/security/rlsDisabledInPublic": "https://supabase.com/docs/guides/database/database-linter?lint=0013_rls_disabled_in_public",
"splinter/security/rlsEnabledNoPolicy": "https://supabase.com/docs/guides/database/database-linter?lint=0008_rls_enabled_no_policy",
"splinter/security/rlsReferencesUserMetadata": "https://supabase.com/docs/guides/database/database-linter?lint=0015_rls_references_user_metadata",
"splinter/security/securityDefinerView": "https://supabase.com/docs/guides/database/database-linter?lint=0010_security_definer_view",
"splinter/security/unsupportedRegTypes": "https://supabase.com/docs/guides/database/database-linter?lint=unsupported_reg_types",
"splinter/unknown/unknown": "https://pg-language-server.com/latest",
// splinter rules end
;
// General categories
"stdin",
Expand All @@ -69,4 +93,11 @@ define_categories! {
"lint/performance",
"lint/safety",
// Lint groups end

// Splinter groups start
"splinter",
"splinter/performance",
"splinter/security",
"splinter/unknown",
// Splinter groups end
}
28 changes: 28 additions & 0 deletions crates/pgls_splinter/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[package]
authors.workspace = true
categories.workspace = true
description = "<DESCRIPTION>"
edition.workspace = true
homepage.workspace = true
keywords.workspace = true
license.workspace = true
name = "pgls_splinter"
repository.workspace = true
version = "0.0.0"

[dependencies]
pgls_diagnostics.workspace = true
serde.workspace = true
serde_json.workspace = true
sqlx.workspace = true

[build-dependencies]
ureq = "2.10"

[dev-dependencies]
insta.workspace = true
pgls_console.workspace = true
pgls_test_utils.workspace = true

[lib]
doctest = false
Loading