Robert Nystrom
732b07a42b
I'm still chasing down a couple of google3 failures, but this is ready for review so that I can get it approved and land it once the last couple of failures are fixed. Here is who I think should review what: athom@ for: - DEPS johnniwinther@ for: - pkg/_fe_analyzer_shared - pkg/front_end - pkg/kernel brianwilkerson@ for: - pkg/analysis_server - pkg/analyzer_plugin - pkg/analyzer_utilities kenzieschmoll@ for: - pkg/dartdev pquitslund@ for: - pkg/linter/lib/src/lint_codes.g.dart If you're not the right person, feel free to summon someone else. Most of the changes here are re-running code generators that auto-format the code they generate. The changes are: Roll in the latest dart_style commit: - DEPS Manually updated these test expectations to expect the new style: - pkg/analysis_server/test/lsp/format_test.dart - pkg/analysis_server/test/services/refactoring/agnostic/change_method_signature_test.dart - pkg/analysis_server/test/src/domains/flutter/set_property_value_test.dart - pkg/analysis_server/test/src/services/flutter/container_properties_test.dart - pkg/analysis_server/test/src/services/flutter/widget_descriptions_test.dart - pkg/analysis_server/test/src/services/refactoring/convert_selected_formal_parameters_to_named_test.dart - pkg/analysis_server/test/src/services/refactoring/move_selected_formal_parameters_left_test.dart This was auto-generated by something, but I'm not sure why it thinks there is a diff: - pkg/analyzer_plugin/doc/api.html Updated to require a version of dart_style that accepts a language version in DartFormatter(): - pkg/analyzer_plugin/pubspec.yaml Updated to always use the latest language version (and thus new style) when invoking the formatter: - pkg/analyzer_utilities/lib/tools.dart Manually updated the formatting in the code templates so that they matched the formatting expected by the tests, which implicitly format using the latest language version: - pkg/dartdev/lib/src/templates/... The rest are all generated files that are formatted so re-generated using the new style: - pkg/_fe_analyzer_shared/lib/src/experiments/flags.dart - pkg/_fe_analyzer_shared/lib/src/messages/codes_generated.dart - pkg/analysis_server_client/lib/handler/notification_handler.dart - pkg/analysis_server_client/lib/src/protocol/... - pkg/analysis_server/lib/protocol/protocol_generated.dart - pkg/analysis_server/test/integration/support/integration_test_methods.dart - pkg/analysis_server/test/integration/support/protocol_matchers.dart - pkg/analyzer_plugin/lib/protocol/... - pkg/analyzer_plugin/test/integration/support/integration_test_methods.dart - pkg/analyzer_plugin/test/integration/support/protocol_matchers.dart - pkg/analyzer/lib/src/analysis_options/error/option_codes.g.dart - pkg/analyzer/lib/src/dart/error/... - pkg/analyzer/lib/src/error/codes.g.dart - pkg/analyzer/lib/src/manifest/manifest_warning_code.g.dart - pkg/analyzer/lib/src/pubspec/pubspec_warning_code.g.dart - pkg/analyzer/lib/src/summary/format.dart - pkg/analyzer/lib/src/wolf/ir/ir.g.dart - pkg/compiler/test/tool/graph_isomorphizer/golden/less_simple/lib_000_1.dart - pkg/compiler/test/tool/graph_isomorphizer/golden/less_simple/lib_001_0.dart - pkg/compiler/test/tool/graph_isomorphizer/golden/less_simple/lib_010_0.dart - pkg/compiler/test/tool/graph_isomorphizer/golden/less_simple/lib_100_0.dart - pkg/compiler/test/tool/graph_isomorphizer/golden/simple/... - pkg/front_end/lib/src/api_prototype/experimental_flags_generated.dart - pkg/front_end/lib/src/codes/cfe_codes_generated.dart - pkg/front_end/lib/src/util/parser_ast_helper.dart - pkg/front_end/test/parser_test_listener.dart - pkg/front_end/test/parser_test_parser.dart - pkg/front_end/testcases/... - pkg/kernel/lib/src/coverage.dart generated - pkg/kernel/lib/src/equivalence.dart generated - pkg/linter/lib/src/lint_codes.g.dart Change-Id: Ice0141b763e63b84f54692cd19a442a0719673c6 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/391263 Commit-Queue: Bob Nystrom <rnystrom@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com> Reviewed-by: Johnni Winther <johnniwinther@google.com> Reviewed-by: Alexander Thomas <athom@google.com> Reviewed-by: Ben Konyi <bkonyi@google.com> Reviewed-by: Samuel Rawlins <srawlins@google.com> Reviewed-by: Phil Quitslund <pquitslund@google.com>
Linter for Dart
The Dart Linter package defines lint rules that identify and report on "lints" found in Dart code. Linting is performed by the Dart
analysis server and the dart analyze command in the Dart command-line tool.
Installing
The linter is bundled with the Dart SDK; if you have an updated Dart SDK already, you're done!
Usage
The linter gives you feedback to help you catch potential errors and keep your code in line with the published
Dart Style Guide. Enforceable lint rules (or "lints") are cataloged here and can be configured via an
analysis options file. The linter is run from within the dart analyze command-line tool shipped with the
Dart SDK. Assuming you have lints configured in an analysis_options.yaml file at the root of your project with these contents:
linter:
rules:
- annotate_overrides
- hash_and_equals
- prefer_is_not_empty
you could lint your package like this:
$ dart analyze .
and see any violations of the annotate_overrides, hash_and_equals, and prefer_is_not_empty rules in the console.
To help you choose the rules you want to enable for your package, we have provided a complete list of rules
with lints recommended by the Dart team collected in package:lints. Lints recommended for Flutter apps, packages,
and plugins are documented in package:flutter_lints.
If a specific lint warning should be ignored, it can be flagged with a comment. For example,
// ignore: camel_case_types
class whyOhWhy { }
tells the Dart analyzer to ignore this instance of the camel_case_types warning.
End-of-line comments are supported as well. The following communicates the same thing:
class whyOhWhy { // ignore: camel_case_types
To ignore a rule for an entire file, use the ignore_for_file comment flag. For example,
// ignore_for_file: camel_case_types
...
class whyOhWhy { }
tells the Dart analyzer to ignore all occurrences of the camel_case_types warning in this file.
As lints are treated the same as errors and warnings by the analyzer, their severity can similarly be configured in an options file. For example, an analysis options file that specifies
linter:
rules:
- camel_case_types
analyzer:
errors:
camel_case_types: error
tells the analyzer to treat camel_case_types lints as errors. For more on configuring analysis see the analysis option file docs.
Contributing
Feedback is greatly appreciated and contributions are welcome! Please read the contribution guidelines; mechanics of writing lints are covered here.
Features and bugs
Please file feature requests and bugs in the issue tracker.