diff --git a/CHANGELOG.md b/CHANGELOG.md index 89aaeb2..2b2a731 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,16 +1,21 @@ +# 3.0.0 + +- BREAKING: Requires Dart 2.17 +- Add `use_super_paramters` lint rule + # 2.1.0 - - Remove requirement for public member API docs +- Remove requirement for public member API docs # 2.0.0 - - Add [Dart Code Metrics](https://dartcodemetrics.dev) +- Add [Dart Code Metrics](https://dartcodemetrics.dev) # 1.1.0 - - Ignore `invalid_annotation_target` - - Remove `library_private_types_in_public_api` rule +- Ignore `invalid_annotation_target` +- Remove `library_private_types_in_public_api` rule # 1.0.0 -Initial release \ No newline at end of file +Initial release diff --git a/README.md b/README.md index 5d3b258..aa65cf6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ To use the lints, add a dependency in your `pubspec.yaml`: ```yaml dev_dependencies: - netsells_flutter_analysis: ^2.1.0 + netsells_flutter_analysis: ^3.0.0 ``` Then, add an include in `analysis_options.yaml`: @@ -22,7 +22,7 @@ include: package:netsells_flutter_analysis/analysis_options.yaml This will ensure you always use the latest version of the lints. If you wish to restrict the lint version, specify a version of `analysis_options.yaml` instead: ```yaml -include: package:netsells_flutter_analysis/analysis_options.2.1.0.yaml +include: package:netsells_flutter_analysis/analysis_options.3.0.0.yaml ``` ## Suppressing Lints diff --git a/example/analysis_options.yaml b/example/analysis_options.yaml index 0f33148..2c5c33d 100644 --- a/example/analysis_options.yaml +++ b/example/analysis_options.yaml @@ -1,5 +1 @@ include: package:netsells_flutter_analysis/analysis_options.yaml - -linter: - rules: - public_member_api_docs: false diff --git a/lib/analysis_options.3.0.0.yaml b/lib/analysis_options.3.0.0.yaml new file mode 100644 index 0000000..e83e15c --- /dev/null +++ b/lib/analysis_options.3.0.0.yaml @@ -0,0 +1,221 @@ +analyzer: + plugins: + - dart_code_metrics + + strong-mode: + implicit-casts: false + implicit-dynamic: false + + errors: + close_sinks: ignore + missing_required_param: error + missing_return: error + invalid_annotation_target: ignore + + exclude: + - test/.test_coverage.dart + - lib/generated_plugin_registrant.dart + - lib/**.*.dart + - test/**.*.dart + - build/** + +linter: + rules: + - always_declare_return_types + - always_require_non_null_named_parameters + - 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_function_literals_in_foreach_calls + - avoid_init_to_null + - avoid_js_rounded_ints + - 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_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_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 + - comment_references + - constant_identifier_names + - control_flow_in_finally + - curly_braces_in_flow_control_structures + - deprecated_consistency + - directives_ordering + - empty_catches + - empty_constructor_bodies + - empty_statements + - eol_at_end_of_file + - exhaustive_cases + - file_names + - hash_and_equals + - implementation_imports + - invariant_booleans + - iterable_contains_unrelated_type + - join_return_with_assignment + - leading_newlines_in_multiline_strings + - library_names + - library_prefixes + - lines_longer_than_80_chars + - list_remove_unrelated_type + - literal_only_boolean_expressions + - missing_whitespace_between_adjacent_strings + - no_adjacent_strings_in_list + - no_default_cases + - no_duplicate_case_values + - 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 + - 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_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_operators + - prefer_null_aware_method_calls + - prefer_single_quotes + - prefer_spread_collections + - prefer_typing_uninitialized_variables + - prefer_void_to_null + - provide_deprecation_message + - recursive_getters + - require_trailing_commas + - sized_box_for_whitespace + - 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_const + - unnecessary_getters_setters + - unnecessary_lambdas + - 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 + - unrelated_type_equality_checks + - use_build_context_synchronously + - use_full_hex_values_for_flutter_colors + - use_function_type_syntax_for_parameters + - 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_super_parameters + - use_to_and_as_if_applicable + - valid_regexps + - void_checks + +dart_code_metrics: + metrics: + cyclomatic-complexity: 20 + halstead-volume: 150 + lines-of-code: 150 + maintainability-index: 50 + maximum-nesting-level: 5 + number-of-methods: 10 + number-of-parameters: 4 + source-lines-of-code: 50 + weight-of-class: 0.33 + metrics-exclude: + - test/** + rules: + - avoid-unnecessary-setstate + - avoid-wrapping-in-padding + - avoid-nested-conditional-expressions + - avoid-unnecessary-type-assertions + - avoid-unnecessary-type-casts + - avoid-unrelated-type-assertions + - avoid-unused-parameters + - binary-expression-operand-order + - double-literal-format + - no-equal-then-else + - prefer-conditional-expressions + - prefer-first + - prefer-immediate-return + - prefer-last + - prefer-trailing-comma + anti-patterns: + - long-method + - long-parameter-list diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml index 6a7ef1f..ab0370f 100644 --- a/lib/analysis_options.yaml +++ b/lib/analysis_options.yaml @@ -1 +1 @@ -include: package:netsells_flutter_analysis/analysis_options.2.1.0.yaml +include: package:netsells_flutter_analysis/analysis_options.3.0.0.yaml diff --git a/pubspec.yaml b/pubspec.yaml index d05e79f..84620a3 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: netsells_flutter_analysis -version: 2.1.0 +version: 3.0.0 description: Static analysis rules for Dart and Flutter used at Netsells repository: https://github.com/netsells/flutter-analysis issue_tracker: https://github.com/netsells/flutter-analysis @@ -7,7 +7,7 @@ homepage: https://github.com/netsells/flutter-analysis documentation: https://github.com/netsells/flutter-analysis environment: - sdk: ">=2.14.0 <3.0.0" + sdk: ">=2.17.0 <3.0.0" dependencies: - dart_code_metrics: ^4.14.0 + dart_code_metrics: 4.15.2