diff --git a/CHANGELOG.md b/CHANGELOG.md index 32f490b..573e98d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +## 1.0.1 + +* Improve documentation +* Add build dependency + ## 1.0.0 * Initial release diff --git a/README.md b/README.md index 0ba5e46..c4db8d3 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Available under the commercial friendly ## Installation -Add this dependency your pubspec.yaml file: +Add this dependency your _pubspec.yaml_ file: ``` dependencies: @@ -48,7 +48,6 @@ Example for command line: ```dart import 'package:enough_mail_discovery/enough_mail_discovery.dart'; -// ignore: avoid_void_async void main() async { const email = 'someone@enough.de'; final config = await Discover.discover(email, isLogEnabled: false); @@ -87,7 +86,7 @@ Check out these related projects: Please file feature requests and bugs at the [issue tracker](https://github.com/Enough-Software/enough_mail_discovery/issues). -## Contribute +## Contribute / Develop Want to contribute? Please check out [contribute](https://github.com/Enough-Software/enough_mail_discovery/contribute). This is an open-source community project. Anyone, even beginners, can contribute. @@ -100,10 +99,11 @@ This is how you contribute: * Push changes to your personal repository: `git push origin` * Go to [enough_mail_discovery](https://github.com/enough-software/enough_mail_discovery/) and create a pull request. -Thank you in advance! +Thank you in advance! +After changing model classes, re-run the JSON serialization by calling `flutter pub run build_runner build --delete-conflicting-outputs`. ## License `enough_mail_discovery` is licensed under the commercial friendly [Mozilla Public License 2.0](LICENSE). \ No newline at end of file diff --git a/analysis_options.yaml b/analysis_options.yaml index a5744c1..a612a4f 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -1,4 +1,165 @@ -include: package:flutter_lints/flutter.yaml - -# Additional information about this file can be found at -# https://dart.dev/guides/language/analysis-options +# cSpell:disable +analyzer: + errors: + todo: ignore + plugins: + - dart_code_metrics # https://github.com/dart-code-checker/dart-code-metrics +linter: + rules: + - always_declare_return_types + - always_put_control_body_on_new_line + - always_put_required_named_parameters_first + - always_require_non_null_named_parameters + #- always_specify_types # This would enforce to write types literally everywhere. + - annotate_overrides + #- avoid_annotating_with_dynamic # Explicit annotation of dynamic as type is preferable. Also exclusive with type_annotate_public_apis + #- avoid_as - deprecated, breaks lint + - avoid_bool_literals_in_conditional_expressions + #- avoid_catches_without_on_clauses # Do not enable this as enough_mail needs to handle several underlying exceptions and errors + - avoid_catching_errors + #- avoid_classes_with_only_static_members # Useful for some non-global helper cases + - avoid_double_and_int_checks + - avoid_empty_else + - 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_null_checks_in_equality_operators + - avoid_positional_boolean_parameters + - avoid_private_typedef_functions + - avoid_renaming_method_parameters + - avoid_relative_lib_imports + - avoid_return_types_on_setters + - avoid_returning_null + - avoid_returning_null_for_future + - 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_types_as_parameter_names + - avoid_types_on_closure_parameters + - avoid_unused_constructor_parameters + - avoid_void_async + - avoid_web_libraries_in_flutter + - await_only_futures + - camel_case_types + - cancel_subscriptions + - cascade_invocations + - cast_nullable_to_non_nullable + - close_sinks + - comment_references + - constant_identifier_names + - control_flow_in_finally + - curly_braces_in_flow_control_structures + #- diagnostic_describe_all_properties # We do not use diagnostics atm + - directives_ordering + - empty_constructor_bodies + - empty_statements + - empty_catches + - file_names + #- flutter_style_todos # Flutter todos are to verbose for our requirements. + - hash_and_equals + - implementation_imports + - invariant_booleans + - iterable_contains_unrelated_type + # - join_return_with_assignment # leads to less readable code IMHO + - library_names + - library_prefixes + - lines_longer_than_80_chars + - list_remove_unrelated_type + - literal_only_boolean_expressions + - no_adjacent_strings_in_list + - no_duplicate_case_values + - non_constant_identifier_names + - 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_equal_for_default_values + - prefer_expression_function_bodies + - prefer_final_fields + - prefer_final_in_for_each + - prefer_final_locals + - 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_initializing_formals + - prefer_inlined_adds + - prefer_int_literals + - prefer_interpolation_to_compose_strings + - prefer_is_empty + - prefer_is_not_empty + - prefer_iterable_whereType + - prefer_mixin + - 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 + - slash_for_doc_comments + - sort_constructors_first + - sort_pub_dependencies + - sort_unnamed_constructors_first + - test_types_in_equals + - throw_in_finally + - type_annotate_public_apis + - type_init_formals + - unawaited_futures + - unnecessary_await_in_return + - unnecessary_brace_in_string_interps + - unnecessary_const + - unnecessary_getters_setters + - unnecessary_lambdas + - unnecessary_new + - unnecessary_null_aware_assignments + - unnecessary_null_in_if_null_operators + - unnecessary_overrides + - unnecessary_parenthesis + - unnecessary_statements + - unnecessary_this + - unrelated_type_equality_checks + - use_full_hex_values_for_flutter_colors + - use_function_type_syntax_for_parameters + - use_rethrow_when_possible + - use_setters_to_change_properties + - use_string_buffers + - use_to_and_as_if_applicable + - valid_regexps + - void_checks +dart_code_metrics: + metrics: + # disable metrics + cyclomatic-complexity: 50 + maximum-nesting-level: 50 + number-of-parameters: 50 + source-lines-of-code: 500 + number-of-methods: 100 + metrics-exclude: + - test/** + rules: + - avoid-non-null-assertion # comply to engineering standards and avoid ! diff --git a/example/enough_mail_discovery_example.dart b/example/enough_mail_discovery_example.dart index 7d8a356..ca13f55 100644 --- a/example/enough_mail_discovery_example.dart +++ b/example/enough_mail_discovery_example.dart @@ -3,7 +3,12 @@ import 'package:enough_mail_discovery/enough_mail_discovery.dart'; // ignore: avoid_void_async void main() async { const email = 'someone@enough.de'; - final config = await Discover.discover(email, isLogEnabled: false); + final config = await Discover.discover( + email, + isLogEnabled: false, + forceSslConnection: false, + isWeb: false, + ); if (config == null) { print('Unable to discover settings for $email'); } else { diff --git a/pubspec.yaml b/pubspec.yaml index 59d3c83..eed9031 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: enough_mail_discovery -description: Discovery email server and their settings -version: 1.0.0 +description: Discover email server and their settings based on an email. Discover IMAP, POP, SMTP and related settings. +version: 1.0.1 homepage: https://github.com/Enough-Software/enough_mail_discovery environment: @@ -10,14 +10,13 @@ environment: dependencies: basic_utils: ^5.1.2 collection: ^1.16.0 - flutter: - sdk: flutter http: ^0.13.5 json_annotation: ^4.6.0 universal_io: ^2.0.4 xml: ^6.1.0 dev_dependencies: + build_runner: ^2.2.0 flutter_lints: ^2.0.0 flutter_test: sdk: flutter