diff --git a/.github/workflows/tool_linter_rules.yaml b/.github/workflows/tool_linter_rules.yaml index dad63e9..b411053 100644 --- a/.github/workflows/tool_linter_rules.yaml +++ b/.github/workflows/tool_linter_rules.yaml @@ -17,13 +17,13 @@ jobs: - name: 🎯 Setup Dart uses: dart-lang/setup-dart@v1 with: - sdk: 3.7.0 + sdk: 3.8.0 - name: 📦 Install Dependencies run: dart pub get - name: ✨ Check Formatting - run: dart format --line-length 80 --set-exit-if-changed . + run: dart format --set-exit-if-changed . - name: 🕵️ Analyze run: dart analyze --fatal-infos --fatal-warnings diff --git a/README.md b/README.md index 0b9801f..f567814 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ include: package:very_good_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:very_good_analysis/analysis_options.7.0.0.yaml +include: package:very_good_analysis/analysis_options.9.0.0.yaml ``` ## Suppressing Lints @@ -134,7 +134,7 @@ Below is a list of rules that are not enabled by default together with the reaso | [`use_truncating_division`](https://dart.dev/tools/linter-rules/use_truncating_division) | Not specified | -[analysis_options_yaml]: https://github.com/VeryGoodOpenSource/very_good_analysis/blob/main/lib/analysis_options.7.0.0.yaml +[analysis_options_yaml]: https://github.com/VeryGoodOpenSource/very_good_analysis/blob/main/lib/analysis_options.9.0.0.yaml [ci_badge]: https://github.com/VeryGoodOpenSource/very_good_analysis/workflows/ci/badge.svg [ci_badge_link]: https://github.com/VeryGoodOpenSource/very_good_analysis/actions [badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg diff --git a/example/pubspec.yaml b/example/pubspec.yaml index 304a70b..76d9889 100644 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -3,7 +3,7 @@ version: 0.0.1 publish_to: none environment: - sdk: ">=2.18.0 <3.0.0" + sdk: ^3.8.0 dependencies: very_good_analysis: diff --git a/lib/analysis_options.9.0.0.yaml b/lib/analysis_options.9.0.0.yaml new file mode 100644 index 0000000..d5b139b --- /dev/null +++ b/lib/analysis_options.9.0.0.yaml @@ -0,0 +1,217 @@ +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 + - directives_ordering + - 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 + - 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_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_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 + - 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 + - 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_lambdas + - unnecessary_late + - unnecessary_library_directive + - unnecessary_library_name + - 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 + - unnecessary_to_list_in_spreads + - unnecessary_underscores + - 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_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 diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml index 34576f8..bf1fba8 100644 --- a/lib/analysis_options.yaml +++ b/lib/analysis_options.yaml @@ -1 +1 @@ -include: package:very_good_analysis/analysis_options.8.0.0.yaml +include: package:very_good_analysis/analysis_options.9.0.0.yaml diff --git a/pubspec.yaml b/pubspec.yaml index d3e5acb..71dda59 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.7.0 + sdk: ^3.8.0 diff --git a/tool/bump_version/main.dart b/tool/bump_version/main.dart index a2e15a5..bb035c8 100644 --- a/tool/bump_version/main.dart +++ b/tool/bump_version/main.dart @@ -13,7 +13,7 @@ /// ``` /// /// Where `` is the new version to bump to in the format `x.y.z`. -/// For example: `7.0.0`. +/// For example: `9.0.0`. library; import 'dart:io'; @@ -23,10 +23,10 @@ import 'dart:io'; /// Given the following: /// /// ```sh -/// include: package:very_good_analysis/analysis_options.6.0.0.yaml +/// include: package:very_good_analysis/analysis_options.9.0.0.yaml /// ``` /// -/// It is expected that the first matched group will be `6.0.0`. +/// It is expected that the first matched group will be `9.0.0`. final _latestAnalysisVersionRegExp = RegExp( r'analysis_options\.(\d+\.\d+\.\d+)\.yaml', ); diff --git a/tool/linter_rules/README.md b/tool/linter_rules/README.md index 4c34b38..08522f8 100644 --- a/tool/linter_rules/README.md +++ b/tool/linter_rules/README.md @@ -54,4 +54,4 @@ To run the `inspect` script, run the following command (from `tool/linter_rules` dart bin/inspect.dart $version ``` -Where version is the existing Very Good Analysis version you would like to inspect, for example `7.0.0`. +Where version is the existing Very Good Analysis version you would like to inspect, for example `9.0.0`. diff --git a/tool/linter_rules/bin/inspect.dart b/tool/linter_rules/bin/inspect.dart index 2e8e12f..4729a13 100644 --- a/tool/linter_rules/bin/inspect.dart +++ b/tool/linter_rules/bin/inspect.dart @@ -43,23 +43,22 @@ Future main( final response = await get(_allLinterRulesUri); final json = jsonDecode(response.body) as List; - final dartRules = - json - .map((rule) => LinterRule.fromJson(rule as Map)) - .toList(); + final dartRules = json + .map((rule) => LinterRule.fromJson(rule as Map)) + .toList(); log('Fetched ${dartRules.length} Dart linter rules'); final vgaRules = await allVeryGoodAnalysisRules(version: version); log('Fetched ${vgaRules.length} Very Good Analysis rules'); log(''); - final deprecatedDartRules = - dartRules - .where((rule) => rule.state == LinterRuleState.deprecated) - .map((rule) => rule.name) - .toSet(); - final deprecatedVgaRules = - vgaRules.where(deprecatedDartRules.contains).toList(); + final deprecatedDartRules = dartRules + .where((rule) => rule.state == LinterRuleState.deprecated) + .map((rule) => rule.name) + .toSet(); + final deprecatedVgaRules = vgaRules + .where(deprecatedDartRules.contains) + .toList(); final deprecationMessage = StringBuffer( '''Found ${deprecatedVgaRules.length} deprecated Dart rules (out of ${deprecatedDartRules.length} deprecated Dart rules) in Very Good Analysis ($version)${deprecatedVgaRules.isEmpty ? '.' : ':'}''', ); diff --git a/tool/linter_rules/exclusion_reasons.json b/tool/linter_rules/exclusion_reasons.json index aa3c335..3644ce8 100644 --- a/tool/linter_rules/exclusion_reasons.json +++ b/tool/linter_rules/exclusion_reasons.json @@ -28,12 +28,12 @@ "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": "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": "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)", diff --git a/tool/linter_rules/lib/exclusion_reason_table.dart b/tool/linter_rules/lib/exclusion_reason_table.dart index 76c8c54..e978421 100644 --- a/tool/linter_rules/lib/exclusion_reason_table.dart +++ b/tool/linter_rules/lib/exclusion_reason_table.dart @@ -60,18 +60,16 @@ Future main( List args, { void Function(String) log = print, }) async { - final argsParser = - ArgParser() - ..addOption( - 'version', - help: - 'The version of the Very Good Analysis to update the table for.', - ) - ..addFlag( - 'set-exit-if-changed', - help: - '''Set the exit code to 2 if there are changes to the exclusion reasons.''', - ); + final argsParser = ArgParser() + ..addOption( + 'version', + help: 'The version of the Very Good Analysis to update the table for.', + ) + ..addFlag( + 'set-exit-if-changed', + help: + '''Set the exit code to 2 if there are changes to the exclusion reasons.''', + ); final parsedArgs = argsParser.parse(args); final version = parsedArgs['version'] as String? ?? latestVgaVersion(); @@ -80,12 +78,13 @@ Future main( final linterRules = (await allLinterRules()).toSet(); log('Found ${linterRules.length} available linter rules'); - final veryGoodAnalysisRules = - (await allVeryGoodAnalysisRules(version: version)).toSet(); + final veryGoodAnalysisRules = (await allVeryGoodAnalysisRules( + version: version, + )).toSet(); log('Found ${veryGoodAnalysisRules.length} Very Good Analysis rules'); - final excludedRules = - linterRules.difference(veryGoodAnalysisRules).toList()..sort(); + final excludedRules = linterRules.difference(veryGoodAnalysisRules).toList() + ..sort(); log('Found ${excludedRules.length} excluded rules'); final previousExclusionReasons = await readExclusionReasons(); @@ -94,11 +93,10 @@ Future main( rule: previousExclusionReasons[rule] ?? _noReasonFallback, }; - final hasChanged = - !const DeepCollectionEquality().equals( - previousExclusionReasons, - exclusionReasons, - ); + final hasChanged = !const DeepCollectionEquality().equals( + previousExclusionReasons, + exclusionReasons, + ); if (!hasChanged) { log('No changes to the exclusion reasons'); return; diff --git a/tool/linter_rules/lib/src/all_linter_rules.dart b/tool/linter_rules/lib/src/all_linter_rules.dart index df70348..99c1e8a 100644 --- a/tool/linter_rules/lib/src/all_linter_rules.dart +++ b/tool/linter_rules/lib/src/all_linter_rules.dart @@ -17,18 +17,17 @@ final Uri _allLinterRulesUri = Uri.parse( Future> allLinterRules() async { final response = await get(_allLinterRulesUri); - final data = - (jsonDecode(response.body) as List) - ..removeWhere((data) { - final rule = data as Map; - final state = rule['state'] as String; - return state == 'removed'; - }) - ..removeWhere((data) { - final rule = data as Map; - final sdk = rule['sinceDartSdk'] as String; - return sdk.contains('wip'); - }); + final data = (jsonDecode(response.body) as List) + ..removeWhere((data) { + final rule = data as Map; + final state = rule['state'] as String; + return state == 'removed'; + }) + ..removeWhere((data) { + final rule = data as Map; + final sdk = rule['sinceDartSdk'] as String; + return sdk.contains('wip'); + }); return data.map((data) { final rule = data as Map; diff --git a/tool/linter_rules/lib/src/markdown_table_generator.dart b/tool/linter_rules/lib/src/markdown_table_generator.dart index d23f9a6..486842b 100644 --- a/tool/linter_rules/lib/src/markdown_table_generator.dart +++ b/tool/linter_rules/lib/src/markdown_table_generator.dart @@ -21,10 +21,9 @@ /// | Row 2, Cell 1 | Row 2, Cell 2 | /// ``` String generateMarkdownTable(List> rows) { - final buffer = - StringBuffer() - ..writeln('| ${rows.first.join(' | ')} |') - ..writeln('| ${rows.first.map((_) => '---').join(' | ')} |'); + final buffer = StringBuffer() + ..writeln('| ${rows.first.join(' | ')} |') + ..writeln('| ${rows.first.map((_) => '---').join(' | ')} |'); for (var i = 1; i < rows.length; i++) { buffer.writeln('| ${rows[i].join(' | ')} |'); } diff --git a/tool/linter_rules/pubspec.yaml b/tool/linter_rules/pubspec.yaml index 65fa0a0..cc6f7cf 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.7.0 + sdk: ^3.8.0 dependencies: args: ^2.6.0