Skip to content

Commit

Permalink
eng(supabase): update supabase analysis options (#502)
Browse files Browse the repository at this point in the history
  • Loading branch information
tshedor authored Dec 16, 2024
1 parent 785ce0f commit 1feb239
Show file tree
Hide file tree
Showing 17 changed files with 723 additions and 230 deletions.
9 changes: 0 additions & 9 deletions docs/supabase/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ Forwards to Supabase's `limit` [param](https://supabase.com/docs/reference/dart/

Start from a specific offset, inclusive.

## `providerArgs:`

| Name | Type | Description |
| -------------------------- | --------- | --------------------------------------------------------------------------------------------------- | --- |
| `'limitByReferencedTable'` | `String?` | Forwards to Supabase's `referencedTable` [property](https://supabase.com/docs/reference/dart/limit) | |
| `'orderByReferencedTable'` | `String?` | Forwards to Supabase's `referencedTable` [property](https://supabase.com/docs/reference/dart/order) |

?> The `ReferencedTable` naming convention is awkward but necessary to not collide with other providers (like `SqliteProvider`) that also use `orderBy` and `limit`. While a `foreign_table.foreign_column` syntax is more Supabase-like, it is not supported in `orderBy` and `limit`.

## `where:`

Brick currently does not support all of Supabase's filtering methods. Consider the associated `Compare` enum value to Supabase's method when building a Brick query:
Expand Down
9 changes: 0 additions & 9 deletions packages/brick_supabase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@ Connecting [Brick](https://github.com/GetDutchie/brick) with Supabase.

## Supported `Query` Configuration

### `providerArgs:`

| Name | Type | Description |
| -------------------------- | --------- | --------------------------------------------------------------------------------------------------- |
| `'limitByReferencedTable'` | `String?` | Forwards to Supabase's `referencedTable` [property](https://supabase.com/docs/reference/dart/limit) |
| `'orderByReferencedTable'` | `String?` | Forwards to Supabase's `referencedTable` [property](https://supabase.com/docs/reference/dart/order) |

:bulb: The `ReferencedTable` naming convention is awkward but necessary to not collide with other providers (like `SqliteProvider`) that also use `orderBy` and `limit`. While a `foreign_table.foreign_column` syntax is more Supabase-like, it is not supported in `orderBy` and `limit`.

### `where:`

Brick currently does not support all of Supabase's filtering methods. Consider the associated `Compare` enum value to Supabase's method when building a Brick query:
Expand Down
325 changes: 325 additions & 0 deletions packages/brick_supabase/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,326 @@
include: ../../analysis_options.yaml

linter:
rules:
# This list is derived from the list of all available lints located at
# https://github.com/dart-lang/linter/blob/master/example/all.yaml
- always_declare_return_types
# - always_put_control_body_on_new_line
# - always_put_required_named_parameters_first
# - always_specify_types
- always_use_package_imports
- annotate_overrides
# - avoid_annotating_with_dynamic
- avoid_bool_literals_in_conditional_expressions
# - avoid_catches_without_on_clauses
# - avoid_catching_errors
- avoid_classes_with_only_static_members
- avoid_double_and_int_checks
# - avoid_dynamic_calls
- avoid_empty_else
# - avoid_equals_and_hash_code_on_mutable_classes
- avoid_escaping_inner_quotes
- avoid_field_initializers_in_const_classes
# - avoid_final_parameters
- avoid_function_literals_in_foreach_calls
- avoid_implementing_value_types
- avoid_init_to_null
- avoid_js_rounded_ints
- avoid_multiple_declarations_per_line
- avoid_null_checks_in_equality_operators
# - avoid_positional_boolean_parameters
- avoid_print
- avoid_private_typedef_functions
- avoid_redundant_argument_values
- avoid_relative_lib_imports
- avoid_renaming_method_parameters
- avoid_return_types_on_setters
- avoid_returning_null_for_void
- avoid_returning_this
- avoid_setters_without_getters
- avoid_shadowing_type_parameters
- avoid_single_cascade_in_expression_statements
- avoid_slow_async_io
- avoid_type_to_string
- avoid_types_as_parameter_names
# - avoid_types_on_closure_parameters
- avoid_unnecessary_containers
- avoid_unused_constructor_parameters
- avoid_void_async
- avoid_web_libraries_in_flutter
- await_only_futures
- camel_case_extensions
- camel_case_types
- cancel_subscriptions
- cascade_invocations
- cast_nullable_to_non_nullable
# - close_sinks
- collection_methods_unrelated_type
- combinators_ordering
- comment_references
- conditional_uri_does_not_exist
- constant_identifier_names
- control_flow_in_finally
- curly_braces_in_flow_control_structures
- dangling_library_doc_comments
- depend_on_referenced_packages
- deprecated_consistency
- deprecated_member_use_from_same_package
# - diagnostic_describe_all_properties
- directives_ordering
- discarded_futures
- do_not_use_environment
- empty_catches
- empty_constructor_bodies
- empty_statements
- eol_at_end_of_file
- exhaustive_cases
- file_names
- flutter_style_todos
- hash_and_equals
- implementation_imports
- implicit_call_tearoffs
- implicit_reopen
- invalid_case_patterns
- join_return_with_assignment
# - leading_newlines_in_multiline_strings
- library_annotations
- library_names
- library_prefixes
- library_private_types_in_public_api
# - lines_longer_than_80_chars
- literal_only_boolean_expressions
- matching_super_parameters
- missing_whitespace_between_adjacent_strings
- no_adjacent_strings_in_list
- no_default_cases
- no_duplicate_case_values
- no_leading_underscores_for_library_prefixes
- no_leading_underscores_for_local_identifiers
- no_literal_bool_comparisons
- no_logic_in_create_state
- no_runtimeType_toString
- no_self_assignments
- no_wildcard_variable_uses
- non_constant_identifier_names
- noop_primitive_operations
- null_check_on_nullable_type_parameter
- null_closures
- omit_local_variable_types
- one_member_abstracts
- only_throw_errors
- overridden_fields
- package_api_docs
- package_names
- package_prefixed_library_names
- parameter_assignments
- prefer_adjacent_string_concatenation
- prefer_asserts_in_initializer_lists
- prefer_asserts_with_message
- prefer_collection_literals
- prefer_conditional_assignment
- prefer_const_constructors
- prefer_const_constructors_in_immutables
- prefer_const_declarations
- prefer_const_literals_to_create_immutables
- prefer_constructors_over_static_methods
- prefer_contains
# - prefer_double_quotes
- prefer_expression_function_bodies
- prefer_final_fields
- prefer_final_in_for_each
- prefer_final_locals
# - prefer_final_parameters
- prefer_for_elements_to_map_fromIterable
- prefer_foreach
- prefer_function_declarations_over_variables
- prefer_generic_function_type_aliases
- prefer_if_elements_to_conditional_expressions
- prefer_if_null_operators
- prefer_initializing_formals
- prefer_inlined_adds
- prefer_int_literals
- prefer_interpolation_to_compose_strings
- prefer_is_empty
- prefer_is_not_empty
- prefer_is_not_operator
- prefer_iterable_whereType
- prefer_mixin
- prefer_null_aware_method_calls
- prefer_null_aware_operators
# - prefer_relative_imports
- prefer_single_quotes
- prefer_spread_collections
- prefer_typing_uninitialized_variables
- prefer_void_to_null
- provide_deprecation_message
- public_member_api_docs
- recursive_getters
- require_trailing_commas
- secure_pubspec_urls
- sized_box_for_whitespace
- sized_box_shrink_expand
- slash_for_doc_comments
- sort_child_properties_last
# - sort_constructors_first
- sort_pub_dependencies
- sort_unnamed_constructors_first
- test_types_in_equals
- throw_in_finally
- tighten_type_of_initializing_formals
- type_annotate_public_apis
- type_init_formals
- type_literal_in_constant_pattern
- unawaited_futures
# - unnecessary_await_in_return
- unnecessary_brace_in_string_interps
- unnecessary_breaks
- unnecessary_const
- unnecessary_constructor_name
# - unnecessary_final
- unnecessary_getters_setters
- unnecessary_lambdas
- unnecessary_late
- unnecessary_library_directive
- unnecessary_new
- unnecessary_null_aware_assignments
- unnecessary_null_aware_operator_on_extension_on_nullable
- unnecessary_null_checks
- unnecessary_null_in_if_null_operators
- unnecessary_nullable_for_final_variable_declarations
- unnecessary_overrides
- unnecessary_parenthesis
- unnecessary_raw_strings
- unnecessary_statements
- unnecessary_string_escapes
- unnecessary_string_interpolations
- unnecessary_this
- unnecessary_to_list_in_spreads
# - unreachable_from_main
- unrelated_type_equality_checks
- unsafe_html
- use_build_context_synchronously
- use_colored_box
- use_decorated_box
- use_enums
- use_full_hex_values_for_flutter_colors
- use_function_type_syntax_for_parameters
- use_if_null_to_convert_nulls_to_bools
- use_is_even_rather_than_modulo
- use_key_in_widget_constructors
- use_late_for_private_fields_and_variables
- use_named_constants
- use_raw_strings
- use_rethrow_when_possible
- use_setters_to_change_properties
- use_string_buffers
- use_string_in_part_of_directives
- use_super_parameters
- use_test_throws_matchers
- use_to_and_as_if_applicable
- valid_regexps
- void_checks

analyzer:
exclude:
- example/
- "**/example/"
- example_rest
- example_graphql
- "**/*.g.dart"

errors:
# override custom
always_use_package_imports: error
camel_case_extensions: error
camel_case_types: error
curly_braces_in_flow_control_structures: error
directives_ordering: error
file_names: error
prefer_single_quotes: error
prefer_is_empty: error
prefer_is_not_empty: error
require_trailing_commas: error
sort_pub_dependencies: error
unnecessary_statements: error

# override flutter_lints
avoid_print: error
avoid_unnecessary_containers: error
avoid_web_libraries_in_flutter: error
no_logic_in_create_state: error
prefer_const_constructors: error
prefer_const_constructors_in_immutables: error
prefer_const_declarations: error
prefer_const_literals_to_create_immutables: error
sized_box_for_whitespace: error
sort_child_properties_last: error
use_build_context_synchronously: error
use_full_hex_values_for_flutter_colors: error
use_key_in_widget_constructors: error

# override recommended lints
always_require_non_null_named_parameters: error
annotate_overrides: error
avoid_function_literals_in_foreach_calls: error
avoid_init_to_null: error
avoid_null_checks_in_equality_operators: error
avoid_renaming_method_parameters: error
avoid_return_types_on_setters: error
avoid_returning_null_for_void: error
avoid_single_cascade_in_expression_statements: error
await_only_futures: error
constant_identifier_names: error
control_flow_in_finally: error
depend_on_referenced_packages: ignore
empty_constructor_bodies: error
empty_statements: error
exhaustive_cases: error
implementation_imports: ignore
invalid_case_patterns: error
library_names: error
library_prefixes: error
library_private_types_in_public_api: error
matching_super_parameters: error
no_leading_underscores_for_library_prefixes: error
no_leading_underscores_for_local_identifiers: error
no_literal_bool_comparisons: error
null_check_on_nullable_type_parameter: error
null_closures: error
overridden_fields: error
package_names: error
prefer_adjacent_string_concatenation: error
prefer_collection_literals: error
prefer_conditional_assignment: error
prefer_contains: error
prefer_equal_for_default_values: error
prefer_final_fields: error
prefer_for_elements_to_map_fromIterable: error
prefer_function_declarations_over_variables: error
prefer_if_null_operators: error
prefer_initializing_formals: error
prefer_inlined_adds: error
prefer_interpolation_to_compose_strings: error
prefer_is_not_operator: error
prefer_null_aware_operators: error
prefer_spread_collections: error
prefer_void_to_null: error
recursive_getters: error
slash_for_doc_comments: error
type_init_formals: error
type_literal_in_constant_pattern: error
unnecessary_brace_in_string_interps: error
unnecessary_breaks: error
unnecessary_const: error
unnecessary_constructor_name: error
unnecessary_getters_setters: error
unnecessary_late: error
unnecessary_new: error
unnecessary_null_aware_assignments: error
unnecessary_null_in_if_null_operators: error
unnecessary_nullable_for_final_variable_declarations: error
unnecessary_string_escapes: error
unnecessary_string_interpolations: error
unnecessary_this: error
use_function_type_syntax_for_parameters: error
use_rethrow_when_possible: error
1 change: 1 addition & 0 deletions packages/brick_supabase/lib/src/annotations/supabase.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import 'package:brick_core/field_serializable.dart';
import 'package:brick_supabase/src/supabase_adapter.dart';

/// An annotation used to specify how a field is serialized for a [SupabaseAdapter].
///
Expand Down
Loading

0 comments on commit 1feb239

Please sign in to comment.