Skip to content

Use package:pedantic as default package analysis ruleset. #492

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
Jan 24, 2019
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

* Link to package layout conventions in example-related suggestions.

* Use `package:pedantic` as default package analysis ruleset.

## 0.12.11

* Maintenance score penalty for:
Expand Down
25 changes: 13 additions & 12 deletions lib/src/analysis_options.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,20 @@ import 'dart:convert';
import 'package:yaml/yaml.dart' as yaml;

const String _analysisOptions = '''
# Source of linter options:
# https://dart-lang.github.io/linter/lints/options/options.html
# Defines a default set of lint rules enforced for
# projects at Google. For details and rationale,
# see https://github.com/dart-lang/pedantic#enabled-lints.
include: package:pedantic/analysis_options.yaml

linter:
rules:
- camel_case_types
- cancel_subscriptions
- hash_and_equals
- iterable_contains_unrelated_type
- list_remove_unrelated_type
- test_types_in_equals
- unrelated_type_equality_checks
- valid_regexps
# For lint rules and documentation, see http://dart-lang.github.io/linter/lints.
# Uncomment to specify additional rules.
# linter:
# rules:
# - camel_case_types

# analyzer:
# exclude:
# - path/to/excluded/files/**
''';

// Keep it updated with
Expand Down
8 changes: 8 additions & 0 deletions lib/src/pkg_resolution.dart
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,14 @@ List<PkgDependency> _buildDeps(Pubspec pubspec,
}
});

// We are adding pedantic to the dev_dependencies before running `pub upgrade`.
// If the package does not reference it directly, we should remove it from the
// analysis.
if (!pubspec.dependencies.containsKey('pedantic') &&
!pubspec.devDependencies.containsKey('pedantic')) {
deps.removeWhere((p) => p.package == 'pedantic');
}

deps.sort((a, b) => a.package.compareTo(b.package));
return deps;
}
Expand Down
1 change: 1 addition & 0 deletions lib/src/sdk_env.dart
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@ class ToolEnvironment {
final parsed = yamlToJson(original);
parsed.remove('dev_dependencies');
parsed.remove('dependency_overrides');
parsed['dev_dependencies'] = {'pedantic': '^1.0.0'};

await pubspec.rename(backup.path);
await pubspec.writeAsString(json.encode(parsed));
Expand Down
39 changes: 3 additions & 36 deletions test/analysis_options_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,7 @@ import 'package:pana/src/analysis_options.dart';
void main() {
test('default options', () {
expect(json.decode(customizeAnalysisOptions(null, false)), {
'linter': {
'rules': [
'camel_case_types',
'cancel_subscriptions',
'hash_and_equals',
'iterable_contains_unrelated_type',
'list_remove_unrelated_type',
'test_types_in_equals',
'unrelated_type_equality_checks',
'valid_regexps',
]
},
'include': 'package:pedantic/analysis_options.yaml',
});
});

Expand Down Expand Up @@ -73,21 +62,10 @@ analyzer:
todo: ignore
''';
expect(json.decode(customizeAnalysisOptions(original, false)), {
'include': 'package:pedantic/analysis_options.yaml',
'analyzer': {
'errors': {},
},
'linter': {
'rules': [
'camel_case_types',
'cancel_subscriptions',
'hash_and_equals',
'iterable_contains_unrelated_type',
'list_remove_unrelated_type',
'test_types_in_equals',
'unrelated_type_equality_checks',
'valid_regexps',
],
},
});
});

Expand All @@ -98,23 +76,12 @@ analyzer:
uri_has_not_been_generated: ignore
''';
expect(json.decode(customizeAnalysisOptions(original, false)), {
'include': 'package:pedantic/analysis_options.yaml',
'analyzer': {
'errors': {
'uri_has_not_been_generated': 'ignore',
},
},
'linter': {
'rules': [
'camel_case_types',
'cancel_subscriptions',
'hash_and_equals',
'iterable_contains_unrelated_type',
'list_remove_unrelated_type',
'test_types_in_equals',
'unrelated_type_equality_checks',
'valid_regexps',
],
},
});
});
}
129 changes: 15 additions & 114 deletions test/end2end/angular_components-0.10.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"resolveProcessFailed": false,
"analyzerErrorCount": 0,
"analyzerWarningCount": 0,
"analyzerHintCount": 102,
"analyzerHintCount": 92,
"platformConflictCount": 0,
"suggestions": [
{
Expand Down Expand Up @@ -93,9 +93,9 @@
{
"code": "bulk",
"level": "hint",
"title": "Fix additional 42 files with analysis or formatting issues.",
"description": "Additional issues in the following files:\n\n- `lib/material_input/material_auto_suggest_input.dart` (5 hints)\n- `lib/material_input/material_input_multiline.dart` (5 hints)\n- `lib/material_stepper/material_step.dart` (5 hints)\n- `lib/material_input/material_input.dart` (4 hints)\n- `lib/model/menu/menu.dart` (4 hints)\n- `lib/src/model/selection/single_selection_model_impl.dart` (4 hints)\n- `lib/laminate/ruler/module.dart` (3 hints)\n- `lib/model/selection/selection_container.dart` (3 hints)\n- `lib/laminate/overlay/module.dart` (2 hints)\n- `lib/laminate/portal/portal.dart` (2 hints)\n- `lib/material_menu/menu_item_groups.dart` (2 hints)\n- `lib/model/date/time_zone_aware_clock.dart` (2 hints)\n- `lib/src/utils/angular/managed_zone/managed_zone.dart` (2 hints)\n- `lib/utils/angular/reference/reference.dart` (2 hints)\n- `lib/utils/comparators/comparators.dart` (2 hints)\n- `lib/dynamic_component/dynamic_component.dart` (1 hint)\n- `lib/material_datepicker/date_input.dart` (1 hint)\n- `lib/material_datepicker/date_range_editor.dart` (1 hint)\n- `lib/material_datepicker/material_calendar_picker.dart` (1 hint)\n- `lib/material_datepicker/material_date_grid_base.dart` (1 hint)\n- `lib/material_datepicker/module.dart` (1 hint)\n- `lib/material_input/base_material_input.dart` (1 hint)\n- `lib/material_menu/menu_popup_wrapper.dart` (1 hint)\n- `lib/material_popup/material_popup.dart` (1 hint)\n- `lib/material_select/dropdown_button.dart` (1 hint)\n- `lib/material_select/material_select.dart` (1 hint)\n- `lib/material_select/material_select_dropdown_item.dart` (1 hint)\n- `lib/material_stepper/material_stepper.dart` (1 hint)\n- `lib/mixins/highlight_assistant_mixin.dart` (1 hint)\n- `lib/model/date/date.dart` (1 hint)\n- `lib/model/menu/selectable_menu.dart` (1 hint)\n- `lib/src/laminate/popup/popup_hierarchy.dart` (1 hint)\n- `lib/src/material_datepicker/calendar/model.dart` (1 hint)\n- `lib/src/material_tree/material_tree_root.dart` (1 hint)\n- `lib/src/utils/angular/scroll_host/pan_controller_impl.dart` (1 hint)\n- `lib/src/utils/angular/scroll_host/position_sticky_controller.dart` (1 hint)\n- `lib/src/utils/angular/scroll_host/sticky_controller_impl.dart` (1 hint)\n- `lib/src/utils/async/simple_stream.dart` (1 hint)\n- `lib/utils/angular/managed_zone/interface.dart` (1 hint)\n- `lib/utils/angular/scroll_host/angular_2.dart` (1 hint)\n- `lib/utils/browser/dom_service/dom_service.dart` (1 hint)\n- `lib/utils/browser/events/events.dart` (1 hint)\n",
"score": 36.89
"title": "Fix additional 33 files with analysis or formatting issues.",
"description": "Additional issues in the following files:\n\n- `lib/material_input/material_auto_suggest_input.dart` (5 hints)\n- `lib/material_input/material_input_multiline.dart` (5 hints)\n- `lib/material_stepper/material_step.dart` (5 hints)\n- `lib/material_input/material_input.dart` (4 hints)\n- `lib/model/menu/menu.dart` (4 hints)\n- `lib/src/model/selection/single_selection_model_impl.dart` (4 hints)\n- `lib/laminate/ruler/module.dart` (3 hints)\n- `lib/model/selection/selection_container.dart` (3 hints)\n- `lib/laminate/overlay/module.dart` (2 hints)\n- `lib/laminate/portal/portal.dart` (2 hints)\n- `lib/material_menu/menu_item_groups.dart` (2 hints)\n- `lib/model/date/time_zone_aware_clock.dart` (2 hints)\n- `lib/src/utils/angular/managed_zone/managed_zone.dart` (2 hints)\n- `lib/utils/angular/reference/reference.dart` (2 hints)\n- `lib/dynamic_component/dynamic_component.dart` (1 hint)\n- `lib/material_datepicker/date_input.dart` (1 hint)\n- `lib/material_datepicker/date_range_editor.dart` (1 hint)\n- `lib/material_datepicker/module.dart` (1 hint)\n- `lib/material_input/base_material_input.dart` (1 hint)\n- `lib/material_menu/menu_popup_wrapper.dart` (1 hint)\n- `lib/material_popup/material_popup.dart` (1 hint)\n- `lib/material_select/dropdown_button.dart` (1 hint)\n- `lib/material_select/material_select.dart` (1 hint)\n- `lib/material_select/material_select_dropdown_item.dart` (1 hint)\n- `lib/material_stepper/material_stepper.dart` (1 hint)\n- `lib/mixins/highlight_assistant_mixin.dart` (1 hint)\n- `lib/model/menu/selectable_menu.dart` (1 hint)\n- `lib/src/laminate/popup/popup_hierarchy.dart` (1 hint)\n- `lib/src/material_tree/material_tree_root.dart` (1 hint)\n- `lib/utils/angular/managed_zone/interface.dart` (1 hint)\n- `lib/utils/angular/scroll_host/angular_2.dart` (1 hint)\n- `lib/utils/browser/dom_service/dom_service.dart` (1 hint)\n- `lib/utils/browser/events/events.dart` (1 hint)\n",
"score": 31.89
}
]
},
Expand Down Expand Up @@ -204,7 +204,7 @@
"package": "built_value",
"dependencyType": "transitive",
"constraintType": "inherited",
"resolved": "6.2.0"
"resolved": "6.3.0"
},
{
"package": "charcode",
Expand Down Expand Up @@ -388,7 +388,7 @@
"constraintType": "normal",
"constraint": "^0.10.2",
"resolved": "0.10.8",
"available": "0.12.0"
"available": "0.13.0"
},
{
"package": "pub_semver",
Expand Down Expand Up @@ -11139,17 +11139,7 @@
"uri": "package:angular_components/material_datepicker/material_calendar_picker.dart",
"size": 31550,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "hash_and_equals",
"file": "lib/material_datepicker/material_calendar_picker.dart",
"line": 947,
"col": 17,
"description": "Always override `hashCode` if overriding `==`."
}
],
"codeProblems": [],
"directLibs": [
"dart:async",
"dart:html",
Expand Down Expand Up @@ -11407,17 +11397,7 @@
"uri": "package:angular_components/material_datepicker/material_date_grid_base.dart",
"size": 10402,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "cancel_subscriptions",
"file": "lib/material_datepicker/material_date_grid_base.dart",
"line": 125,
"col": 22,
"description": "Cancel instances of dart.async.StreamSubscription."
}
],
"codeProblems": [],
"directLibs": [
"dart:async",
"dart:html",
Expand Down Expand Up @@ -31429,17 +31409,7 @@
"uri": "package:angular_components/model/date/date.dart",
"size": 9786,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "hash_and_equals",
"file": "lib/model/date/date.dart",
"line": 105,
"col": 11,
"description": "Always override `hashCode` if overriding `==`."
}
],
"codeProblems": [],
"directLibs": [
"dart:async",
"package:angular_components/model/observable/observable.dart",
Expand Down Expand Up @@ -34413,17 +34383,7 @@
"uri": "package:angular_components/src/material_datepicker/calendar/model.dart",
"size": 13766,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "hash_and_equals",
"file": "lib/src/material_datepicker/calendar/model.dart",
"line": 351,
"col": 17,
"description": "Always override `hashCode` if overriding `==`."
}
]
"codeProblems": []
},
"lib/src/material_datepicker/calendar/month.dart": {
"uri": "package:angular_components/src/material_datepicker/calendar/month.dart",
Expand Down Expand Up @@ -34887,33 +34847,13 @@
"uri": "package:angular_components/src/utils/angular/scroll_host/pan_controller_impl.dart",
"size": 7342,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "hash_and_equals",
"file": "lib/src/utils/angular/scroll_host/pan_controller_impl.dart",
"line": 240,
"col": 17,
"description": "Always override `hashCode` if overriding `==`."
}
]
"codeProblems": []
},
"lib/src/utils/angular/scroll_host/position_sticky_controller.dart": {
"uri": "package:angular_components/src/utils/angular/scroll_host/position_sticky_controller.dart",
"size": 8531,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "cancel_subscriptions",
"file": "lib/src/utils/angular/scroll_host/position_sticky_controller.dart",
"line": 241,
"col": 49,
"description": "Cancel instances of dart.async.StreamSubscription."
}
]
"codeProblems": []
},
"lib/src/utils/angular/scroll_host/scroll_host_base.dart": {
"uri": "package:angular_components/src/utils/angular/scroll_host/scroll_host_base.dart",
Expand Down Expand Up @@ -34943,17 +34883,7 @@
"uri": "package:angular_components/src/utils/angular/scroll_host/sticky_controller_impl.dart",
"size": 19097,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "hash_and_equals",
"file": "lib/src/utils/angular/scroll_host/sticky_controller_impl.dart",
"line": 376,
"col": 17,
"description": "Always override `hashCode` if overriding `==`."
}
]
"codeProblems": []
},
"lib/src/utils/async/async_update_scheduler.dart": {
"uri": "package:angular_components/src/utils/async/async_update_scheduler.dart",
Expand Down Expand Up @@ -35001,17 +34931,7 @@
"uri": "package:angular_components/src/utils/async/simple_stream.dart",
"size": 13694,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "cancel_subscriptions",
"file": "lib/src/utils/async/simple_stream.dart",
"line": 173,
"col": 11,
"description": "Cancel instances of dart.async.StreamSubscription."
}
]
"codeProblems": []
},
"lib/src/utils/async/throttle_stream.dart": {
"uri": "package:angular_components/src/utils/async/throttle_stream.dart",
Expand Down Expand Up @@ -37774,26 +37694,7 @@
"uri": "package:angular_components/utils/comparators/comparators.dart",
"size": 1205,
"isFormatted": true,
"codeProblems": [
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "hash_and_equals",
"file": "lib/utils/comparators/comparators.dart",
"line": 17,
"col": 17,
"description": "Always override `hashCode` if overriding `==`."
},
{
"severity": "INFO",
"errorType": "LINT",
"errorCode": "hash_and_equals",
"file": "lib/utils/comparators/comparators.dart",
"line": 33,
"col": 17,
"description": "Always override `hashCode` if overriding `==`."
}
],
"codeProblems": [],
"directLibs": [],
"transitiveLibs": [],
"platform": {
Expand Down
Loading