supabase / supabase-flutter / 38891534378

92%

push

github

feat(typegen)!: generate only from the document the Supabase CLI pipes in (#1963)

## What

`supabase_typegen` no longer connects to a database itself. Its only
input is now the `GeneratorMetadata` document that `supabase gen types
--lang dart` pipes in on stdin. Before this change it could also run on
its own, through a Dart port of the `@supabase/postgrest-typegen`
introspection. That port repeated work the CLI flow already does:
pg-meta introspects the database, sorts the document with
`sortGeneratorMetadata` and attaches `rpcFunctions`.

## Changes

- Removed the `--local`, `--linked`, `--project-ref`, `--db-url` and
`--dump-metadata` options. `--schema`, `--output` and `--import` stay.
- Deleted the `package:supabase_typegen/introspection.dart` library: the
vendored introspection SQL, the `supabase db query` runner, the
`config.toml` schema defaults, the sort pass and its ICU collation.
- Deleted the Dart port of `resolveRpcFunctions`. The parser now reads
`rpcFunctions` from the document, and a document without that collection
describes no RPC functions.
- Removed the introspection drift workflow, the parity test's Postgres
container in `test.yml`, and the now unused `toml`, `collection` and
`postgres` dependencies.
- Updated the README and `MIGRATION.md` to use `supabase gen types
--lang dart`.

The `test/fixtures/generator_metadata.json` fixture is still generated
by the upstream TypeScript introspection (`tool/regenerate_fixture.ts`),
so the generator and parser tests run against exactly the document the
CLI produces.

## Breaking

Running `dart run supabase_typegen --local` (or any other connection
option) now fails with an unknown option error. Use `supabase gen types
--lang dart --local > lib/supabase_schema.g.dart` instead.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Usage**
* Generate Dart types through the Supabase CLI for local, linked, or
project-ID databases.
* The type-g... (continued)

2 of 2 new or added lines in 1 file covered. (100.0%)

9513 of 10352 relevant lines covered (91.9%)

5.42 hits per line