From 397df65467962a5ae3eeb93446b3a1d84254f72e Mon Sep 17 00:00:00 2001 From: Greg Richardson Date: Fri, 10 Oct 2025 16:26:30 -0600 Subject: [PATCH] docs: fix formatting/typos --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 55a6625..77a77b5 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Splinter maintains a set of lints for Supabase projects. It uses SQL queries to ## Usage -If you are only interested in linting a project, a single query containing the latest version of all lints is availble in splinter.sql in the repo root. +If you are only interested in linting a project, a single query containing the latest version of all lints is available in splinter.sql in the repo root. ## Lint Interface @@ -29,13 +29,13 @@ Each lint creates a view that returns a common interface. The interface is: - name (text) not null -- Name of the lint - title (text) not null -- Human readable title of the lint - level (text) not null -- The level of issue. One of ERROR/WARN/INFO -- facing (text) not null -- Is it an internal (to supabase) or an external (user centric) lint. One of INTERNAL/EXTERNAL +- facing (text) not null -- Is it an internal (to supabase) or an external (user centric) lint. One of INTERNAL/EXTERNAL - categories (text[]) not null -- Relevant tags for the issue. Any/All of SECURITY/PERFORMANCE (list may grow) - description (text) not null -- This is a description of the lint and why its an issue - detail (text) not null -- A text description of the issue that includes references to the specific table/column/constraint/whatever that fails the lint - remediation (text) optional -- A reference to documentation to describe the issue and how to resolve it - metadata (jsonb) optional -- Lint specific information, for example referenced entities, or entity types -- cache_key (text) not null -- A short, uniquely identifiable string that users can add to an exclusion list to avoid repeatedly seeing the same lint failures. It should identify the releavnt table/column/constraint. The string should be prefixed with the lint name. For example a lint named "unindexed_foreign_key" might have a unique key "unindexed_foreign_key_public_user_created_by_id" +- cache_key (text) not null -- A short, uniquely identifiable string that users can add to an exclusion list to avoid repeatedly seeing the same lint failures. It should identify the relevant table/column/constraint. The string should be prefixed with the lint name. For example a lint named "unindexed_foreign_key" might have a unique key "unindexed_foreign_key_public_user_created_by_id" ## Deploying to supabase/supabase @@ -45,7 +45,6 @@ If the update includes a new lint, update [getHumanReadableTitle](https://github [Example PR](https://github.com/supabase/supabase/pull/22682) - ## Development Supabase PostgreSQL 15+