Skip to content

Commit

Permalink
refactor: update analysis_options.yaml (#169)
Browse files Browse the repository at this point in the history
  • Loading branch information
felangel committed Oct 14, 2023
1 parent 6de8b97 commit ad6e389
Show file tree
Hide file tree
Showing 10 changed files with 426 additions and 261 deletions.
138 changes: 129 additions & 9 deletions analysis_options.yaml
@@ -1,81 +1,201 @@
analyzer:
strong-mode:
implicit-casts: false
implicit-dynamic: false
language:
strict-casts: true
strict-inference: true
strict-raw-types: true

errors:
close_sinks: ignore
missing_required_param: error
missing_return: error
record_literal_one_positional_no_trailing_comma: error

linter:
rules:
- public_member_api_docs
- always_declare_return_types
- always_put_required_named_parameters_first
- always_use_package_imports
- annotate_overrides
- avoid_bool_literals_in_conditional_expressions
- avoid_catching_errors
- 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_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
- 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_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
- 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
- directives_ordering
- empty_catches
- empty_constructor_bodies
- empty_statements
- eol_at_end_of_file
- exhaustive_cases
- file_names
- flutter_style_todos
- hash_and_equals
- implementation_imports
- invariant_booleans
- iterable_contains_unrelated_type
- implicit_call_tearoffs
- implicit_reopen
- invalid_case_patterns
- join_return_with_assignment
- leading_newlines_in_multiline_strings
- library_annotations
- library_names
- library_prefixes
- list_remove_unrelated_type
- library_private_types_in_public_api
- lines_longer_than_80_chars
- literal_only_boolean_expressions
- 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_logic_in_create_state
- no_runtimeType_toString
- 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
- 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_equal_for_default_values
- prefer_final_fields
- prefer_final_in_for_each
- prefer_final_locals
- prefer_for_elements_to_map_fromIterable
- 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_null_aware_method_calls
- prefer_null_aware_operators
- 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
- unawaited_futures
- unnecessary_await_in_return
- unnecessary_brace_in_string_interps
- unnecessary_breaks
- unnecessary_const
- unnecessary_constructor_name
- unnecessary_getters_setters
- unnecessary_lambdas
- unnecessary_late
- unnecessary_library_directive
- unnecessary_new
- unnecessary_null_aware_assignments
- 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
- unrelated_type_equality_checks
- use_build_context_synchronously
- use_colored_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
6 changes: 4 additions & 2 deletions example/main.dart
@@ -1,3 +1,5 @@
// ignore_for_file: avoid_print

import 'package:equatable/equatable.dart';

class Credentials extends Equatable {
Expand Down Expand Up @@ -45,7 +47,7 @@ void main() {
print(credentialsC == credentialsC); // true
print(credentialsA == credentialsB); // false
print(credentialsB == credentialsC); // true
print(credentialsA.toString()); // Credentials
print(credentialsA); // Credentials

// Equatable Mixin
final dateTimeA = EquatableDateTime(2019);
Expand All @@ -57,5 +59,5 @@ void main() {
print(dateTimeC == dateTimeC); // true
print(dateTimeA == dateTimeB); // false
print(dateTimeB == dateTimeC); // true
print(dateTimeA.toString()); // EquatableDateTime(2019, 1, 1, 0, 0, 0, 0, 0)
print(dateTimeA); // EquatableDateTime(2019, 1, 1, 0, 0, 0, 0, 0)
}
2 changes: 1 addition & 1 deletion example/pubspec.yaml
@@ -1,7 +1,7 @@
name: example

environment:
sdk: ">=2.12.0-0 <3.0.0"
sdk: ">=2.12.0 <3.0.0"

dependencies:
equatable:
Expand Down
16 changes: 8 additions & 8 deletions lib/src/equatable.dart
@@ -1,8 +1,7 @@
import 'package:equatable/src/equatable_config.dart';
import 'package:equatable/src/equatable_utils.dart';
import 'package:meta/meta.dart';

import './equatable_config.dart';
import './equatable_utils.dart';

/// {@template equatable}
/// A base class to facilitate [operator ==] and [hashCode] overrides.
///
Expand Down Expand Up @@ -43,11 +42,12 @@ abstract class Equatable {
bool? get stringify => null;

@override
bool operator ==(Object other) =>
identical(this, other) ||
other is Equatable &&
runtimeType == other.runtimeType &&
equals(props, other.props);
bool operator ==(Object other) {
return identical(this, other) ||
other is Equatable &&
runtimeType == other.runtimeType &&
equals(props, other.props);
}

@override
int get hashCode => runtimeType.hashCode ^ mapPropsToHashCode(props);
Expand Down
3 changes: 2 additions & 1 deletion lib/src/equatable_config.dart
@@ -1,5 +1,5 @@
// ignore_for_file: avoid_classes_with_only_static_members
import 'equatable.dart';
import 'package:equatable/src/equatable.dart';

/// The default configurion for all [Equatable] instances.
///
Expand All @@ -20,6 +20,7 @@ class EquatableConfig {
/// {@endtemplate}
static bool get stringify {
if (_stringify == null) {
// ignore: prefer_asserts_with_message
assert(() {
_stringify = true;
return true;
Expand Down
7 changes: 3 additions & 4 deletions lib/src/equatable_mixin.dart
@@ -1,9 +1,8 @@
import 'package:equatable/src/equatable.dart';
import 'package:equatable/src/equatable_config.dart';
import 'package:equatable/src/equatable_utils.dart';
import 'package:meta/meta.dart';

import 'equatable.dart';
import 'equatable_config.dart';
import 'equatable_utils.dart';

/// A mixin that helps implement equality
/// without needing to explicitly override [operator ==] and [hashCode].
///
Expand Down
28 changes: 15 additions & 13 deletions lib/src/equatable_utils.dart
Expand Up @@ -2,21 +2,22 @@ import 'package:collection/collection.dart';
import 'package:equatable/equatable.dart';

/// Returns a `hashCode` for [props].
int mapPropsToHashCode(Iterable? props) =>
_finish(props == null ? 0 : props.fold(0, _combine));
int mapPropsToHashCode(Iterable<Object?>? props) {
return _finish(props == null ? 0 : props.fold(0, _combine));
}

const DeepCollectionEquality _equality = DeepCollectionEquality();

/// Determines whether [list1] and [list2] are equal.
bool equals(List? list1, List? list2) {
bool equals(List<Object?>? list1, List<Object?>? list2) {
if (identical(list1, list2)) return true;
if (list1 == null || list2 == null) return false;
final length = list1.length;
if (length != list2.length) return false;

for (var i = 0; i < length; i++) {
final dynamic unit1 = list1[i];
final dynamic unit2 = list2[i];
final unit1 = list1[i];
final unit2 = list2[i];

if (_isEquatable(unit1) && _isEquatable(unit2)) {
if (unit1 != unit2) return false;
Expand All @@ -31,23 +32,23 @@ bool equals(List? list1, List? list2) {
return true;
}

bool _isEquatable(dynamic object) {
bool _isEquatable(Object? object) {
return object is Equatable || object is EquatableMixin;
}

/// Jenkins Hash Functions
/// https://en.wikipedia.org/wiki/Jenkins_hash_function
int _combine(int hash, dynamic object) {
int _combine(int hash, Object? object) {
if (object is Map) {
object.keys
.sorted((dynamic a, dynamic b) => a.hashCode - b.hashCode)
.forEach((dynamic key) {
hash = hash ^ _combine(hash, <dynamic>[key, object[key]]);
.sorted((Object? a, Object? b) => a.hashCode - b.hashCode)
.forEach((Object? key) {
hash = hash ^ _combine(hash, [key, (object! as Map)[key]]);
});
return hash;
}
if (object is Set) {
object = object.sorted(((dynamic a, dynamic b) => a.hashCode - b.hashCode));
object = object.sorted((Object? a, Object? b) => a.hashCode - b.hashCode);
}
if (object is Iterable) {
for (final value in object) {
Expand All @@ -68,5 +69,6 @@ int _finish(int hash) {
}

/// Returns a string for [props].
String mapPropsToString(Type runtimeType, List<Object?> props) =>
'$runtimeType(${props.map((prop) => prop.toString()).join(', ')})';
String mapPropsToString(Type runtimeType, List<Object?> props) {
return '$runtimeType(${props.map((prop) => prop.toString()).join(', ')})';
}

0 comments on commit ad6e389

Please sign in to comment.