diff --git a/.github/workflows/bot_updater.yaml b/.github/workflows/bot_updater.yaml index 2c25b7f..83a8356 100644 --- a/.github/workflows/bot_updater.yaml +++ b/.github/workflows/bot_updater.yaml @@ -22,6 +22,8 @@ jobs: - name: 🎯 Setup Dart uses: dart-lang/setup-dart@v1 + with: + sdk: "3.9.0" - name: 📦 Install Dependencies run: dart pub get @@ -58,11 +60,11 @@ jobs: - name: 🔍 Check for deprecated rules changes id: deprecated run: (dart bin/analyze.dart --set-exit-if-changed && echo "deprecated_rules_changed=false" >> $GITHUB_ENV) || echo "deprecated_rules_changed=true" >> $GITHUB_ENV - + - name: ✍️ Remove deprecated rules if: ${{ env.deprecated_rules_changed == 'true' }} run: dart bin/remove_deprecated_rules.dart - + - name: 📝 Create Pull Request for deprecated rules if: ${{ env.deprecated_rules_changed == 'true' }} uses: peter-evans/create-pull-request@v7.0.8 @@ -77,4 +79,3 @@ jobs: author: VGV Bot assignees: vgvbot committer: VGV Bot - diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 95dc83f..5d830bf 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -11,6 +11,8 @@ jobs: steps: - uses: actions/checkout@v5 - uses: dart-lang/setup-dart@v1 + with: + sdk: "3.9.0" - name: Install Dependencies run: dart pub get diff --git a/.github/workflows/pub_publish.yaml b/.github/workflows/pub_publish.yaml index 2967060..646c4b7 100644 --- a/.github/workflows/pub_publish.yaml +++ b/.github/workflows/pub_publish.yaml @@ -15,6 +15,8 @@ jobs: uses: actions/checkout@v5 - name: 🎯 Setup Dart uses: dart-lang/setup-dart@v1 + with: + sdk: "3.9.0" - name: 📦 Install Dependencies run: dart pub get - name: 🌵 Dry Run diff --git a/.github/workflows/tool_linter_rules.yaml b/.github/workflows/tool_linter_rules.yaml index c6100e9..8d8fd40 100644 --- a/.github/workflows/tool_linter_rules.yaml +++ b/.github/workflows/tool_linter_rules.yaml @@ -7,13 +7,13 @@ concurrency: on: pull_request: paths: - - 'tool/linter_rules/**' - - '.github/workflows/tool_linter_rules.yaml' - - 'pubspec.yaml' + - "tool/linter_rules/**" + - ".github/workflows/tool_linter_rules.yaml" + - "pubspec.yaml" jobs: build: uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1 with: - dart_sdk: 3.8.0 + dart_sdk: 3.9.0 working_directory: tool/linter_rules diff --git a/.github/workflows/verify_version.yaml b/.github/workflows/verify_version.yaml index 06f9cb2..57dc825 100644 --- a/.github/workflows/verify_version.yaml +++ b/.github/workflows/verify_version.yaml @@ -13,6 +13,8 @@ jobs: - uses: actions/checkout@v5 - uses: dart-lang/setup-dart@v1 + with: + sdk: "3.9.0" - name: Verify version consistency run: dart run tool/verify_version/main.dart diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82fb625..ed3aa07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ If you intend to provide changes related to a **new Dart version** you can follo - Choose `` according to [Semantic Versioning](https://semver.org/) guidelines based on your proposed changes. 1. Add or remove the lint rules you want to change in the version file you generated in step 2. - To find new rules more easily you can run the same command as in step 4 which will add new rules directly to the exclusion table. -1. Open a terminal in `tool/linter_rules` and run `dart lib/exclusion_reason_table.dart` to generate an up-to-date exclusion table. +1. Open a terminal in `tool/linter_rules` and run `dart lib/exclusion_reason_table.dart` to generate an up-to-date exclusion table. 1. Document the rules that were removed with a reason as to why, if there is any. - Link to an issue as to why a lint rule should not be used if there is any. 1. Create a pull request following the guidelines in the [Creating a Pull Request](#creating-a-pull-request) section below. diff --git a/README.md b/README.md index f567814..78d1fea 100644 --- a/README.md +++ b/README.md @@ -102,35 +102,23 @@ Below is a list of rules that are not enabled by default together with the reaso | [`avoid_null_checks_in_equality_operators`](https://dart.dev/tools/linter-rules/avoid_null_checks_in_equality_operators) | Has been deprecated and [will be removed](https://github.com/dart-lang/sdk/issues/59514) | | [`avoid_types_on_closure_parameters`](https://dart.dev/tools/linter-rules/avoid_types_on_closure_parameters) | Not specified | | [`close_sinks`](https://dart.dev/tools/linter-rules/close_sinks) | [Has unresolved false positives](https://github.com/dart-lang/linter/issues/1381) | -| [`deprecated_member_use_from_same_package`](https://dart.dev/tools/linter-rules/deprecated_member_use_from_same_package) | Not specified | -| [`diagnostic_describe_all_properties`](https://dart.dev/tools/linter-rules/diagnostic_describe_all_properties) | Not specified | -| [`discarded_futures`](https://dart.dev/tools/linter-rules/discarded_futures) | [Has unresolved false positives](https://github.com/VeryGoodOpenSource/very_good_analysis/issues/74#issuecomment-1668425410) | | [`do_not_use_environment`](https://dart.dev/tools/linter-rules/do_not_use_environment) | Not specified | | [`library_names`](https://dart.dev/tools/linter-rules/library_names) | [Superseded by `unnecessary_library_name`](https://github.com/dart-lang/lints/issues/172) | -| [`matching_super_parameters`](https://dart.dev/tools/linter-rules/matching_super_parameters) | Not specified | -| [`no_literal_bool_comparisons`](https://dart.dev/tools/linter-rules/no_literal_bool_comparisons) | Not specified | | [`omit_obvious_local_variable_types`](https://dart.dev/tools/linter-rules/omit_obvious_local_variable_types) | Not specified | | [`omit_obvious_property_types`](https://dart.dev/tools/linter-rules/omit_obvious_property_types) | Incompatible with [type_annotate_public_apis](https://github.com/dart-lang/sdk/issues/60642) | | [`package_prefixed_library_names`](https://dart.dev/tools/linter-rules/package_prefixed_library_names) | [Broken; superseded by `unnecessary_library_name`](https://github.com/dart-lang/lints/issues/172) | | [`prefer_double_quotes`](https://dart.dev/tools/linter-rules/prefer_double_quotes) | Incompatible with [prefer_single_quotes](https://dart.dev/tools/linter-rules/prefer_single_quotes) | | [`prefer_expression_function_bodies`](https://dart.dev/tools/linter-rules/prefer_expression_function_bodies) | Not specified | | [`prefer_final_parameters`](https://dart.dev/tools/linter-rules/prefer_final_parameters) | Incompatible with [avoid_final_parameters](https://dart.dev/tools/linter-rules/avoid_final_parameters) | -| [`prefer_foreach`](https://dart.dev/tools/linter-rules/prefer_foreach) | Not specified | | [`prefer_mixin`](https://dart.dev/tools/linter-rules/prefer_mixin) | Not specified | | [`prefer_relative_imports`](https://dart.dev/tools/linter-rules/prefer_relative_imports) | Incompatible with [always_use_package_imports](https://dart.dev/tools/linter-rules/always_use_package_imports) | | [`prefer_void_to_null`](https://dart.dev/tools/linter-rules/prefer_void_to_null) | [Has unresolved false positives](https://github.com/dart-lang/linter/issues/4758) | | [`require_trailing_commas`](https://dart.dev/tools/linter-rules/require_trailing_commas) | Not specified | | [`specify_nonobvious_local_variable_types`](https://dart.dev/tools/linter-rules/specify_nonobvious_local_variable_types) | Not specified | -| [`switch_on_type`](https://dart.dev/tools/linter-rules/switch_on_type) | Not specified | | [`unnecessary_async`](https://dart.dev/tools/linter-rules/unnecessary_async) | Not specified | | [`unnecessary_final`](https://dart.dev/tools/linter-rules/unnecessary_final) | Incompatible with [prefer_final_locals](https://dart.dev/tools/linter-rules/prefer_final_locals) | -| [`unnecessary_ignore`](https://dart.dev/tools/linter-rules/unnecessary_ignore) | Not specified | -| [`unnecessary_null_aware_operator_on_extension_on_nullable`](https://dart.dev/tools/linter-rules/unnecessary_null_aware_operator_on_extension_on_nullable) | Not specified | -| [`unnecessary_unawaited`](https://dart.dev/tools/linter-rules/unnecessary_unawaited) | Not specified | -| [`unreachable_from_main`](https://dart.dev/tools/linter-rules/unreachable_from_main) | Not specified | | [`unsafe_variance`](https://dart.dev/tools/linter-rules/unsafe_variance) | Not specified | | [`use_decorated_box`](https://dart.dev/tools/linter-rules/use_decorated_box) | [Has unresolved malfunctions](https://github.com/dart-lang/linter/issues/3286) | -| [`use_null_aware_elements`](https://dart.dev/tools/linter-rules/use_null_aware_elements) | Not specified | | [`use_truncating_division`](https://dart.dev/tools/linter-rules/use_truncating_division) | Not specified | diff --git a/example/pubspec.yaml b/example/pubspec.yaml index 76d9889..dd747b7 100644 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -3,7 +3,7 @@ version: 0.0.1 publish_to: none environment: - sdk: ^3.8.0 + sdk: ^3.9.0 dependencies: very_good_analysis: diff --git a/lib/analysis_options.10.0.0.yaml b/lib/analysis_options.10.0.0.yaml new file mode 100644 index 0000000..e1897ed --- /dev/null +++ b/lib/analysis_options.10.0.0.yaml @@ -0,0 +1,231 @@ +analyzer: + language: + strict-casts: true + strict-inference: true + strict-raw-types: true + + errors: + close_sinks: ignore + missing_required_param: error + missing_return: error + record_literal_one_positional_no_trailing_comma: error + collection_methods_unrelated_type: warning + unrelated_type_equality_checks: warning + + exclude: + - test/.test_coverage.dart + - lib/generated_plugin_registrant.dart + +formatter: + trailing_commas: preserve + +linter: + rules: + - always_declare_return_types + - always_put_required_named_parameters_first + - always_use_package_imports + - annotate_overrides + - avoid_bool_literals_in_conditional_expressions + - avoid_catches_without_on_clauses + - 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_final_parameters + - avoid_function_literals_in_foreach_calls + - avoid_init_to_null + - avoid_js_rounded_ints + - avoid_multiple_declarations_per_line + - 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_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 + - 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 + - document_ignores + - empty_catches + - empty_constructor_bodies + - empty_statements + - eol_at_end_of_file + - exhaustive_cases + - file_names + - flutter_style_todos + - hash_and_equals + - implicit_call_tearoffs + - implementation_imports + - implicit_reopen + - invalid_case_patterns + - invalid_runtime_check_with_js_interop_types + - join_return_with_assignment + - leading_newlines_in_multiline_strings + - library_annotations + - library_prefixes + - library_private_types_in_public_api + - lines_longer_than_80_chars + - literal_only_boolean_expressions + - matching_super_parameters + - missing_code_block_language_in_doc_comment + - 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 + - omit_local_variable_types + - one_member_abstracts + - only_throw_errors + - overridden_fields + - package_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_final_fields + - prefer_final_in_for_each + - prefer_final_locals + - prefer_foreach + - 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_method_calls + - prefer_null_aware_operators + - prefer_single_quotes + - prefer_spread_collections + - prefer_typing_uninitialized_variables + - provide_deprecation_message + - public_member_api_docs + - 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 + - specify_nonobvious_property_types + - strict_top_level_inference + - switch_on_type + - 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 + - unintended_html_in_doc_comment + - unnecessary_await_in_return + - unnecessary_breaks + - unnecessary_brace_in_string_interps + - unnecessary_const + - unnecessary_constructor_name + - unnecessary_getters_setters + - unnecessary_ignore + - unnecessary_lambdas + - unnecessary_late + - unnecessary_library_directive + - unnecessary_library_name + - 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 + - unnecessary_unawaited + - unnecessary_underscores + - unreachable_from_main + - unrelated_type_equality_checks + - use_build_context_synchronously + - use_colored_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_null_aware_elements + - 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 + - use_truncating_division + - valid_regexps + - void_checks diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml index bf1fba8..f1e567c 100644 --- a/lib/analysis_options.yaml +++ b/lib/analysis_options.yaml @@ -1 +1 @@ -include: package:very_good_analysis/analysis_options.9.0.0.yaml +include: package:very_good_analysis/analysis_options.10.0.0.yaml diff --git a/pubspec.yaml b/pubspec.yaml index 1b03ba9..6786ec1 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -8,4 +8,4 @@ documentation: https://github.com/VeryGoodOpenSource/very_good_analysis topics: [lints, analyzer, analysis] environment: - sdk: ^3.8.0 + sdk: ^3.9.0 diff --git a/tool/linter_rules/exclusion_reasons.json b/tool/linter_rules/exclusion_reasons.json index 3644ce8..c346465 100644 --- a/tool/linter_rules/exclusion_reasons.json +++ b/tool/linter_rules/exclusion_reasons.json @@ -9,34 +9,22 @@ "avoid_null_checks_in_equality_operators": "Has been deprecated and [will be removed](https://github.com/dart-lang/sdk/issues/59514)", "avoid_types_on_closure_parameters": "Not specified", "close_sinks": "[Has unresolved false positives](https://github.com/dart-lang/linter/issues/1381)", - "deprecated_member_use_from_same_package": "Not specified", - "diagnostic_describe_all_properties": "Not specified", - "discarded_futures": "[Has unresolved false positives](https://github.com/VeryGoodOpenSource/very_good_analysis/issues/74#issuecomment-1668425410)", "do_not_use_environment": "Not specified", "library_names": "[Superseded by `unnecessary_library_name`](https://github.com/dart-lang/lints/issues/172)", - "matching_super_parameters": "Not specified", - "no_literal_bool_comparisons": "Not specified", "omit_obvious_local_variable_types": "Not specified", "omit_obvious_property_types": "Incompatible with [type_annotate_public_apis](https://github.com/dart-lang/sdk/issues/60642)", "package_prefixed_library_names": "[Broken; superseded by `unnecessary_library_name`](https://github.com/dart-lang/lints/issues/172)", "prefer_double_quotes": "Incompatible with [prefer_single_quotes](https://dart.dev/tools/linter-rules/prefer_single_quotes)", "prefer_expression_function_bodies": "Not specified", "prefer_final_parameters": "Incompatible with [avoid_final_parameters](https://dart.dev/tools/linter-rules/avoid_final_parameters)", - "prefer_foreach": "Not specified", "prefer_mixin": "Not specified", "prefer_relative_imports": "Incompatible with [always_use_package_imports](https://dart.dev/tools/linter-rules/always_use_package_imports)", "prefer_void_to_null": "[Has unresolved false positives](https://github.com/dart-lang/linter/issues/4758)", "require_trailing_commas": "Not specified", "specify_nonobvious_local_variable_types": "Not specified", - "switch_on_type": "Available on Dart SDK 3.8.1, current minimum is Dart SDK 3.8.0.", "unnecessary_async": "Not specified", "unnecessary_final": "Incompatible with [prefer_final_locals](https://dart.dev/tools/linter-rules/prefer_final_locals)", - "unnecessary_ignore": "Not specified", - "unnecessary_null_aware_operator_on_extension_on_nullable": "Not specified", - "unnecessary_unawaited": "Available on Dart SDK 3.8.1, current minimum is Dart SDK 3.8.0.", - "unreachable_from_main": "Not specified", "unsafe_variance": "Not specified", "use_decorated_box": "[Has unresolved malfunctions](https://github.com/dart-lang/linter/issues/3286)", - "use_null_aware_elements": "Not specified", "use_truncating_division": "Not specified" } \ No newline at end of file diff --git a/tool/linter_rules/pubspec.yaml b/tool/linter_rules/pubspec.yaml index 76378dc..8aa5f44 100644 --- a/tool/linter_rules/pubspec.yaml +++ b/tool/linter_rules/pubspec.yaml @@ -4,7 +4,7 @@ version: 0.1.0+1 publish_to: none environment: - sdk: ^3.8.0 + sdk: ^3.9.0 dependencies: args: ^2.6.0 diff --git a/tool/linter_rules/test/src/latest_vga_version_test.dart b/tool/linter_rules/test/src/latest_vga_version_test.dart index 9f59d93..28296ed 100644 --- a/tool/linter_rules/test/src/latest_vga_version_test.dart +++ b/tool/linter_rules/test/src/latest_vga_version_test.dart @@ -2,11 +2,11 @@ import 'package:linter_rules/linter_rules.dart'; import 'package:test/test.dart'; void main() { - group('latestVgaVersion', () { + group(latestVgaVersion, () { test('returns the latest very good analysis version', () { final version = latestVgaVersion(); - expect(version, equals('9.0.0')); + expect(version, equals('10.0.0')); }); test('throws $ArgumentError if the file is not found', () { diff --git a/tool/verify_version/main.dart b/tool/verify_version/main.dart index 6cacfe3..d62a5a9 100644 --- a/tool/verify_version/main.dart +++ b/tool/verify_version/main.dart @@ -10,6 +10,7 @@ void main() { stderr.writeln('❌ pubspec.yaml not found.'); exit(1); } + if (!analysisOptionsFile.existsSync()) { stderr.writeln('❌ lib/analysis_options.yaml not found.'); exit(1); @@ -17,17 +18,21 @@ void main() { // Extract version from pubspec.yaml final pubspecContent = pubspecFile.readAsStringSync(); - final pubspecVersionMatch = - RegExp(r'version:\s*([\d]+\.[\d]+\.[\d]+)').firstMatch(pubspecContent); + final pubspecVersionMatch = RegExp( + r'version:\s*([\d]+\.[\d]+\.[\d]+)', + ).firstMatch(pubspecContent); if (pubspecVersionMatch == null) { stderr.writeln('❌ Could not find a valid version in pubspec.yaml.'); exit(1); } + final pubspecVersion = pubspecVersionMatch.group(1)!; - final versionedAnalysisFile = - File('lib/analysis_options.$pubspecVersion.yaml'); + final versionedAnalysisFile = File( + 'lib/analysis_options.$pubspecVersion.yaml', + ); + if (!versionedAnalysisFile.existsSync()) { stderr.writeln('❌ lib/analysis_options.$pubspecVersion.yaml not found.'); exit(1); @@ -43,16 +48,21 @@ void main() { stderr.writeln('❌ Could not find version in lib/analysis_options.yaml.'); exit(1); } + final analysisVersion = includeMatch.group(1)!; // Compare versions if (pubspecVersion != analysisVersion) { - stderr.writeln('❌ Version mismatch:\n' - '- pubspec.yaml version: $pubspecVersion\n' - '- lib/analysis_options.yaml version: $analysisVersion\n\n' - 'Please update lib/analysis_options.yaml to match pubspec.yaml.'); + stderr.writeln( + '❌ Version mismatch:\n' + '- pubspec.yaml version: $pubspecVersion\n' + '- lib/analysis_options.yaml version: $analysisVersion\n\n' + 'Please update lib/analysis_options.yaml to match pubspec.yaml.', + ); exit(1); } + // Printing in CI to make it visible in the workflow. + // ignore: avoid_print print('✅ Versions match: $pubspecVersion'); }