Skip to content

Commit

Permalink
refactor(lint): update lint rules (#114)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsutsu3 authored Jan 25, 2025
1 parent 9f89a90 commit daaae1e
Show file tree
Hide file tree
Showing 134 changed files with 1,603 additions and 1,720 deletions.
4 changes: 1 addition & 3 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
{
"recommendations": ["publisher.dcm"]
}
{}
8 changes: 0 additions & 8 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
"[dart]": {
"editor.rulers": [80, 100, 120]
},
"cSpell.ignorePaths": ["/pubspec.yaml", "/.github/workflows"],
"java.configuration.updateBuildConfiguration": "interactive",
"arb-editor.suppressedWarnings": [
"missing_metadata_for_key",
"missing_messages_from_template"
Expand All @@ -19,11 +17,5 @@
},
"[yaml]": {
"editor.defaultFormatter": "redhat.vscode-yaml"
},
"editor.codeActionsOnSave": {
// "source.fixAll": "explicit",
// "source.dcm.fixAll": "explicit"
// or, to enable unsafe fixes on save,
// "source.dcm.unsafeFixAll": "explicit",
}
}
25 changes: 1 addition & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,37 +184,14 @@ Then, follow these steps to build the Linux executable:
To ensure code quality and identify potential issues, perform the following
analysis steps:

1. **Calculate Code Metrics**

Generate code metrics for the lib directory:

```bash
dcm calculate-metrics lib
```

or

```bash
dart run dart_code_linter:metrics lib --reporter=html -o metrics
```

2. **Analyze Code**
1. **Analyze Code**

Analyze the project to catch syntax errors, type issues, and other code problems:

```bash
flutter analyze
dcm analyze lib
```

3. **Check Unused Files**

Identify unused files in the lib directory:

```bash
dcm check-unused-files lib
```

### CI/CD Secrets Management

To store and manage secrets required for GitHub Actions, refer to the
Expand Down
238 changes: 198 additions & 40 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,59 +22,217 @@ linter:
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
- prefer_single_quotes
- always_declare_return_types
- always_put_required_named_parameters_first
- always_use_package_imports
- annotate_overrides
- prefer_const_constructors
- prefer_final_fields
- avoid_print
- use_colored_box
- avoid_unused_constructor_parameters
# - avoid_bool_literals_in_conditional_expressions
# - avoid_catches_without_on_clauses
- avoid_catching_errors
- avoid_double_and_int_checks
# - avoid_dynamic_calls # TODO: Enable this rule
- 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 # TODO: Enable this rule
- 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
- 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_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
- 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

# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options
analyzer:
plugins:
- dart_code_linter
language:
# strict-casts: true
# strict-inference: true
strict-raw-types: true

errors:
invalid_annotation_target: ignore
# 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/**/*.mocks.dart
- lib/**/*.g.dart
- lib/screens/settings/about/about.dart

dart_code_linter:
rules:
- avoid-unused-assignment
- avoid-unused-generics
- avoid-unused-instances
- avoid-unused-parameters
- prefer-trailing-comma
- check-unused-files
# - check-unused-code

dart_code_metrics:
extends:
- recommended
metrics:
cyclomatic-complexity: 20
halstead-volume: 150
lines-of-code: 100
maintainability-index: 50
maximum-nesting-level: 5
number-of-parameters: 4
number-of-used-widgets: 20
source-lines-of-code: 50
widgets-nesting-level: 10
metrics-exclude:
- test/**
rules:
- member-ordering
- no-object-declaration
- prefer-match-file-name: false
- no-empty-block: false
- lib/screens/settings/about/about.dart
Loading

0 comments on commit daaae1e

Please sign in to comment.