From 9594cd75618bbe733969a8fa70a33b930d463862 Mon Sep 17 00:00:00 2001 From: Honza Bittner Date: Sun, 27 Oct 2019 22:50:47 +0100 Subject: [PATCH] Publish v1.1.0 --- CHANGELOG.md | 4 +++ README.md | 10 +++--- lib/analysis_options.1.1.0.yaml | 62 +++++++++++++++++++++++++++++++++ lib/analysis_options.yaml | 2 +- pubspec.yaml | 2 +- 5 files changed, 73 insertions(+), 7 deletions(-) create mode 100644 lib/analysis_options.1.1.0.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index eb3e715..4ddfb42 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 1.1.0 + +- Disable `comment_references` because it is way too restrictive ([see this issue](https://github.com/dart-lang/sdk/issues/36974)) + ## 1.0.1 - Fix SDK version. diff --git a/README.md b/README.md index b5edd01..1579797 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use the lints add a dev dependency in your `pubspec.yaml`: ```yaml dev_dependencies: - effective_dart: ^1.0.0 + effective_dart: ^1.1.0 ``` Then add an include in your `analysis_options.yaml` file: @@ -27,16 +27,16 @@ include: package:effective_dart/analysis_options.yaml You can always specify a specific version instead: ```yaml -include: package:effective_dart/analysis_options.1.0.0.yaml +include: package:effective_dart/analysis_options.1.1.0.yaml ``` ## Unused Lints Following lints have been considered and will not be enforced by this package: -`lines_longer_than_80_chars` might be practical not to follow for many people. - -`unnecessary_getters` has been [disabled](https://github.com/dart-lang/linter/issues/23). +- `lines_longer_than_80_chars` might be practical not to follow for many people +- `unnecessary_getters` has been [disabled](https://github.com/dart-lang/linter/issues/23) +- `comment_references` is way too restrictive and comment references are handled in different ways in tools ([see this issue](https://github.com/dart-lang/sdk/issues/36974)) ## Badge diff --git a/lib/analysis_options.1.1.0.yaml b/lib/analysis_options.1.1.0.yaml new file mode 100644 index 0000000..7152508 --- /dev/null +++ b/lib/analysis_options.1.1.0.yaml @@ -0,0 +1,62 @@ +linter: + rules: + # STYLE + - camel_case_types + - library_names + - file_names + - library_prefixes + - non_constant_identifier_names + - constant_identifier_names # prefer + - directives_ordering + #- lines_longer_than_80_chars # avoid + - curly_braces_in_flow_control_structures + + # DOCUMENTATION + - slash_for_doc_comments + - package_api_docs # prefer # ? + - public_member_api_docs # prefer # ? + #- comment_references # Unused because https://github.com/dart-lang/sdk/issues/36974 + + # USAGE + - avoid_relative_lib_imports # prefer + - prefer_adjacent_string_concatenation + - prefer_interpolation_to_compose_strings # prefer + - unnecessary_brace_in_string_interps # avoid + - prefer_collection_literals + - avoid_function_literals_in_foreach_calls # avoid + - prefer_iterable_whereType + - prefer_function_declarations_over_variables + - unnecessary_lambdas + - prefer_equal_for_default_values + - avoid_init_to_null + - unnecessary_getters_setters + #- unnecessary_getters # prefer # Disabled pending fix: https://github.com/dart-lang/linter/issues/23 + #- prefer_expression_function_bodies # consider + - unnecessary_this + - prefer_initializing_formals + - type_init_formals + - empty_constructor_bodies + - unnecessary_new + - unnecessary_const + - avoid_catches_without_on_clauses # avoid + - use_rethrow_when_possible + + # DESIGN + - use_to_and_as_if_applicable # prefer + - one_member_abstracts # avoid + - avoid_classes_with_only_static_members # avoid + - prefer_final_fields # prefer + - use_setters_to_change_properties + - avoid_setters_without_getters + - avoid_returning_null # avoid + - avoid_returning_this # avoid + - type_annotate_public_apis # prefer + #- prefer_typing_uninitialized_variables # consider + - omit_local_variable_types # avoid + - avoid_return_types_on_setters + - prefer_generic_function_type_aliases + - avoid_private_typedef_functions # prefer + #- use_function_type_syntax_for_parameters # consider + - avoid_positional_boolean_parameters # avoid + - hash_and_equals + - avoid_null_checks_in_equality_operators diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml index 3c8ce64..c4181c2 100644 --- a/lib/analysis_options.yaml +++ b/lib/analysis_options.yaml @@ -1 +1 @@ -include: package:effective_dart/analysis_options.1.0.0.yaml +include: package:effective_dart/analysis_options.1.1.0.yaml diff --git a/pubspec.yaml b/pubspec.yaml index 04de41e..a4b6800 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: effective_dart description: This package provides the lints according to the Effective Dart guide. -version: 1.0.1 +version: 1.1.1 author: Honza Bittner repository: https://github.com/tenhobi/effective_dart issue_tracker: https://github.com/tenhobi/effective_dart/issues