diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..80fa59d --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @netsells/flutter \ No newline at end of file diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..a8a04f8 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,38 @@ +name: ci + +on: pull_request + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.3.4 + - uses: dart-lang/setup-dart@v1 + + - name: Install Dependencies + run: dart pub get + + - name: Format + run: dart format --set-exit-if-changed . + + - name: Analyze + run: dart analyze . + + pana: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2.3.4 + - uses: subosito/flutter-action@v1.5.0 + + - name: Install Dependencies + run: | + flutter packages get + flutter pub global activate pana + + - name: Verify Pub Score + run: | + PANA=$(pana . --no-warning); PANA_SCORE=$(echo $PANA | sed -n "s/.*Points: \([0-9]*\)\/\([0-9]*\)./\1\/\2/p") + echo "score: $PANA_SCORE" + IFS='/'; read -a SCORE_ARR <<< "$PANA_SCORE"; SCORE=SCORE_ARR[0]; TOTAL=SCORE_ARR[1] + if (( $SCORE < $TOTAL )); then echo "minimum score not met!"; exit 1; fi diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3484749 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.dart_tool +.packages +pubspec.lock +.DS_Store \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..aa465af --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# 1.0.0 + +Initial release \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..43928a8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Netsells + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..43a2a0b --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# Netsells Flutter Analysis + +This package provides lint rules for Dart and Flutter which are used at [Netsells](https://netsells.co.uk). + +**Note**: This package was heavily inspired by [very_good_analysis](https://pub.dev/packages/very_good_analysis). + +## Usage + +To use the lints, add a dependency in your `pubspec.yaml`: + +```yaml +# If you use `package:netsells_flutter_analysis/netsells_flutter_analysis.dart`, add a normal dependency. +dependencies: + netsells_flutter_analysis: ^1.0.0 + +# Or, if you just want `analysis_options.yaml`, it can be a dev dependency. +dev_dependencies: + netsells_flutter_analysis: ^1.0.0 +``` + +Then, add an include in `analysis_options.yaml`: + +```yaml +include: package:netsells_flutter_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:netsells_flutter_analysis/analysis_options.1.0.0.yaml +``` + +## Suppressing Lints + +There may be cases where specific lint rules are undesirable. Lint rules can be surpressed at the line, file, or project level. + +An example use case for suppressing lint rules at the file level is suppressing the `prefer_const_constructors` in order to achieve 100% code coverage. This is due to the fact that const constructors are executed before the tests are run, resulting in no coverage collection. + +### Line Level + +To surpress a specific lint rule for a specific line of code, use an `ignore` comment directly above the line: + +```dart +// ignore: public_member_api_docs +class A {} +``` + +### File Level + +To surpress a specific lint rule of a specific file, use an `ignore_for_file` comment at the top of the file: + +```dart +// ignore_for_file: public_member_api_docs + +class A {} + +class B {} +``` + +### Project Level + +To surpress a specific lint rule for an entire project, modify `analysis_options.yaml`: + +```yaml +include: package:netsells_flutter_analysis/analysis_options.yaml +linter: + rules: + public_member_api_docs: false +``` \ No newline at end of file diff --git a/analysis_options.yaml b/analysis_options.yaml new file mode 100644 index 0000000..a4bfc29 --- /dev/null +++ b/analysis_options.yaml @@ -0,0 +1 @@ +include: lib/analysis_options.yaml diff --git a/example/analysis_options.yaml b/example/analysis_options.yaml new file mode 100644 index 0000000..0f33148 --- /dev/null +++ b/example/analysis_options.yaml @@ -0,0 +1,5 @@ +include: package:netsells_flutter_analysis/analysis_options.yaml + +linter: + rules: + public_member_api_docs: false diff --git a/example/lib/example.dart b/example/lib/example.dart new file mode 100644 index 0000000..a40fdd2 --- /dev/null +++ b/example/lib/example.dart @@ -0,0 +1,12 @@ +import 'package:netsells_flutter_analysis/netsells_flutter_analysis.dart'; + +Future main() async { + /// Await async functions. + await asyncFunction(); + + /// Use [unawaited] to indicate that a [Future] is intentionally not awaited. + /// Otherwise you'll get a warning + unawaited(asyncFunction()); +} + +Future asyncFunction() => Future.value('hello world!'); diff --git a/example/pubspec.yaml b/example/pubspec.yaml new file mode 100644 index 0000000..6fbdf2c --- /dev/null +++ b/example/pubspec.yaml @@ -0,0 +1,10 @@ +name: netsells_flutter_analysis_example +version: 0.0.1 +publish_to: none + +environment: + sdk: ">=2.14.0 <3.0.0" + +dependencies: + netsells_flutter_analysis: + path: ../ diff --git a/lib/analysis_options.1.0.0.yaml b/lib/analysis_options.1.0.0.yaml new file mode 100644 index 0000000..dd2550d --- /dev/null +++ b/lib/analysis_options.1.0.0.yaml @@ -0,0 +1,182 @@ +analyzer: + strong-mode: + implicit-casts: false + implicit-dynamic: false + + errors: + close_sinks: ignore + missing_required_param: error + missing_return: error + + exclude: + - test/.test_coverage.dart + - lib/generated_plugin_registrant.dart + +linter: + rules: + - always_declare_return_types + - always_require_non_null_named_parameters + - always_use_package_imports + - annotate_overrides + - avoid_bool_literals_in_conditional_expressions + - 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_function_literals_in_foreach_calls + - avoid_init_to_null + - avoid_js_rounded_ints + - 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 + - avoid_returning_null_for_future + - 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 + - comment_references + - constant_identifier_names + - control_flow_in_finally + - curly_braces_in_flow_control_structures + - deprecated_consistency + - directives_ordering + - empty_catches + - empty_constructor_bodies + - empty_statements + - eol_at_end_of_file + - exhaustive_cases + - file_names + - hash_and_equals + - implementation_imports + - invariant_booleans + - iterable_contains_unrelated_type + - join_return_with_assignment + - leading_newlines_in_multiline_strings + - library_names + - library_prefixes + - library_private_types_in_public_api + - lines_longer_than_80_chars + - list_remove_unrelated_type + - literal_only_boolean_expressions + - missing_whitespace_between_adjacent_strings + - no_adjacent_strings_in_list + - no_default_cases + - no_duplicate_case_values + - no_logic_in_create_state + - no_runtimeType_toString + - non_constant_identifier_names + - noop_primitive_operations + - null_check_on_nullable_type_parameter + - null_closures + - omit_local_variable_types + - 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_equal_for_default_values + - 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_operators + - prefer_null_aware_method_calls + - 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 + - sized_box_for_whitespace + - 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 + - unawaited_futures + - unnecessary_await_in_return + - unnecessary_brace_in_string_interps + - unnecessary_const + - unnecessary_getters_setters + - unnecessary_lambdas + - 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 + - unrelated_type_equality_checks + - use_build_context_synchronously + - use_full_hex_values_for_flutter_colors + - use_function_type_syntax_for_parameters + - 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_to_and_as_if_applicable + - valid_regexps + - void_checks diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml new file mode 100644 index 0000000..84e04a8 --- /dev/null +++ b/lib/analysis_options.yaml @@ -0,0 +1 @@ +include: package:netsells_flutter_analysis/analysis_options.1.0.0.yaml diff --git a/lib/netsells_flutter_analysis.dart b/lib/netsells_flutter_analysis.dart new file mode 100644 index 0000000..cc4760a --- /dev/null +++ b/lib/netsells_flutter_analysis.dart @@ -0,0 +1,12 @@ +/// Dart analyzer settings and best practices +/// used internally at [Netsells](https://netsells.co.uk). +library netsells_flutter_analysis; + +/// Indicates to tools that `Future` is intentionally not `await`-ed. +/// +/// In an `async` context, it is normally expected that all `Future`s are +/// awaited, and that is the basis of the lint `unawaited_futures`. However, +/// there are times where one or more futures are intentionally not awaited. +/// This function may be used to ignore a particular future. It silences the +/// `unawaited_futures` lint. +void unawaited(Future? future) {} diff --git a/pubspec.yaml b/pubspec.yaml new file mode 100644 index 0000000..e531280 --- /dev/null +++ b/pubspec.yaml @@ -0,0 +1,10 @@ +name: netsells_flutter_analysis +version: 1.0.0 +description: Lint rules for Dart and Flutter used internally at Netsells +repository: https://github.com/netsells/flutter-analysis +issue_tracker: https://github.com/netsells/flutter-analysis +homepage: https://github.com/netsells/flutter-analysis +documentation: https://github.com/netsells/flutter-analysis + +environment: + sdk: ">=2.14.0 <3.0.0"