Skip to content

Commit

Permalink
use package:lints/recommended.yaml generally (dart-lang#180)
Browse files Browse the repository at this point in the history
* merge to main

* address lints

* use package:lints/recommended.yaml generally

* remove reference

* remove ignore print statement directive
  • Loading branch information
devoncarew authored Nov 6, 2023
1 parent d3c9060 commit fbc2014
Show file tree
Hide file tree
Showing 24 changed files with 91 additions and 186 deletions.
1 change: 1 addition & 0 deletions pkgs/leak_tracker/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

* Add arguments allNotGCed and allNotDisposed to withTracked.
* Remove the dependency on `package:intl`.
* Updated to use `package:lints/recommended.yaml` for analysis.

## 9.0.14

Expand Down
139 changes: 4 additions & 135 deletions pkgs/leak_tracker/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1,143 +1,12 @@
include: package:flutter_lints/flutter.yaml
# TODO(polina-c): start using https://pub.dev/packages/dart_flutter_team_lints instead.
include: package:lints/recommended.yaml

analyzer:
language:
strict-casts: true
strict-inference: true
#strict-raw-types: true # 103 issues
errors:
# treat missing required parameters as a warning (not a hint)
missing_required_param: warning
# treat missing returns as a warning (not a hint)
missing_return: warning
exclude:
- build/**

linter:
rules:
# Added on top of the flutter/flutter lints:
- prefer_generic_function_type_aliases

# From flutter/flutter:
# these rules are documented on and in the same order as
# the Dart Lint rules page to make maintenance easier
# https://github.com/dart-lang/linter/blob/master/example/all.yaml
- always_declare_return_types
# - always_put_control_body_on_new_line
# - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219
- always_require_non_null_named_parameters
# - always_specify_types
- annotate_overrides
# - avoid_annotating_with_dynamic # conflicts with always_specify_types
# - avoid_as # we use 'as' in this codebase
# - avoid_bool_literals_in_conditional_expressions # not yet tested
# - avoid_catches_without_on_clauses # we do this commonly
# - avoid_catching_errors # we do this commonly
# - avoid_classes_with_only_static_members
# - avoid_double_and_int_checks # only useful when targeting JS runtime
- avoid_empty_else
- avoid_field_initializers_in_const_classes
- avoid_function_literals_in_foreach_calls
- avoid_init_to_null
# - avoid_js_rounded_ints # only useful when targeting JS runtime
- avoid_null_checks_in_equality_operators
# - avoid_positional_boolean_parameters # not yet tested
# - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
- avoid_redundant_argument_values
- avoid_relative_lib_imports
- avoid_renaming_method_parameters
- avoid_return_types_on_setters
# - avoid_returning_null # we do this commonly
# - avoid_returning_this # https://github.com/dart-lang/linter/issues/842
# - avoid_setters_without_getters # not yet tested
# - avoid_single_cascade_in_expression_statements # not yet tested
- avoid_slow_async_io
# - avoid_types_as_parameter_names # https://github.com/dart-lang/linter/pull/954/files
# - avoid_types_on_closure_parameters # conflicts with always_specify_types
- avoid_unnecessary_containers
# - avoid_unused_constructor_parameters # https://github.com/dart-lang/linter/pull/847
- await_only_futures
- camel_case_types
- cancel_subscriptions
- collection_methods_unrelated_type
# - cascade_invocations # not yet tested
# - close_sinks # https://github.com/flutter/flutter/issues/5789
# - comment_references # blocked on https://github.com/dart-lang/dartdoc/issues/1153
# - constant_identifier_names # https://github.com/dart-lang/linter/issues/204
- control_flow_in_finally
- directives_ordering
- discarded_futures
- empty_catches
- empty_constructor_bodies
- empty_statements
- hash_and_equals
- implementation_imports
# - join_return_with_assignment # not yet tested
- library_names
- library_prefixes
# - literal_only_boolean_expressions # https://github.com/flutter/flutter/issues/5791
- no_adjacent_strings_in_list
- no_duplicate_case_values
- non_constant_identifier_names
# - omit_local_variable_types # opposite of always_specify_types
# - one_member_abstracts # too many false positives
# - only_throw_errors # https://github.com/flutter/flutter/issues/5792
- overridden_fields
- package_api_docs
- package_names
- package_prefixed_library_names
# - parameter_assignments # we do this commonly
- prefer_adjacent_string_concatenation
- prefer_asserts_in_initializer_lists
- 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 # not yet tested
- prefer_contains
# - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
- prefer_final_fields
- prefer_final_locals
- prefer_foreach
# - prefer_function_declarations_over_variables # not yet tested
- prefer_initializing_formals
# - prefer_interpolation_to_compose_strings # not yet tested
# - prefer_iterable_whereType # https://github.com/dart-lang/sdk/issues/32463
- prefer_is_empty
- prefer_is_not_empty
- prefer_relative_imports
- prefer_single_quotes
- prefer_typing_uninitialized_variables
- require_trailing_commas
- recursive_getters
- slash_for_doc_comments
- sort_child_properties_last
- sort_constructors_first
- sort_unnamed_constructors_first
- test_types_in_equals
- throw_in_finally
# - type_annotate_public_apis # subset of always_specify_types
- type_init_formals
- unawaited_futures
- unnecessary_brace_in_string_interps
- unnecessary_const
- unnecessary_getters_setters
# - unnecessary_lambdas # https://github.com/dart-lang/linter/issues/498
- unnecessary_new
- unnecessary_null_aware_assignments
- unnecessary_null_in_if_null_operators
- unnecessary_overrides
- unnecessary_parenthesis
- unnecessary_statements
- unnecessary_this
- unrelated_type_equality_checks
- unsafe_html
- use_rethrow_when_possible
# - use_setters_to_change_properties # not yet tested
# - use_string_buffers # https://github.com/dart-lang/linter/pull/664
# - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
- valid_regexps
# - void_checks # not yet tested
- avoid_catching_errors
- comment_references
- only_throw_errors
2 changes: 1 addition & 1 deletion pkgs/leak_tracker/example/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
include: ../analysis_options.yaml
include: package:lints/recommended.yaml
5 changes: 4 additions & 1 deletion pkgs/leak_tracker/example/main.dart
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
// Copyright (c) 2022, 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.

import 'package:leak_tracker/leak_tracker.dart';

void main(List<String> arguments) {
LeakTracking.start();
// ignore: avoid_print
print('Hello, world!');
LeakTracking.stop();
}
4 changes: 2 additions & 2 deletions pkgs/leak_tracker/example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ environment:
sdk: ^3.0.0

dependencies:
leak_tracker: ^1.0.0-dev.1.3
leak_tracker: any

dev_dependencies:
flutter_lints: ^3.0.0
lints: ^3.0.0

dependency_overrides:
leak_tracker:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,10 @@ bool _registerServiceExtension(
_extentsionRegistered = true;

return true;
// ignore: avoid_catching_errors
} on ArgumentError catch (ex) {
// Return false if extension is already registered.
final bool isAlreadyRegisteredError = ex.toString().contains('registered');
final isAlreadyRegisteredError = ex.toString().contains('registered');
if (isAlreadyRegisteredError) {
return false;
} else {
Expand Down
2 changes: 0 additions & 2 deletions pkgs/leak_tracker/lib/src/leak_tracking/_baseliner.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
// 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.

// ignore_for_file: avoid_print

import 'dart:io';

import 'primitives/_print_bytes.dart';
Expand Down
5 changes: 3 additions & 2 deletions pkgs/leak_tracker/lib/src/leak_tracking/_object_record.dart
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ class ObjectRecord {
// Noop if object is already disposed.
if (_disposalGcCount != null) return;
if (_gcedGcCount != null) {
throw 'The object $code should not be disposed after being GCed.';
throw Exception(
'The object $code should not be disposed after being GCed');
}
_disposalGcCount = gcTime;
_disposalTime = time;
Expand All @@ -53,7 +54,7 @@ class ObjectRecord {
DateTime? _gcedTime;
int? _gcedGcCount;
void setGCed(int gcCount, DateTime time) {
if (_gcedGcCount != null) throw 'The object $code GCed twice.';
if (_gcedGcCount != null) throw Exception('The object $code GCed twice');
_gcedGcCount = gcCount;
_gcedTime = time;
}
Expand Down
4 changes: 3 additions & 1 deletion pkgs/leak_tracker/lib/src/leak_tracking/_object_tracker.dart
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ class ObjectTracker implements LeakProvider {

void _onObjectGarbageCollected(Object record) {
if (disposed) return;
if (record is! ObjectRecord) throw 'record should be $ObjectRecord.';
if (record is! ObjectRecord) {
throw Exception('record should be $ObjectRecord');
}

_objects.assertRecordIntegrity(record);
record.setGCed(_gcCounter.gcCount, clock.now());
Expand Down
2 changes: 1 addition & 1 deletion pkgs/leak_tracker/lib/src/leak_tracking/helpers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Future<void> forceGC({
}
}

/// Returns nicely formatted retaining path for the [ref.target].
/// Returns nicely formatted retaining path for the [WeakReference.target].
///
/// If the object is garbage collected or not retained, returns null.
///
Expand Down
6 changes: 4 additions & 2 deletions pkgs/leak_tracker/lib/src/leak_tracking/primitives/model.dart
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ typedef LeakSummaryCallback = void Function(LeakSummary);

/// Handler to collect leak information.
///
/// Used by [LeakTrackingTestConfig.onLeaks].
/// This is used by `LeakTrackingTestConfig.onLeaks` in
/// `package:leak_tracker_flutter_testing`.
///
/// The parameter [leaks] contains details about found leaks.
typedef LeaksCallback = void Function(Leaks leaks);

Expand All @@ -38,7 +40,7 @@ class IgnoredLeaksSet {
/// Maps name of the class, as returned by `object.runtimeType.toString()`,
/// to the number of instances of the class that are allowed to leak.
///
/// If number of instances is [null], all leaks are ignored.
/// If number of instances is `null`, all leaks are ignored.
final Map<String, int?> byClass;

/// If true, all leaks are ignored, otherwise [byClass] defines what is ignored.
Expand Down
4 changes: 2 additions & 2 deletions pkgs/leak_tracker/lib/src/usage_tracking/model.dart
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ class MemoryUsageEvent {

/// Difference with previouse rss value.
///
/// Equals to [null] for first event.
/// Equals to `null` for first event.
final int? delta;

/// Time since previous event.
///
/// Equals to [null] for first event.
/// Equals to `null` for first event.
late Duration? period;

/// RSS memory usage.
Expand Down
2 changes: 1 addition & 1 deletion pkgs/leak_tracker/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ dependencies:
vm_service: '>=11.10.0 <14.0.0'

dev_dependencies:
flutter_lints: ^3.0.0
layerlens: ^1.0.0
lints: ^3.0.0
test: ^1.16.0
Original file line number Diff line number Diff line change
Expand Up @@ -601,17 +601,18 @@ class _MockFinalizerWrapper implements FinalizerWrapper {
@override
void attach(Object object, Object finalizationToken, {Object? detach}) {
if (attached.containsValue(object)) {
throw '`attach` should not be invoked twice';
throw Exception('`attach` should not be invoked twice');
}
if (attached.containsKey(finalizationToken)) {
throw 'tokens should not duplicate';
throw Exception('tokens should not duplicate');
}
attached[finalizationToken as ObjectRecord] = object;
}

void finalize(Object finalizationToken) {
if (finalizationToken is! ObjectRecord) {
throw 'Unexpected type of token: ${finalizationToken.runtimeType}';
throw Exception(
'Unexpected type of token: ${finalizationToken.runtimeType}');
}
if (!attached.containsKey(finalizationToken)) return;
onGc(finalizationToken);
Expand Down
26 changes: 15 additions & 11 deletions pkgs/leak_tracker_flutter_testing/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,48 @@
# 1.0.10
## 1.0.11-wip

* Updated to use `package:lints/recommended.yaml` for analysis.

## 1.0.10

* Move LeakTesting out of this package to leak_tracker.
* Fix bug in equality for LeakTracking.

# 1.0.9
## 1.0.9

* Update `testWidgetsWithLeakTracking` to avoid duplicated leak tracking by testWidgets.

# 1.0.8
## 1.0.8

* Make configuration adjustable.

# 1.0.7
## 1.0.7

* Set version of leak_tracker_testing to `^1.0.5`.

# 1.0.6
## 1.0.6

* If an object is not disposed by the end of testing, mark it as notDisposed.

# 1.0.5
## 1.0.5

* Bump version of SDK to 3.1.2.

# 1.0.4
## 1.0.4

* Update matcher for memory events to handle async callbacks.

# 1.0.3
## 1.0.3

* Define matcher to verify if a class is reporting memory allocations.

# 1.0.2
## 1.0.2

* Add debugging constructors to LeakTrackingTestConfig, per leak type.

# 1.0.1
## 1.0.1

* Expose global leak tracking settings.

# 1.0.0
## 1.0.0

* First release.
13 changes: 12 additions & 1 deletion pkgs/leak_tracker_flutter_testing/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
include: ../leak_tracker/analysis_options.yaml
include: package:lints/recommended.yaml

analyzer:
language:
strict-casts: true
strict-inference: true

linter:
rules:
- avoid_catching_errors
- comment_references
- only_throw_errors
Loading

0 comments on commit fbc2014

Please sign in to comment.