From 0de2fdf562abfdde2371e5260e23fdfa24819734 Mon Sep 17 00:00:00 2001 From: Lucas SAUDON Date: Wed, 22 May 2024 08:41:38 +0200 Subject: [PATCH] chore: Add lints --- .gitignore | 43 ++++ agir/analysis_options.yaml | 2 +- agir/lib/main.dart | 14 +- agir/pubspec.lock | 23 +- agir/pubspec.yaml | 3 +- agir/test/main_test.dart | 6 +- packages/agir_lints/.gitignore | 7 + packages/agir_lints/analysis_options.yaml | 1 + packages/agir_lints/lib/all_lints.yaml | 224 ++++++++++++++++++ packages/agir_lints/lib/analysis_options.yaml | 27 +++ packages/agir_lints/pubspec.yaml | 6 + 11 files changed, 327 insertions(+), 29 deletions(-) create mode 100644 .gitignore create mode 100644 packages/agir_lints/.gitignore create mode 100644 packages/agir_lints/analysis_options.yaml create mode 100644 packages/agir_lints/lib/all_lints.yaml create mode 100644 packages/agir_lints/lib/analysis_options.yaml create mode 100644 packages/agir_lints/pubspec.yaml diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..29a3a501 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.pub-cache/ +.pub/ +/build/ + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/agir/analysis_options.yaml b/agir/analysis_options.yaml index f9b30346..272641e1 100644 --- a/agir/analysis_options.yaml +++ b/agir/analysis_options.yaml @@ -1 +1 @@ -include: package:flutter_lints/flutter.yaml +include: package:agir_lints/analysis_options.yaml diff --git a/agir/lib/main.dart b/agir/lib/main.dart index a7256585..094ac776 100644 --- a/agir/lib/main.dart +++ b/agir/lib/main.dart @@ -8,13 +8,11 @@ class MainApp extends StatelessWidget { const MainApp({super.key}); @override - Widget build(BuildContext context) { - return const MaterialApp( - home: Scaffold( - body: Center( - child: Text('Hello World!'), + Widget build(final BuildContext context) => const MaterialApp( + home: Scaffold( + body: Center( + child: Text('Hello World!'), + ), ), - ), - ); - } + ); } diff --git a/agir/pubspec.lock b/agir/pubspec.lock index cfe00047..1c9e0231 100644 --- a/agir/pubspec.lock +++ b/agir/pubspec.lock @@ -1,6 +1,13 @@ # Generated by pub # See https://dart.dev/tools/pub/glossary#lockfile packages: + agir_lints: + dependency: "direct dev" + description: + path: "../packages/agir_lints" + relative: true + source: path + version: "0.0.1" async: dependency: transitive description: @@ -54,14 +61,6 @@ packages: description: flutter source: sdk version: "0.0.0" - flutter_lints: - dependency: "direct dev" - description: - name: flutter_lints - sha256: "3f41d009ba7172d5ff9be5f6e6e6abb4300e263aab8866d2a0842ed2a70f8f0c" - url: "https://pub.dev" - source: hosted - version: "4.0.0" flutter_test: dependency: "direct dev" description: flutter @@ -91,14 +90,6 @@ packages: url: "https://pub.dev" source: hosted version: "3.0.1" - lints: - dependency: transitive - description: - name: lints - sha256: "976c774dd944a42e83e2467f4cc670daef7eed6295b10b36ae8c85bcbf828235" - url: "https://pub.dev" - source: hosted - version: "4.0.0" matcher: dependency: transitive description: diff --git a/agir/pubspec.yaml b/agir/pubspec.yaml index a5527636..b95d0054 100644 --- a/agir/pubspec.yaml +++ b/agir/pubspec.yaml @@ -11,9 +11,10 @@ dependencies: sdk: flutter dev_dependencies: + agir_lints: + path: ../packages/agir_lints flutter_test: sdk: flutter - flutter_lints: ^4.0.0 flutter: uses-material-design: true diff --git a/agir/test/main_test.dart b/agir/test/main_test.dart index 81d27db1..bfae0188 100644 --- a/agir/test/main_test.dart +++ b/agir/test/main_test.dart @@ -1,10 +1,10 @@ import 'package:agir/main.dart'; import 'package:flutter_test/flutter_test.dart'; -main() { - testWidgets('show Hello World', (tester) async { +void main() { + testWidgets('show Hello World', (final WidgetTester tester) async { await tester.pumpWidget(const MainApp()); await tester.pumpAndSettle(); - expect(find.text("Hello World!"), findsOneWidget); + expect(find.text('Hello World!'), findsOneWidget); }); } diff --git a/packages/agir_lints/.gitignore b/packages/agir_lints/.gitignore new file mode 100644 index 00000000..3cceda55 --- /dev/null +++ b/packages/agir_lints/.gitignore @@ -0,0 +1,7 @@ +# https://dart.dev/guides/libraries/private-files +# Created by `dart pub` +.dart_tool/ + +# Avoid committing pubspec.lock for library packages; see +# https://dart.dev/guides/libraries/private-files#pubspeclock. +pubspec.lock diff --git a/packages/agir_lints/analysis_options.yaml b/packages/agir_lints/analysis_options.yaml new file mode 100644 index 00000000..59e7227c --- /dev/null +++ b/packages/agir_lints/analysis_options.yaml @@ -0,0 +1 @@ +include: lib/analysis_options.yaml \ No newline at end of file diff --git a/packages/agir_lints/lib/all_lints.yaml b/packages/agir_lints/lib/all_lints.yaml new file mode 100644 index 00000000..7733b5f1 --- /dev/null +++ b/packages/agir_lints/lib/all_lints.yaml @@ -0,0 +1,224 @@ +linter: + rules: + - always_declare_return_types + - always_put_control_body_on_new_line + - always_put_required_named_parameters_first + - always_specify_types + - always_use_package_imports + - annotate_overrides + - annotate_redeclares + - avoid_annotating_with_dynamic + - avoid_bool_literals_in_conditional_expressions + - avoid_catches_without_on_clauses + - avoid_catching_errors + - avoid_classes_with_only_static_members + - 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_implementing_value_types + - avoid_init_to_null + - avoid_js_rounded_ints + - avoid_multiple_declarations_per_line + - 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_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_types_on_closure_parameters + - 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 + - close_sinks + - 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 + - do_not_use_environment + - document_ignores + - empty_catches + - empty_constructor_bodies + - empty_statements + - eol_at_end_of_file + - exhaustive_cases + - file_names + - flutter_style_todos + - hash_and_equals + - implementation_imports + - implicit_call_tearoffs + - implicit_reopen + - invalid_case_patterns + - invalid_runtime_check_with_js_interop_types + - join_return_with_assignment + - leading_newlines_in_multiline_strings + - library_annotations + - library_names + - 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_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_double_quotes + - prefer_expression_function_bodies + - prefer_final_fields + - prefer_final_in_for_each + - prefer_final_locals + - prefer_final_parameters + - 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_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_mixin + - prefer_null_aware_method_calls + - 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 + - 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 + - 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_brace_in_string_interps + - unnecessary_breaks + - unnecessary_const + - unnecessary_constructor_name + - unnecessary_final + - unnecessary_getters_setters + - 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 + - unreachable_from_main + - unrelated_type_equality_checks + - unsafe_html + - use_build_context_synchronously + - use_colored_box + - use_decorated_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 \ No newline at end of file diff --git a/packages/agir_lints/lib/analysis_options.yaml b/packages/agir_lints/lib/analysis_options.yaml new file mode 100644 index 00000000..27e688fd --- /dev/null +++ b/packages/agir_lints/lib/analysis_options.yaml @@ -0,0 +1,27 @@ +include: all_lints.yaml + +analyzer: + language: + strict-casts: true + strict-inference: true + strict-raw-types: true + errors: + close_sinks: ignore + collection_methods_unrelated_type: error + included_file_warning: ignore + missing_required_param: error + missing_return: error + record_literal_one_positional_no_trailing_comma: error + unrelated_type_equality_checks: error + exclude: ["**/*.g.dart"] + + +linter: + rules: + avoid_final_parameters: false # incompatible with `prefer_final_parameters`. + avoid_types_on_closure_parameters: false # incompatible with `always_specify_types`. + diagnostic_describe_all_properties: false + prefer_double_quotes: false # incompatible with `prefer_single_quotes`. + public_member_api_docs: false + type_annotate_public_apis: false + unnecessary_final: false # incompatible with `prefer_final_parameters`. \ No newline at end of file diff --git a/packages/agir_lints/pubspec.yaml b/packages/agir_lints/pubspec.yaml new file mode 100644 index 00000000..b68f5339 --- /dev/null +++ b/packages/agir_lints/pubspec.yaml @@ -0,0 +1,6 @@ +name: agir_lints +description: A starting point for Dart libraries or applications. +version: 0.0.1 + +environment: + sdk: ^3.4.0