Skip to content

refactor: update to use flutter default analysis #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 23 additions & 170 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1,175 +1,28 @@
# ~ Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file
# ~ for details. All rights reserved. Use of this source code is governed by a
# ~ BSD-style license that can be found in the LICENSE file.
# ~
# ~ A living list of rules following the Effective Dart guide.
# ~ https://www.dartlang.org/guides/language/effective-dart
# ~
# ~ Note: not everything suggested in the guide has a rule associated with it.
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.

analyzer:
#strong-mode:
#implicit-casts: false
#implicit-dynamic: false
errors:
todo: ignore
#exclude:
# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml

# ~ Effective dart lint rules form https://github.com/dart-lang/linter
# ~ We have implemented all but lines_longer_than_80_chars & public_member_api_docs
linter:
# The lint rules applied to this project can be customized in the
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
# included above or to enable additional rules. A list of all available lints
# and their documentation is published at https://dart.dev/lints.
#
# Instead of disabling a lint rule for the entire project in the
# section below, it can also be suppressed for a single line of code
# or a specific dart file by using the `// ignore: name_of_lint` and
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
# ~ --- STYLE
# ~ identifiers
- camel_case_types
- library_names
- file_names
- library_prefixes
- non_constant_identifier_names
- constant_identifier_names # ~ prefer
# ~ ordering
- directives_ordering
# ~ formating
- curly_braces_in_flow_control_structures
# ~ --- DOCUMENTATION
# ~ comments
# ~ doc comments
- slash_for_doc_comments
- package_api_docs # ~ prefer
- comment_references
# ~ markdown
# ~ writing
# ~ --- USAGE
# ~ libraries
- implementation_imports
- avoid_relative_lib_imports
# ~ strings
- prefer_adjacent_string_concatenation
- prefer_interpolation_to_compose_strings # ~ prefer
- unnecessary_brace_in_string_interps # ~ avoid
# ~ collections
- prefer_collection_literals
- avoid_function_literals_in_foreach_calls # ~ avoid
- prefer_iterable_whereType
# ~ functions
- prefer_function_declarations_over_variables
- unnecessary_lambdas
# ~ variables
- avoid_init_to_null
# ~ members
- unnecessary_getters_setters
- prefer_final_fields
- prefer_expression_function_bodies # consider
- unnecessary_this
- prefer_typing_uninitialized_variables
# ~ constructors
- prefer_initializing_formals
- type_init_formals
- empty_constructor_bodies
- unnecessary_new
- unnecessary_const
# ~ error handling
- avoid_catches_without_on_clauses # ~ avoid
- use_rethrow_when_possible
# ~ asynchrony
# ~ --- DESIGN
# ~ names
- use_to_and_as_if_applicable
# ~ libraries
# ~ classes
- one_member_abstracts # ~ avoid
- avoid_classes_with_only_static_members # ~ avoid
# ~ constructors
- prefer_constructors_over_static_methods
# ~ members
- use_setters_to_change_properties
- avoid_setters_without_getters
- avoid_returning_this # ~ avoid
# ~ types
- type_annotate_public_apis # ~ prefer
- omit_local_variable_types # ~ avoid
- avoid_types_on_closure_parameters # ~ avoid
- avoid_return_types_on_setters
- prefer_generic_function_type_aliases
- avoid_private_typedef_functions # ~ prefer
# ~ parameters
- avoid_positional_boolean_parameters # ~ avoid
# ~ equality
- hash_and_equals
- avoid_null_checks_in_equality_operators

# ~ Rules that are not used but are recommended by effective dart:
#
# - public_member_api_docs # ~ We don't have time to document everything yet
# - lines_longer_than_80_chars # prefer # ~ Doesn't seem reasonable
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule

# ~ Rules that are not used
# - always_declare_return_types
# - always_put_control_body_on_new_line
# - always_put_required_named_parameters_first
# - always_require_non_null_named_parameters
# - always_specify_types
# - annotate_overrides
# - avoid_annotating_with_dynamic
# - avoid_as
# - avoid_bool_literals_in_conditional_expressions
# - avoid_catching_errors
# - avoid_double_and_int_checks
# - avoid_empty_else
# - avoid_field_initializers_in_const_classes
# - avoid_js_rounded_ints
# - avoid_renaming_method_parameters
# - avoid_single_cascade_in_expression_statements
# - avoid_slow_async_io
# - avoid_types_as_parameter_names
# - avoid_unused_constructor_parameters
# - await_only_futures
# - cancel_subscriptions
# - cascade_invocations
# - close_sinks
# - control_flow_in_finally
# - empty_catches
# - empty_statements
# - invariant_booleans
# - iterable_contains_unrelated_type
# - join_return_with_assignment
# - list_remove_unrelated_type
# - literal_only_boolean_expressions
# - no_adjacent_strings_in_list
# - no_duplicate_case_values
# - null_closures
# - only_throw_errors
# - overridden_fields
# - package_names
# - package_prefixed_library_names
# - parameter_assignments
# - prefer_asserts_in_initializer_lists
# - prefer_bool_in_asserts
# - prefer_conditional_assignment
# - prefer_const_constructors
# - prefer_const_constructors_in_immutables
# - prefer_const_declarations
# - prefer_const_literals_to_create_immutables
# - prefer_contains
# - prefer_expression_function_bodies
# - prefer_final_locals
# - prefer_foreach
# - prefer_is_empty
# - prefer_is_not_empty
# - prefer_single_quotes
# - recursive_getters
# - sort_constructors_first
# - sort_unnamed_constructors_first
# - super_goes_last
# - test_types_in_equals
# - throw_in_finally
# - unawaited_futures
# - unnecessary_null_aware_assignments
# - unnecessary_null_in_if_null_operators
# - unnecessary_overrides
# - unnecessary_parenthesis
# - unnecessary_statements
# - unrelated_type_equality_checks
# - use_string_buffers
# - valid_regexps
# - void_checks
# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options
2 changes: 1 addition & 1 deletion example/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ packages:
path: ".."
relative: true
source: path
version: "6.0.0"
version: "5.1.0"
flutter_lints:
dependency: "direct dev"
description:
Expand Down
2 changes: 1 addition & 1 deletion lib/src/dotenv.dart
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ class DotEnv {
} else if (['false', '0'].contains(value.toLowerCase())) {
return false;
} else {
throw FormatException('Could not parse as a bool');
throw const FormatException('Could not parse as a bool');
}
}

Expand Down
16 changes: 16 additions & 0 deletions pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ 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
Expand Down Expand Up @@ -83,6 +91,14 @@ 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:
Expand Down
7 changes: 7 additions & 0 deletions pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,10 @@ dependencies:
dev_dependencies:
flutter_test:
sdk: flutter

# The "flutter_lints" package below contains a set of recommended lints to
# encourage good coding practices. The lint set provided by the package is
# activated in the `analysis_options.yaml` file located at the root of your
# package. See that file for information about deactivating specific lint
# rules and activating additional ones.
flutter_lints: ^4.0.0
Loading