supabase / supabase-flutter / 36864123641

92%

push

github

feat(supabase_typegen): default the generated import to the Supabase package the project depends on (#1904)

## Summary

The generated file imported `package:postgrest/postgrest.dart` by
default. A supabase_flutter app depends on `supabase_flutter`, not on
`postgrest`, so the analyzer reported `depend_on_referenced_packages` on
the generated file.

Without `--import`, the tool now reads the `dependencies` of the
`pubspec.yaml` nearest to the output, the same one the language version
is read from. It imports the library of the first of these that is a
direct dependency:

1. `package:supabase_flutter/supabase_flutter.dart`
2. `package:supabase/supabase.dart`
3. `package:postgrest/postgrest.dart`

When the pubspec lists none of them, or there is no pubspec, the import
stays `package:postgrest/postgrest.dart`. `dev_dependencies` are
ignored. A pubspec that is not valid YAML gets the same error and exit
code as the language version lookup. An explicit `--import` always wins.

## Changes

* `packageImportUri` sits next to `packageLanguageVersion` and shares
its pubspec lookup and YAML loading.
* The `--import` option no longer has a static default, and its help
text explains the detection.
* The README describes the default.
* Unit tests cover each package, the precedence between them, no
matching dependency, a `dev_dependencies`-only match, ancestor lookup, a
missing pubspec and invalid YAML.

The list of required symbols in the `generateDartCode` dartdoc still
matches what the generator emits.

Closes SDK-1979

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

* **New Features**
* Generated Dart files now select imports for `PostgrestTable` and
`PostgrestColumn` based on the output project’s nearest `pubspec.yaml`,
preferring `supabase_flutter`, then `supabase`, then `postgrest`. If
none is listed, generation uses `package:postgrest`.
* The `--import` option overrides the automatically selected import wit... (continued)

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

9014 of 9863 relevant lines covered (91.39%)

4.97 hits per line