supabase / supabase-flutter / 32953813119
89%

DEFAULT BRANCH: main
Ran
Jobs 10
Files 120
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 88.552%. Remained the same
32953813119

push

github

web-flow 
docs(supabase): enable public_member_api_docs (#1773)

## Summary
- Enables `public_member_api_docs` for `supabase`.
- Documents the `*ClientOptions` classes (`PostgrestClientOptions`,
`AuthClientOptions`, `StorageClientOptions`, `FunctionsClientOptions`),
`SupabaseClient`'s remaining undocumented members,
`SupabaseQueryBuilder`, `SupabaseQuerySchema`,
`SupabaseStreamBuilder`/`SupabaseStreamFilterBuilder`,
`RealtimeSubscribeException`, and
`TraceContext`/`TracePropagationOptions`.

## Context
Continues the package-by-package rollout for
[SDK-1449](https://linear.app/supabase/issue/SDK-1449/enable-public-member-api-docs-and-document-the-public-api).

## Test plan
- [x] `dart analyze` reports no issues
- [x] `dart format .` produces no diff
- [x] `dart test` passes (147 tests)
- [x] Dependent package `supabase_flutter` still analyzes cleanly

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

## Summary by CodeRabbit

* **Documentation**
* Added API documentation across client configuration, authentication,
realtime streaming, schema queries, filtering, tracing, and version
information.
* Documented public properties, constructors, exceptions, and types to
improve developer guidance.
* **Chores**
  * Enabled a lint rule requiring documentation for public members.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

6049 of 6831 relevant lines covered (88.55%)

4.57 hits per line

Jobs
ID Job ID Ran Files Coverage
3 supabase - 32953813119.3 14
93.49
 GitHub Action Run
4 supabase_flutter - 32953813119.4 11
82.22
 GitHub Action Run
5 supabase_functions - 32953813119.5 4
93.81
 GitHub Action Run
6 postgrest - 32953813119.6 11
84.59
 GitHub Action Run
7 supabase_realtime - 32953813119.7 13
90.27
 GitHub Action Run
8 iceberg - 32953813119.8 6
68.52
 GitHub Action Run
9 supabase_auth - 32953813119.9 30
90.57
 GitHub Action Run
10 supabase_storage - 32953813119.10 9
97.35
 GitHub Action Run
9 supabase_common - 32951661159.9 21
86.96
 GitHub Action Run
10 yet_another_json_isolate - 32948304016.10 1
98.44
 GitHub Action Run
Source Files on build 32953813119