Repository navigation
docs: add a recipe for formatting declarative schemas - #883
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a guide on running the formatter on SQL that tools generate, starting with Supabase declarative schemas and pg-delta. pg-delta only formats its output enough to be readable and doesn't plan to grow into a formatter, so the language server formatter is the one to run after each generation. Only docs and
mkdocs.ymlchange.guides/formatting_declarative_schemas.md: runformat --writeonsupabase/schemasandsupabase/migrationsaftersupabase db schema declarative sync,generateordb pull --declarative, and check formatting in CI.language sqlbody written as a string: Postgres stores it as written and the formatter reformats it by default, so the guide recommendsskipFnBodies: trueto keep a formatted schema syncing with zero diff.begin atomicbodies are stored parsed and aren't affected.--changed, because it compares<base>...HEADand misses files that were just generated and aren't committed yet.features/formatting.mdlinks to the guide and listsskipFnBodiesin the options table, where it was missing.🤖 Generated with Claude Code