add `supabase_only` flag to each rule

Open
#135 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
postgres, sql, supabase
Domain
databases, tooling

Research direction

Start by reviewing how splinter defines its rules and formats query results, then identify where each rule's metadata is assembled. Add the proposed Supabase-only classification to every rule result and verify that consumers can select the subset; the issue names no specific files or tests to run.

Written by the indexing model from the issue text.

Description

I am in the process of adding splinter to the postgres-language-server as part of a dblint command. it will run alongside tools such as pglinter within CI to detect issues with the schema before they are deployed.

The simplicity of splinter is really attractive, and lots of the rules are valuable not only for Supabase users. It would be awesome to add a simple flag to the query results to classify it as "Supabase only". This way, we could run a subset of the rules even if we do not target a Supabase database.

Happy to do this myself if the team agrees this makes sense! We could fork or just copy the file, but I would rather make this more accessible for everyone.

Dominant language
PLpgSQL
Stars
275
Forks
102
Avg merge
2d 8h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from supabase/splinter

All issues in supabase/splinter

Similar issues

More Databases issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.