diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml new file mode 100644 index 0000000..d7a4ac7 --- /dev/null +++ b/.github/workflows/main.yaml @@ -0,0 +1,26 @@ +name: Wampproto Dart CI + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Dart + uses: dart-lang/setup-dart@v1 + with: + sdk: 3.3.0 + + - name: Install dependencies + run: make install + + - name: Verify formatting + run: make format + + - name: Check lint + run: make lint + + - name: Run tests + run: make test diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..86d61a7 --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +install: + dart pub get + +lint: + dart analyze + +lint-fix: + dart fix --apply + +format: + dart format --output=none --set-exit-if-changed . + +test: + dart test diff --git a/analysis_options.yaml b/analysis_options.yaml index 0dfc398..14c4740 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -17,7 +17,211 @@ include: package:lints/recommended.yaml linter: rules: + - always_declare_return_types + - always_put_control_body_on_new_line + - always_put_required_named_parameters_first + - always_use_package_imports + - annotate_overrides + - annotate_redeclares + - 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_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_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_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 + - 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 + - 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_contains + - prefer_double_quotes + - 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_spread_collections + - prefer_typing_uninitialized_variables + - prefer_void_to_null + - provide_deprecation_message + - 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_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: diff --git a/lib/messages.dart b/lib/messages.dart index 31eadad..7317e3d 100644 --- a/lib/messages.dart +++ b/lib/messages.dart @@ -1 +1 @@ -export 'src/messages/hello.dart' show Hello; +export "src/messages/hello.dart" show Hello; diff --git a/lib/serializers.dart b/lib/serializers.dart index 2c1b8bc..517b850 100644 --- a/lib/serializers.dart +++ b/lib/serializers.dart @@ -1 +1 @@ -export 'src/serializers/json.dart' show JsonSerializer; +export "src/serializers/json.dart" show JsonSerializer; diff --git a/lib/src/messages/hello.dart b/lib/src/messages/hello.dart index 60cad0b..6941a6c 100644 --- a/lib/src/messages/hello.dart +++ b/lib/src/messages/hello.dart @@ -1,6 +1,7 @@ -import 'message.dart'; +import "package:wampproto/src/messages/message.dart"; class Hello implements Message { + Hello(this.realm, this.roles, this.authID, this.authMethods); static const int id = 1; final String realm; @@ -8,9 +9,7 @@ class Hello implements Message { final String authID; final List authMethods; - Hello(this.realm, this.roles, this.authID, this.authMethods); - - static Hello parse(List message) { + static Hello parse(final List message) { if (message.length < 2) { throw ArgumentError("invalid hello message"); } @@ -22,7 +21,8 @@ class Hello implements Message { if (type != Hello.id) { throw ArgumentError( - "invalid message type: must be ${Hello.id}, was $type"); + "invalid message type: must be ${Hello.id}, was $type", + ); } final realm = message[1]; @@ -44,7 +44,5 @@ class Hello implements Message { } @override - int messageType() { - return id; - } + int messageType() => id; } diff --git a/lib/src/serializers/json.dart b/lib/src/serializers/json.dart index b7acb31..68f16d9 100644 --- a/lib/src/serializers/json.dart +++ b/lib/src/serializers/json.dart @@ -1,21 +1,21 @@ -import 'dart:convert'; -import 'dart:typed_data'; +import "dart:convert"; +import "dart:typed_data"; -import 'package:wampproto/src/messages/message.dart'; -import 'package:wampproto/src/serializers/serializer.dart'; +import "package:wampproto/src/messages/message.dart"; +import "package:wampproto/src/serializers/serializer.dart"; class JsonSerializer implements Serializer { @override - Uint8List serialize(Message message) { + Uint8List serialize(final Message message) { var jsonString = jsonEncode(message.marshal()); return Uint8List.fromList(jsonString.codeUnits); } @override - Message deserialize(Uint8List message) { - String s = String.fromCharCodes(message); + Message deserialize(final Uint8List message) { + final String s = String.fromCharCodes(message); - List wampMessage = jsonDecode(s); + final List wampMessage = jsonDecode(s); return toMessage(wampMessage); } } diff --git a/lib/src/serializers/serializer.dart b/lib/src/serializers/serializer.dart index b04f396..c61cca2 100644 --- a/lib/src/serializers/serializer.dart +++ b/lib/src/serializers/serializer.dart @@ -1,8 +1,8 @@ -import 'dart:typed_data'; +import "dart:typed_data"; -import 'package:wampproto/messages.dart'; +import "package:wampproto/messages.dart"; -import '../messages/message.dart'; +import "package:wampproto/src/messages/message.dart"; Message toMessage(List message) { var messageType = message[0]; @@ -12,7 +12,9 @@ Message toMessage(List message) { switch (messageType) { case Hello.id: - {return Hello.parse(message);} + { + return Hello.parse(message); + } default: { throw "unknown message type"; @@ -21,6 +23,6 @@ Message toMessage(List message) { } abstract class Serializer { - Message deserialize(Uint8List message); - Uint8List serialize(Message message); + Message deserialize(final Uint8List message); + Uint8List serialize(final Message message); } diff --git a/test/messages/hello_test.dart b/test/messages/hello_test.dart index 1aeff59..c6b0e09 100644 --- a/test/messages/hello_test.dart +++ b/test/messages/hello_test.dart @@ -1,5 +1,5 @@ -import 'package:wampproto/messages.dart'; -import 'package:test/test.dart'; +import "package:test/test.dart"; +import "package:wampproto/messages.dart"; void main() { test("test parse", testParse); diff --git a/test/serializers/json_test.dart b/test/serializers/json_test.dart index d761f93..3a86128 100644 --- a/test/serializers/json_test.dart +++ b/test/serializers/json_test.dart @@ -1,6 +1,6 @@ -import 'package:wampproto/messages.dart'; -import 'package:wampproto/serializers.dart'; -import 'package:test/test.dart'; +import "package:test/test.dart"; +import "package:wampproto/messages.dart"; +import "package:wampproto/serializers.dart"; void main() { test("test serialize and deserialize", testJson);