- BREAKING CHANGE: all Error methods and functions renamed to Exceptions.

- BREAKING CHANGE: Dart API >= 2.13.0
- feat: flutter_lints and analysis_options to get most better way style the code
- fix: linter errors and code style improvements
- fix: some Errors were replaced by Exceptions, some Exceptions became Errors to make more correct way of using Exceptions and Errors

Author: Arenukvern

CHANGELOG.md

@@ -1,3 +1,20 @@
+# 3.1.0
+
+- BREAKING CHANGE: all `Error` methods and functions renamed to `Exception`.
+  The reason of it is a nature between Exception and Error in dart.
+  In short:
+  `Exceptions` should be used when there is a problem that is expected.
+  A common one is any type of I/O operation (like network traffic), where the socket closes early, and trying to write data to that socket fails.
+  `Errors` occur when there is a problem that was not expected. Things like null pointers (you expected this variable to not be null), running our of memory, etc... When you try to use the API in a wrong way or stuffs like that.
+  `For the most part` you, as an app developer, will always `use exceptions`.
+  Errors tend to be reserved for unexpected and fatal problems.
+  source:
+  https://stackoverflow.com/questions/17315945/error-vs-exception-in-dart
+- BREAKING CHANGE: Dart API >= 2.13.0
+- feat: flutter_lints and analysis_options to get most better way style the code
+- fix: linter errors and code style improvements
+- fix: some Errors were replaced by Exceptions, some Exceptions became Errors to make more correct way of using Exceptions and Errors
+
 # 3.0.0
 
 - BREAKING CHANAGE: rename Uhst to UHST

README.md

@@ -60,9 +60,9 @@ host
       _hostIdController.text = hostId;
     });
   })
-  ..onError(handler: ({required dynamic error}) {
-    print('error received! $error');
-    if (error is HostIdAlreadyInUse) {
+  ..onException(handler: ({required dynamic exception}) {
+    print('exception received! $exception');
+    if (exception is HostIdAlreadyInUse) {
       // this is expected if you refresh the page
       // connection is still alive on the relay
       // just need to wait
@@ -72,7 +72,7 @@ host
       });
     } else {
       setState(() {
-        hostMessages.add(error.toString());
+        hostMessages.add(exception.toString());
       });
     }
   })
@@ -125,14 +125,14 @@ client
       clientMessages.add('Client received: $message');
     });
   })
-  ..onError(handler: ({required dynamic error}) {
-    if (error is InvalidHostId || error is InvalidClientOrHostId) {
+  ..onException(handler: ({required dynamic exception}) {
+    if (exception is InvalidHostId || exception is InvalidClientOrHostId) {
       setState(() {
         clientMessages.add('Invalid hostId!');
       });
     } else {
       setState(() {
-        clientMessages.add(error.toString());
+        clientMessages.add(exception.toString());
       });
     }
   })

analysis_options.yaml

@@ -0,0 +1,123 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+analyzer:
+  exclude:
+    - example/
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at
+  # https://dart-lang.github.io/linter/lints/index.html.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # Errors
+    use_build_context_synchronously: true
+    unnecessary_statements: true
+    throw_in_finally: true
+    test_types_in_equals: true
+    no_adjacent_strings_in_list: true
+    literal_only_boolean_expressions: true
+    invariant_booleans: true
+    diagnostic_describe_all_properties: true
+    comment_references: false
+    close_sinks: true
+    cancel_subscriptions: true
+    avoid_type_to_string: true
+    avoid_slow_async_io: true
+    avoid_returning_null_for_future: true
+    avoid_dynamic_calls: true
+    prefer_relative_imports: true
+    # Style
+    avoid_void_async: true
+    avoid_setters_without_getters: true
+    avoid_returning_this: true
+    avoid_returning_null: true
+    avoid_redundant_argument_values: true
+    avoid_private_typedef_functions: true
+    avoid_positional_boolean_parameters: true
+    avoid_multiple_declarations_per_line: true
+    avoid_js_rounded_ints: true
+    avoid_implementing_value_types: true
+    avoid_field_initializers_in_const_classes: true
+    avoid_escaping_inner_quotes: true
+    avoid_equals_and_hash_code_on_mutable_classes: true
+    avoid_double_and_int_checks: true
+    avoid_classes_with_only_static_members: true
+    avoid_catching_errors: true
+    avoid_catches_without_on_clauses: true
+    avoid_bool_literals_in_conditional_expressions: true
+    always_put_required_named_parameters_first: true
+    always_declare_return_types: true
+    avoid_unused_constructor_parameters: true
+    avoid_types_on_closure_parameters: true
+    cast_nullable_to_non_nullable: true
+    cascade_invocations: true
+    deprecated_consistency: true
+    directives_ordering: true
+    flutter_style_todos: true
+    join_return_with_assignment: true
+    leading_newlines_in_multiline_strings: true
+    library_private_types_in_public_api: true
+    lines_longer_than_80_chars: true
+    missing_whitespace_between_adjacent_strings: true
+    no_runtimeType_toString: true
+    noop_primitive_operations: true
+    null_check_on_nullable_type_parameter: true
+    one_member_abstracts: true
+    package_api_docs: true
+    only_throw_errors: true
+    parameter_assignments: true
+    prefer_asserts_in_initializer_lists: true
+    prefer_asserts_with_message: true
+    prefer_constructors_over_static_methods: true
+    prefer_single_quotes: true
+    prefer_expression_function_bodies: true
+    prefer_final_in_for_each: true
+    prefer_final_locals: true
+    prefer_final_parameters: true
+    prefer_if_elements_to_conditional_expressions: true
+    prefer_interpolation_to_compose_strings: true
+    prefer_mixin: true
+    prefer_null_aware_method_calls: true
+    public_member_api_docs: true
+    require_trailing_commas: true
+    sort_child_properties_last: true
+    sort_constructors_first: true
+    sort_unnamed_constructors_first: true
+    tighten_type_of_initializing_formals: true
+    type_annotate_public_apis: true
+    unawaited_futures: true
+    unnecessary_await_in_return: true
+    unnecessary_lambdas: true
+    unnecessary_null_aware_assignments: true
+    unnecessary_null_checks: true
+    unnecessary_nullable_for_final_variable_declarations: true
+    unnecessary_parenthesis: true
+    unnecessary_raw_strings: true
+    use_is_even_rather_than_modulo: true
+    use_named_constants: true
+    use_raw_strings: true
+    use_setters_to_change_properties: true
+    use_string_buffers: true
+    use_test_throws_matchers: true
+    use_to_and_as_if_applicable: true
+    depend_on_referenced_packages: true
+    # avoid_classes_with_only_static_members: false
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options