mv analysis_options file (dart-lang/lints#129)
diff --git a/pkgs/lints/.github/workflows/validate.yml b/pkgs/lints/.github/workflows/validate.yml
index cc21693..f328fcb 100644
--- a/pkgs/lints/.github/workflows/validate.yml
+++ b/pkgs/lints/.github/workflows/validate.yml
@@ -7,27 +7,20 @@
branches: [ main ]
pull_request:
branches: [ main ]
-
- # Allows you to run this workflow manually from the Actions tab
- workflow_dispatch:
-
# Run weekly
schedule:
- cron: "0 0 * * 0"
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
+ - uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
- - name: Check for sources
- run: |
- filecount=`find lib -name '*.dart' | wc -l`
- if [ $filecount -ne 0 ] || [ -d "bin" ]
- then
- echo 'Dart sources are not allowed in this package!'
- exit 1
- fi
+ - run: dart pub get
+ - run: dart format --output=none --set-exit-if-changed .
+ - run: dart analyze --fatal-infos
+ - run: dart tool/validate_lib.dart
+ - run: dart tool/gen_docs.dart --verify
diff --git a/pkgs/lints/CHANGELOG.md b/pkgs/lints/CHANGELOG.md
index 20ed83c..17cb7c3 100644
--- a/pkgs/lints/CHANGELOG.md
+++ b/pkgs/lints/CHANGELOG.md
@@ -1,10 +1,11 @@
-## 2.1.1-dev
+## 2.1.1-wip
- Added the `analysis` and `lints` topics to the pubspec file.
+- Update the package's readme to include the lint rules that `package:lints/core.yaml` and `package:lints/recommended.yaml` include.
## 2.1.0
-- Updated SDK lower-bound to 3.0
+- Updated the SDK lower-bound to 3.0.
- Removed `always_require_non_null_named_parameters` from `recommended.yaml`
as it is only relevant in Dart pre 2.12 and with Dart 3.0, libraries can
no longer be opted back that far.
diff --git a/pkgs/lints/README.md b/pkgs/lints/README.md
index 801f8f5..c0d1a00 100644
--- a/pkgs/lints/README.md
+++ b/pkgs/lints/README.md
@@ -7,9 +7,12 @@
The Dart linter is a static analyzer for identifying possible problems in your
Dart source code. More than a hundred [linter rules][rules] are available,
checking anything from potential typing issues, coding style, and formatting.
-This package, `lints`, contains the lint settings recommended by the Dart team.
+This package - `package:lints` - contains the lint settings recommended by the
+Dart team.
-Two sets of Dart lints are available:
+## Lint sets
+
+This package includes two sets of lints:
* **Core lints**: Lints that help identify critical issues that are likely to
lead to problems when running or consuming Dart code. All code should pass these
@@ -20,8 +23,9 @@
writing Dart using a single, idiomatic style and format. All code is encouraged
to pass these lints. The recommended lints include all the core lints.
-Finally, a third set [`flutter_lints`](https://pub.dev/packages/flutter_lints)
-extends the recommended set with additional recommended Flutter-specific lints.
+Additionally, a third lint set -
+[`package:flutter_lints`](https://pub.dev/packages/flutter_lints) - extends the
+recommended set with additional recommended Flutter-specific lints. Documentation on that can be found at [github.com/flutter/packages](https://github.com/flutter/packages/tree/main/packages/flutter_lints).
## Where these lints are used
@@ -31,14 +35,11 @@
When uploading a package to the [pub.dev] package repository, packages are
[awarded pub points][scoring] based on how many of the 'core' lints pass.
-For documentation on the individual lints, see the [linter rules][rules] page on
-dart.dev.
+## Enabling the lints
-## How to enable these lints
+For new apps created with `dart create` the recommended set of lints are enabled by default.
-For new apps created with `dart create`, the lints are enabled by default.
-
-For existing apps or packages, take these steps to enable these lints:
+For existing apps or packages, you can enable these lints via:
1. In a terminal, located at the root of your package, run this command:
@@ -61,9 +62,8 @@
## Customizing the predefined lint sets
-You can customize the predefined lint sets, both to disable one or more of the
-lints included, or to add additional lints. For details see [customizing static
-analysis].
+For details on customizing static analysis above and beyond the predefined
+lint sets, see [customizing static analysis].
## Evolving the lint sets
@@ -81,6 +81,111 @@
3. The lists are updated and a new version of the package is published.
+## Lint set contents
+
+### Core lints
+
+To use these lints create an `analysis_options.yaml` file with:
+`include: package:lints/core.yaml`.
+
+<!-- core -->
+| Lint Rules | Description |
+| :--------- | :---------- |
+| [`avoid_empty_else`](https://dart.dev/lints/avoid_empty_else) | Avoid empty else statements. |
+| [`avoid_relative_lib_imports`](https://dart.dev/lints/avoid_relative_lib_imports) | Avoid relative imports for files in `lib/`. |
+| [`avoid_shadowing_type_parameters`](https://dart.dev/lints/avoid_shadowing_type_parameters) | Avoid shadowing type parameters. |
+| [`avoid_types_as_parameter_names`](https://dart.dev/lints/avoid_types_as_parameter_names) | Avoid types as parameter names. |
+| [`await_only_futures`](https://dart.dev/lints/await_only_futures) | Await only futures. |
+| [`camel_case_extensions`](https://dart.dev/lints/camel_case_extensions) | Name extensions using UpperCamelCase. |
+| [`camel_case_types`](https://dart.dev/lints/camel_case_types) | Name types using UpperCamelCase. |
+| [`curly_braces_in_flow_control_structures`](https://dart.dev/lints/curly_braces_in_flow_control_structures) | DO use curly braces for all flow control structures. |
+| [`depend_on_referenced_packages`](https://dart.dev/lints/depend_on_referenced_packages) | Depend on referenced packages. |
+| [`empty_catches`](https://dart.dev/lints/empty_catches) | Avoid empty catch blocks. |
+| [`file_names`](https://dart.dev/lints/file_names) | Name source files using `lowercase_with_underscores`. |
+| [`hash_and_equals`](https://dart.dev/lints/hash_and_equals) | Always override `hashCode` if overriding `==`. |
+| [`iterable_contains_unrelated_type`](https://dart.dev/lints/iterable_contains_unrelated_type) | Invocation of Iterable<E>.contains with references of unrelated types. |
+| [`list_remove_unrelated_type`](https://dart.dev/lints/list_remove_unrelated_type) | Invocation of `remove` with references of unrelated types. |
+| [`no_duplicate_case_values`](https://dart.dev/lints/no_duplicate_case_values) | Don't use more than one case with same value. |
+| [`non_constant_identifier_names`](https://dart.dev/lints/non_constant_identifier_names) | Name non-constant identifiers using lowerCamelCase. |
+| [`null_check_on_nullable_type_parameter`](https://dart.dev/lints/null_check_on_nullable_type_parameter) | Don't use null check on a potentially nullable type parameter. |
+| [`package_prefixed_library_names`](https://dart.dev/lints/package_prefixed_library_names) | Prefix library names with the package name and a dot-separated path. |
+| [`prefer_generic_function_type_aliases`](https://dart.dev/lints/prefer_generic_function_type_aliases) | Prefer generic function type aliases. |
+| [`prefer_is_empty`](https://dart.dev/lints/prefer_is_empty) | Use `isEmpty` for Iterables and Maps. |
+| [`prefer_is_not_empty`](https://dart.dev/lints/prefer_is_not_empty) | Use `isNotEmpty` for Iterables and Maps. |
+| [`prefer_iterable_whereType`](https://dart.dev/lints/prefer_iterable_whereType) | Prefer to use whereType on iterable. |
+| [`prefer_typing_uninitialized_variables`](https://dart.dev/lints/prefer_typing_uninitialized_variables) | Prefer typing uninitialized variables and fields. |
+| [`provide_deprecation_message`](https://dart.dev/lints/provide_deprecation_message) | Provide a deprecation message, via @Deprecated("message"). |
+| [`unnecessary_overrides`](https://dart.dev/lints/unnecessary_overrides) | Don't override a method to do a super method invocation with the same parameters. |
+| [`unrelated_type_equality_checks`](https://dart.dev/lints/unrelated_type_equality_checks) | Equality operator `==` invocation with references of unrelated types. |
+| [`valid_regexps`](https://dart.dev/lints/valid_regexps) | Use valid regular expression syntax. |
+| [`void_checks`](https://dart.dev/lints/void_checks) | Don't assign to void. |
+<!-- core -->
+
+### Recommended lints
+
+To use these lints create an `analysis_options.yaml` file with:
+`include: package:lints/recommended.yaml`.
+
+<!-- recommended -->
+| Lint Rules | Description |
+| :--------- | :---------- |
+| [`annotate_overrides`](https://dart.dev/lints/annotate_overrides) | Annotate overridden members. |
+| [`avoid_function_literals_in_foreach_calls`](https://dart.dev/lints/avoid_function_literals_in_foreach_calls) | Avoid using `forEach` with a function literal. |
+| [`avoid_init_to_null`](https://dart.dev/lints/avoid_init_to_null) | Don't explicitly initialize variables to null. |
+| [`avoid_null_checks_in_equality_operators`](https://dart.dev/lints/avoid_null_checks_in_equality_operators) | Don't check for null in custom == operators. |
+| [`avoid_renaming_method_parameters`](https://dart.dev/lints/avoid_renaming_method_parameters) | Don't rename parameters of overridden methods. |
+| [`avoid_return_types_on_setters`](https://dart.dev/lints/avoid_return_types_on_setters) | Avoid return types on setters. |
+| [`avoid_returning_null_for_void`](https://dart.dev/lints/avoid_returning_null_for_void) | Avoid returning null for void. |
+| [`avoid_single_cascade_in_expression_statements`](https://dart.dev/lints/avoid_single_cascade_in_expression_statements) | Avoid single cascade in expression statements. |
+| [`constant_identifier_names`](https://dart.dev/lints/constant_identifier_names) | Prefer using lowerCamelCase for constant names. |
+| [`control_flow_in_finally`](https://dart.dev/lints/control_flow_in_finally) | Avoid control flow in finally blocks. |
+| [`empty_constructor_bodies`](https://dart.dev/lints/empty_constructor_bodies) | Use `;` instead of `{}` for empty constructor bodies. |
+| [`empty_statements`](https://dart.dev/lints/empty_statements) | Avoid empty statements. |
+| [`exhaustive_cases`](https://dart.dev/lints/exhaustive_cases) | Define case clauses for all constants in enum-like classes. |
+| [`implementation_imports`](https://dart.dev/lints/implementation_imports) | Don't import implementation files from another package. |
+| [`library_names`](https://dart.dev/lints/library_names) | Name libraries using `lowercase_with_underscores`. |
+| [`library_prefixes`](https://dart.dev/lints/library_prefixes) | Use `lowercase_with_underscores` when specifying a library prefix. |
+| [`library_private_types_in_public_api`](https://dart.dev/lints/library_private_types_in_public_api) | Avoid using private types in public APIs. |
+| [`no_leading_underscores_for_library_prefixes`](https://dart.dev/lints/no_leading_underscores_for_library_prefixes) | Avoid leading underscores for library prefixes. |
+| [`no_leading_underscores_for_local_identifiers`](https://dart.dev/lints/no_leading_underscores_for_local_identifiers) | Avoid leading underscores for local identifiers. |
+| [`null_closures`](https://dart.dev/lints/null_closures) | Do not pass `null` as an argument where a closure is expected. |
+| [`overridden_fields`](https://dart.dev/lints/overridden_fields) | Don't override fields. |
+| [`package_names`](https://dart.dev/lints/package_names) | Use `lowercase_with_underscores` for package names. |
+| [`prefer_adjacent_string_concatenation`](https://dart.dev/lints/prefer_adjacent_string_concatenation) | Use adjacent strings to concatenate string literals. |
+| [`prefer_collection_literals`](https://dart.dev/lints/prefer_collection_literals) | Use collection literals when possible. |
+| [`prefer_conditional_assignment`](https://dart.dev/lints/prefer_conditional_assignment) | Prefer using `??=` over testing for null. |
+| [`prefer_contains`](https://dart.dev/lints/prefer_contains) | Use contains for `List` and `String` instances. |
+| [`prefer_equal_for_default_values`](https://dart.dev/lints/prefer_equal_for_default_values) | Use `=` to separate a named parameter from its default value. |
+| [`prefer_final_fields`](https://dart.dev/lints/prefer_final_fields) | Private field could be final. |
+| [`prefer_for_elements_to_map_fromIterable`](https://dart.dev/lints/prefer_for_elements_to_map_fromIterable) | Prefer 'for' elements when building maps from iterables. |
+| [`prefer_function_declarations_over_variables`](https://dart.dev/lints/prefer_function_declarations_over_variables) | Use a function declaration to bind a function to a name. |
+| [`prefer_if_null_operators`](https://dart.dev/lints/prefer_if_null_operators) | Prefer using if null operators. |
+| [`prefer_initializing_formals`](https://dart.dev/lints/prefer_initializing_formals) | Use initializing formals when possible. |
+| [`prefer_inlined_adds`](https://dart.dev/lints/prefer_inlined_adds) | Inline list item declarations where possible. |
+| [`prefer_interpolation_to_compose_strings`](https://dart.dev/lints/prefer_interpolation_to_compose_strings) | Use interpolation to compose strings and values. |
+| [`prefer_is_not_operator`](https://dart.dev/lints/prefer_is_not_operator) | Prefer is! operator. |
+| [`prefer_null_aware_operators`](https://dart.dev/lints/prefer_null_aware_operators) | Prefer using null aware operators. |
+| [`prefer_spread_collections`](https://dart.dev/lints/prefer_spread_collections) | Use spread collections when possible. |
+| [`prefer_void_to_null`](https://dart.dev/lints/prefer_void_to_null) | Don't use the Null type, unless you are positive that you don't want void. |
+| [`recursive_getters`](https://dart.dev/lints/recursive_getters) | Property getter recursively returns itself. |
+| [`slash_for_doc_comments`](https://dart.dev/lints/slash_for_doc_comments) | Prefer using /// for doc comments. |
+| [`type_init_formals`](https://dart.dev/lints/type_init_formals) | Don't type annotate initializing formals. |
+| [`unnecessary_brace_in_string_interps`](https://dart.dev/lints/unnecessary_brace_in_string_interps) | Avoid using braces in interpolation when not needed. |
+| [`unnecessary_const`](https://dart.dev/lints/unnecessary_const) | Avoid const keyword. |
+| [`unnecessary_constructor_name`](https://dart.dev/lints/unnecessary_constructor_name) | Unnecessary `.new` constructor name. |
+| [`unnecessary_getters_setters`](https://dart.dev/lints/unnecessary_getters_setters) | Avoid wrapping fields in getters and setters just to be "safe". |
+| [`unnecessary_late`](https://dart.dev/lints/unnecessary_late) | Don't specify the `late` modifier when it is not needed. |
+| [`unnecessary_new`](https://dart.dev/lints/unnecessary_new) | Unnecessary new keyword. |
+| [`unnecessary_null_aware_assignments`](https://dart.dev/lints/unnecessary_null_aware_assignments) | Avoid null in null-aware assignment. |
+| [`unnecessary_null_in_if_null_operators`](https://dart.dev/lints/unnecessary_null_in_if_null_operators) | Avoid using `null` in `if null` operators. |
+| [`unnecessary_nullable_for_final_variable_declarations`](https://dart.dev/lints/unnecessary_nullable_for_final_variable_declarations) | Use a non-nullable type for a final variable initialized with a non-nullable value. |
+| [`unnecessary_string_escapes`](https://dart.dev/lints/unnecessary_string_escapes) | Remove unnecessary backslashes in strings. |
+| [`unnecessary_string_interpolations`](https://dart.dev/lints/unnecessary_string_interpolations) | Unnecessary string interpolation. |
+| [`unnecessary_this`](https://dart.dev/lints/unnecessary_this) | Don't access members with `this` unless avoiding shadowing. |
+| [`use_function_type_syntax_for_parameters`](https://dart.dev/lints/use_function_type_syntax_for_parameters) | Use generic function type syntax for parameters. |
+| [`use_rethrow_when_possible`](https://dart.dev/lints/use_rethrow_when_possible) | Use rethrow to rethrow a caught exception. |
+<!-- recommended -->
+
[dart create]: https://dart.dev/tools/dart-tool
[scoring]: https://pub.dev/help/scoring
[customizing static analysis]: https://dart.dev/guides/language/analysis-options
diff --git a/pkgs/lints/pubspec.yaml b/pkgs/lints/pubspec.yaml
index 0a99140..7ead4e3 100644
--- a/pkgs/lints/pubspec.yaml
+++ b/pkgs/lints/pubspec.yaml
@@ -1,5 +1,5 @@
name: lints
-version: 2.1.1-dev
+version: 2.1.1-wip
description: >
Official Dart lint rules. Defines the 'core' and 'recommended' set of lints
suggested by the Dart team.
@@ -10,8 +10,13 @@
- lints
environment:
- sdk: ^3.0.0-417
+ sdk: ^3.0.0
-# NOTE: Code is not allowed in this package. Do not add dependencies.
+# NOTE: Code is not allowed in this package - do not add dependencies.
# dependencies:
-# dev_dependencies:
+
+dev_dependencies:
+ collection: ^1.17.0
+ http: ^1.0.0
+ path: ^1.8.0
+ yaml: ^3.1.0
diff --git a/pkgs/lints/tool/README.md b/pkgs/lints/tool/README.md
new file mode 100644
index 0000000..2a95cc7
--- /dev/null
+++ b/pkgs/lints/tool/README.md
@@ -0,0 +1,25 @@
+
+## `tool/validate_lib.dart`
+
+This tool ensures that we don't commit `.dart` source files into the lib/
+directory; it's automatically run by the CI. To run manually:
+
+```
+dart tool/validate_lib.dart
+```
+
+## `tool/gen_docs.dart`
+
+This tool regenerates the lists of core and recommended lints into the package's
+README.md file. To use it, run:
+
+```
+dart tool/gen_docs.dart
+```
+
+It can also validate that the readme file is up-to-date. It's automatically
+run by the CI; to run it manually:
+
+```
+dart tool/gen_docs.dart --verify
+```
diff --git a/pkgs/lints/tool/analysis_options.yaml b/pkgs/lints/tool/analysis_options.yaml
new file mode 100644
index 0000000..505a0b7
--- /dev/null
+++ b/pkgs/lints/tool/analysis_options.yaml
@@ -0,0 +1 @@
+include: ../lib/recommended.yaml
diff --git a/pkgs/lints/tool/gen_docs.dart b/pkgs/lints/tool/gen_docs.dart
new file mode 100644
index 0000000..2a554c8
--- /dev/null
+++ b/pkgs/lints/tool/gen_docs.dart
@@ -0,0 +1,108 @@
+// Copyright (c) 2023, 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 'dart:convert';
+import 'dart:io';
+
+import 'package:collection/collection.dart';
+import 'package:path/path.dart' as p;
+import 'package:yaml/yaml.dart' as yaml;
+import 'package:http/http.dart' as http;
+
+void main(List<String> args) async {
+ final justVerify = args.isNotEmpty;
+ final lintRules = <String, List<String>>{};
+
+ final rulesJsonFile = File('tool/rules.json');
+ final rulesUrl =
+ 'https://dart-lang.github.io/linter/lints/machine/rules.json';
+ if (!justVerify) {
+ rulesJsonFile.writeAsStringSync((await http.get(Uri.parse(rulesUrl))).body);
+ }
+ final rulesJson = (jsonDecode(rulesJsonFile.readAsStringSync()) as List)
+ .cast<Map<String, dynamic>>();
+
+ final readmeFile = File('README.md');
+ final readmeContent = readmeFile.readAsStringSync();
+
+ if (justVerify) {
+ print('Validating that ${readmeFile.path} is up-to-date ...');
+ } else {
+ print('Regenerating ${readmeFile.path} ...');
+ }
+
+ for (var file in ['lib/core.yaml', 'lib/recommended.yaml']) {
+ var name = p.basenameWithoutExtension(file);
+ lintRules[name] = _parseRules(File(file));
+ }
+
+ var newContent = readmeContent;
+
+ for (var ruleSetName in lintRules.keys) {
+ final comment = '<!-- $ruleSetName -->\n';
+
+ newContent = newContent.replaceRange(
+ newContent.indexOf(comment) + comment.length,
+ newContent.lastIndexOf(comment),
+ _createRuleTable(lintRules[ruleSetName]!, rulesJson),
+ );
+ }
+
+ if (justVerify) {
+ if (newContent != readmeContent) {
+ print('${readmeFile.path} is not up-to-date (lint tables need to be '
+ 'regenerated).');
+ print('');
+ print("Run 'dart tools/gen_docs.dart' to re-generate.");
+ exit(1);
+ } else {
+ print('${readmeFile.path} is up-to-date.');
+ }
+ } else {
+ // Re-save rules.json.
+ const retainKeys = {'name', 'description'};
+ for (var rule in rulesJson) {
+ rule.removeWhere((key, value) => !retainKeys.contains(key));
+ }
+ rulesJsonFile
+ .writeAsStringSync(JsonEncoder.withIndent(' ').convert(rulesJson));
+
+ // Write out the readme file.
+ readmeFile.writeAsStringSync(newContent);
+ print('Wrote ${readmeFile.path}.');
+ }
+}
+
+List<String> _parseRules(File yamlFile) {
+ var yamlData = yaml.loadYaml(yamlFile.readAsStringSync()) as Map;
+ return (yamlData['linter']['rules'] as List).toList().cast<String>();
+}
+
+String _createRuleTable(
+ List<String> rules, List<Map<String, dynamic>> lintMeta) {
+ rules.sort();
+
+ final lines = [
+ '| Lint Rules | Description |',
+ '| :--------- | :---------- |',
+ ...rules.map((rule) {
+ final ruleMeta =
+ lintMeta.firstWhereOrNull((meta) => meta['name'] == rule);
+
+ if (ruleMeta == null) {
+ print('rules.json data for rule \'$rule\' not found.');
+ print(
+ 'Update lib/rules.json from '
+ 'https://github.com/dart-lang/linter/blob/gh-pages/lints/machine/rules.json.',
+ );
+ exit(1);
+ }
+ final description = ruleMeta['description'] as String?;
+
+ return '| [`$rule`](https://dart.dev/lints/$rule) | $description |';
+ }),
+ ];
+
+ return '${lines.join('\n')}\n';
+}
diff --git a/pkgs/lints/tool/rules.json b/pkgs/lints/tool/rules.json
new file mode 100644
index 0000000..b70a735
--- /dev/null
+++ b/pkgs/lints/tool/rules.json
@@ -0,0 +1,910 @@
+[
+ {
+ "name": "always_use_package_imports",
+ "description": "Avoid relative imports for files in `lib/`."
+ },
+ {
+ "name": "avoid_dynamic_calls",
+ "description": "Avoid method calls or property accesses on a \"dynamic\" target."
+ },
+ {
+ "name": "avoid_empty_else",
+ "description": "Avoid empty else statements."
+ },
+ {
+ "name": "avoid_print",
+ "description": "Avoid `print` calls in production code."
+ },
+ {
+ "name": "avoid_relative_lib_imports",
+ "description": "Avoid relative imports for files in `lib/`."
+ },
+ {
+ "name": "avoid_returning_null_for_future",
+ "description": "Avoid returning null for Future."
+ },
+ {
+ "name": "avoid_slow_async_io",
+ "description": "Avoid slow async `dart:io` methods."
+ },
+ {
+ "name": "avoid_type_to_string",
+ "description": "Avoid <Type>.toString() in production code since results may be minified."
+ },
+ {
+ "name": "avoid_types_as_parameter_names",
+ "description": "Avoid types as parameter names."
+ },
+ {
+ "name": "avoid_web_libraries_in_flutter",
+ "description": "Avoid using web-only libraries outside Flutter web plugin packages."
+ },
+ {
+ "name": "cancel_subscriptions",
+ "description": "Cancel instances of dart.async.StreamSubscription."
+ },
+ {
+ "name": "close_sinks",
+ "description": "Close instances of `dart.core.Sink`."
+ },
+ {
+ "name": "collection_methods_unrelated_type",
+ "description": "Invocation of various collection methods with arguments of unrelated types."
+ },
+ {
+ "name": "comment_references",
+ "description": "Only reference in scope identifiers in doc comments."
+ },
+ {
+ "name": "control_flow_in_finally",
+ "description": "Avoid control flow in finally blocks."
+ },
+ {
+ "name": "deprecated_member_use_from_same_package",
+ "description": "Avoid using deprecated elements from within the package in which they are declared."
+ },
+ {
+ "name": "diagnostic_describe_all_properties",
+ "description": "DO reference all public properties in debug methods."
+ },
+ {
+ "name": "discarded_futures",
+ "description": "Don't invoke asynchronous functions in non-async blocks."
+ },
+ {
+ "name": "empty_statements",
+ "description": "Avoid empty statements."
+ },
+ {
+ "name": "hash_and_equals",
+ "description": "Always override `hashCode` if overriding `==`."
+ },
+ {
+ "name": "implicit_reopen",
+ "description": "Don't implicitly reopen classes."
+ },
+ {
+ "name": "invalid_case_patterns",
+ "description": "Use case expressions that are valid in Dart 3.0."
+ },
+ {
+ "name": "invariant_booleans",
+ "description": "Conditions should not unconditionally evaluate to `true` or to `false`."
+ },
+ {
+ "name": "iterable_contains_unrelated_type",
+ "description": "Invocation of Iterable<E>.contains with references of unrelated types."
+ },
+ {
+ "name": "list_remove_unrelated_type",
+ "description": "Invocation of `remove` with references of unrelated types."
+ },
+ {
+ "name": "literal_only_boolean_expressions",
+ "description": "Boolean expression composed only with literals."
+ },
+ {
+ "name": "no_adjacent_strings_in_list",
+ "description": "Don't use adjacent strings in list."
+ },
+ {
+ "name": "no_duplicate_case_values",
+ "description": "Don't use more than one case with same value."
+ },
+ {
+ "name": "no_logic_in_create_state",
+ "description": "Don't put any logic in createState."
+ },
+ {
+ "name": "no_self_assignments",
+ "description": "Don't assign a variable to itself."
+ },
+ {
+ "name": "no_wildcard_variable_uses",
+ "description": "Don't use wildcard parameters or variables."
+ },
+ {
+ "name": "prefer_relative_imports",
+ "description": "Prefer relative imports for files in `lib/`."
+ },
+ {
+ "name": "prefer_void_to_null",
+ "description": "Don't use the Null type, unless you are positive that you don't want void."
+ },
+ {
+ "name": "test_types_in_equals",
+ "description": "Test type arguments in operator ==(Object other)."
+ },
+ {
+ "name": "throw_in_finally",
+ "description": "Avoid `throw` in finally block."
+ },
+ {
+ "name": "unnecessary_statements",
+ "description": "Avoid using unnecessary statements."
+ },
+ {
+ "name": "unrelated_type_equality_checks",
+ "description": "Equality operator `==` invocation with references of unrelated types."
+ },
+ {
+ "name": "unsafe_html",
+ "description": "Avoid unsafe HTML APIs."
+ },
+ {
+ "name": "use_build_context_synchronously",
+ "description": "Do not use BuildContexts across async gaps."
+ },
+ {
+ "name": "use_key_in_widget_constructors",
+ "description": "Use key in widget constructors."
+ },
+ {
+ "name": "valid_regexps",
+ "description": "Use valid regular expression syntax."
+ },
+ {
+ "name": "depend_on_referenced_packages",
+ "description": "Depend on referenced packages."
+ },
+ {
+ "name": "package_names",
+ "description": "Use `lowercase_with_underscores` for package names."
+ },
+ {
+ "name": "secure_pubspec_urls",
+ "description": "Use secure urls in `pubspec.yaml`."
+ },
+ {
+ "name": "sort_pub_dependencies",
+ "description": "Sort pub dependencies alphabetically."
+ },
+ {
+ "name": "always_declare_return_types",
+ "description": "Declare method return types."
+ },
+ {
+ "name": "always_put_control_body_on_new_line",
+ "description": "Separate the control structure expression from its statement."
+ },
+ {
+ "name": "always_put_required_named_parameters_first",
+ "description": "Put required named parameters first."
+ },
+ {
+ "name": "always_require_non_null_named_parameters",
+ "description": "Specify `@required` on named parameters without defaults."
+ },
+ {
+ "name": "always_specify_types",
+ "description": "Specify type annotations."
+ },
+ {
+ "name": "annotate_overrides",
+ "description": "Annotate overridden members."
+ },
+ {
+ "name": "avoid_annotating_with_dynamic",
+ "description": "Avoid annotating with dynamic when not required."
+ },
+ {
+ "name": "avoid_as",
+ "description": "Avoid using `as`."
+ },
+ {
+ "name": "avoid_bool_literals_in_conditional_expressions",
+ "description": "Avoid bool literals in conditional expressions."
+ },
+ {
+ "name": "avoid_catches_without_on_clauses",
+ "description": "Avoid catches without on clauses."
+ },
+ {
+ "name": "avoid_catching_errors",
+ "description": "Don't explicitly catch Error or types that implement it."
+ },
+ {
+ "name": "avoid_classes_with_only_static_members",
+ "description": "Avoid defining a class that contains only static members."
+ },
+ {
+ "name": "avoid_double_and_int_checks",
+ "description": "Avoid double and int checks."
+ },
+ {
+ "name": "avoid_equals_and_hash_code_on_mutable_classes",
+ "description": "Avoid overloading operator == and hashCode on classes not marked `@immutable`."
+ },
+ {
+ "name": "avoid_escaping_inner_quotes",
+ "description": "Avoid escaping inner quotes by converting surrounding quotes."
+ },
+ {
+ "name": "avoid_field_initializers_in_const_classes",
+ "description": "Avoid field initializers in const classes."
+ },
+ {
+ "name": "avoid_final_parameters",
+ "description": "Avoid final for parameter declarations."
+ },
+ {
+ "name": "avoid_function_literals_in_foreach_calls",
+ "description": "Avoid using `forEach` with a function literal."
+ },
+ {
+ "name": "avoid_implementing_value_types",
+ "description": "Don't implement classes that override `==`."
+ },
+ {
+ "name": "avoid_init_to_null",
+ "description": "Don't explicitly initialize variables to null."
+ },
+ {
+ "name": "avoid_js_rounded_ints",
+ "description": "Avoid JavaScript rounded ints."
+ },
+ {
+ "name": "avoid_multiple_declarations_per_line",
+ "description": "Don't declare multiple variables on a single line."
+ },
+ {
+ "name": "avoid_null_checks_in_equality_operators",
+ "description": "Don't check for null in custom == operators."
+ },
+ {
+ "name": "avoid_positional_boolean_parameters",
+ "description": "Avoid positional boolean parameters."
+ },
+ {
+ "name": "avoid_private_typedef_functions",
+ "description": "Avoid private typedef functions."
+ },
+ {
+ "name": "avoid_redundant_argument_values",
+ "description": "Avoid redundant argument values."
+ },
+ {
+ "name": "avoid_renaming_method_parameters",
+ "description": "Don't rename parameters of overridden methods."
+ },
+ {
+ "name": "avoid_return_types_on_setters",
+ "description": "Avoid return types on setters."
+ },
+ {
+ "name": "avoid_returning_null",
+ "description": "Avoid returning null from members whose return type is bool, double, int, or num."
+ },
+ {
+ "name": "avoid_returning_null_for_void",
+ "description": "Avoid returning null for void."
+ },
+ {
+ "name": "avoid_returning_this",
+ "description": "Avoid returning this from methods just to enable a fluent interface."
+ },
+ {
+ "name": "avoid_setters_without_getters",
+ "description": "Avoid setters without getters."
+ },
+ {
+ "name": "avoid_shadowing_type_parameters",
+ "description": "Avoid shadowing type parameters."
+ },
+ {
+ "name": "avoid_single_cascade_in_expression_statements",
+ "description": "Avoid single cascade in expression statements."
+ },
+ {
+ "name": "avoid_types_on_closure_parameters",
+ "description": "Avoid annotating types for function expression parameters."
+ },
+ {
+ "name": "avoid_unnecessary_containers",
+ "description": "Avoid unnecessary containers."
+ },
+ {
+ "name": "avoid_unused_constructor_parameters",
+ "description": "Avoid defining unused parameters in constructors."
+ },
+ {
+ "name": "avoid_void_async",
+ "description": "Avoid async functions that return void."
+ },
+ {
+ "name": "await_only_futures",
+ "description": "Await only futures."
+ },
+ {
+ "name": "camel_case_extensions",
+ "description": "Name extensions using UpperCamelCase."
+ },
+ {
+ "name": "camel_case_types",
+ "description": "Name types using UpperCamelCase."
+ },
+ {
+ "name": "cascade_invocations",
+ "description": "Cascade consecutive method invocations on the same reference."
+ },
+ {
+ "name": "cast_nullable_to_non_nullable",
+ "description": "Don't cast a nullable value to a non nullable type."
+ },
+ {
+ "name": "combinators_ordering",
+ "description": "Sort combinator names alphabetically."
+ },
+ {
+ "name": "conditional_uri_does_not_exist",
+ "description": "Missing conditional import."
+ },
+ {
+ "name": "constant_identifier_names",
+ "description": "Prefer using lowerCamelCase for constant names."
+ },
+ {
+ "name": "curly_braces_in_flow_control_structures",
+ "description": "DO use curly braces for all flow control structures."
+ },
+ {
+ "name": "dangling_library_doc_comments",
+ "description": "Attach library doc comments to library directives."
+ },
+ {
+ "name": "deprecated_consistency",
+ "description": "Missing deprecated annotation."
+ },
+ {
+ "name": "directives_ordering",
+ "description": "Adhere to Effective Dart Guide directives sorting conventions."
+ },
+ {
+ "name": "do_not_use_environment",
+ "description": "Do not use environment declared variables."
+ },
+ {
+ "name": "empty_catches",
+ "description": "Avoid empty catch blocks."
+ },
+ {
+ "name": "empty_constructor_bodies",
+ "description": "Use `;` instead of `{}` for empty constructor bodies."
+ },
+ {
+ "name": "enable_null_safety",
+ "description": "Do use sound null safety."
+ },
+ {
+ "name": "eol_at_end_of_file",
+ "description": "Put a single newline at end of file."
+ },
+ {
+ "name": "exhaustive_cases",
+ "description": "Define case clauses for all constants in enum-like classes."
+ },
+ {
+ "name": "file_names",
+ "description": "Name source files using `lowercase_with_underscores`."
+ },
+ {
+ "name": "flutter_style_todos",
+ "description": "Use Flutter TODO format: // TODO(username): message, https://URL-to-issue."
+ },
+ {
+ "name": "implementation_imports",
+ "description": "Don't import implementation files from another package."
+ },
+ {
+ "name": "implicit_call_tearoffs",
+ "description": "Explicitly tear-off `call` methods when using an object as a Function."
+ },
+ {
+ "name": "join_return_with_assignment",
+ "description": "Join return statement with assignment when possible."
+ },
+ {
+ "name": "leading_newlines_in_multiline_strings",
+ "description": "Start multiline strings with a newline."
+ },
+ {
+ "name": "library_annotations",
+ "description": "Attach library annotations to library directives."
+ },
+ {
+ "name": "library_names",
+ "description": "Name libraries using `lowercase_with_underscores`."
+ },
+ {
+ "name": "library_prefixes",
+ "description": "Use `lowercase_with_underscores` when specifying a library prefix."
+ },
+ {
+ "name": "library_private_types_in_public_api",
+ "description": "Avoid using private types in public APIs."
+ },
+ {
+ "name": "lines_longer_than_80_chars",
+ "description": "Avoid lines longer than 80 characters."
+ },
+ {
+ "name": "matching_super_parameters",
+ "description": "Use matching super parameter names."
+ },
+ {
+ "name": "missing_whitespace_between_adjacent_strings",
+ "description": "Missing whitespace between adjacent strings."
+ },
+ {
+ "name": "no_default_cases",
+ "description": "No default cases."
+ },
+ {
+ "name": "no_leading_underscores_for_library_prefixes",
+ "description": "Avoid leading underscores for library prefixes."
+ },
+ {
+ "name": "no_leading_underscores_for_local_identifiers",
+ "description": "Avoid leading underscores for local identifiers."
+ },
+ {
+ "name": "no_literal_bool_comparisons",
+ "description": "Don't compare booleans to boolean literals."
+ },
+ {
+ "name": "no_runtimeType_toString",
+ "description": "Avoid calling toString() on runtimeType."
+ },
+ {
+ "name": "non_constant_identifier_names",
+ "description": "Name non-constant identifiers using lowerCamelCase."
+ },
+ {
+ "name": "noop_primitive_operations",
+ "description": "Noop primitive operations."
+ },
+ {
+ "name": "null_check_on_nullable_type_parameter",
+ "description": "Don't use null check on a potentially nullable type parameter."
+ },
+ {
+ "name": "null_closures",
+ "description": "Do not pass `null` as an argument where a closure is expected."
+ },
+ {
+ "name": "omit_local_variable_types",
+ "description": "Omit type annotations for local variables."
+ },
+ {
+ "name": "one_member_abstracts",
+ "description": "Avoid defining a one-member abstract class when a simple function will do."
+ },
+ {
+ "name": "only_throw_errors",
+ "description": "Only throw instances of classes extending either Exception or Error."
+ },
+ {
+ "name": "overridden_fields",
+ "description": "Don't override fields."
+ },
+ {
+ "name": "package_api_docs",
+ "description": "Provide doc comments for all public APIs."
+ },
+ {
+ "name": "package_prefixed_library_names",
+ "description": "Prefix library names with the package name and a dot-separated path."
+ },
+ {
+ "name": "parameter_assignments",
+ "description": "Don't reassign references to parameters of functions or methods."
+ },
+ {
+ "name": "prefer_adjacent_string_concatenation",
+ "description": "Use adjacent strings to concatenate string literals."
+ },
+ {
+ "name": "prefer_asserts_in_initializer_lists",
+ "description": "Prefer putting asserts in initializer lists."
+ },
+ {
+ "name": "prefer_asserts_with_message",
+ "description": "Prefer asserts with message."
+ },
+ {
+ "name": "prefer_bool_in_asserts",
+ "description": "Prefer using a boolean as the assert condition."
+ },
+ {
+ "name": "prefer_collection_literals",
+ "description": "Use collection literals when possible."
+ },
+ {
+ "name": "prefer_conditional_assignment",
+ "description": "Prefer using `??=` over testing for null."
+ },
+ {
+ "name": "prefer_const_constructors",
+ "description": "Prefer const with constant constructors."
+ },
+ {
+ "name": "prefer_const_constructors_in_immutables",
+ "description": "Prefer declaring const constructors on `@immutable` classes."
+ },
+ {
+ "name": "prefer_const_declarations",
+ "description": "Prefer const over final for declarations."
+ },
+ {
+ "name": "prefer_const_literals_to_create_immutables",
+ "description": "Prefer const literals as parameters of constructors on @immutable classes."
+ },
+ {
+ "name": "prefer_constructors_over_static_methods",
+ "description": "Prefer defining constructors instead of static methods to create instances."
+ },
+ {
+ "name": "prefer_contains",
+ "description": "Use contains for `List` and `String` instances."
+ },
+ {
+ "name": "prefer_double_quotes",
+ "description": "Prefer double quotes where they won't require escape sequences."
+ },
+ {
+ "name": "prefer_equal_for_default_values",
+ "description": "Use `=` to separate a named parameter from its default value."
+ },
+ {
+ "name": "prefer_expression_function_bodies",
+ "description": "Use => for short members whose body is a single return statement."
+ },
+ {
+ "name": "prefer_final_fields",
+ "description": "Private field could be final."
+ },
+ {
+ "name": "prefer_final_in_for_each",
+ "description": "Prefer final in for-each loop variable if reference is not reassigned."
+ },
+ {
+ "name": "prefer_final_locals",
+ "description": "Prefer final for variable declarations if they are not reassigned."
+ },
+ {
+ "name": "prefer_final_parameters",
+ "description": "Prefer final for parameter declarations if they are not reassigned."
+ },
+ {
+ "name": "prefer_for_elements_to_map_fromIterable",
+ "description": "Prefer 'for' elements when building maps from iterables."
+ },
+ {
+ "name": "prefer_foreach",
+ "description": "Use `forEach` to only apply a function to all the elements."
+ },
+ {
+ "name": "prefer_function_declarations_over_variables",
+ "description": "Use a function declaration to bind a function to a name."
+ },
+ {
+ "name": "prefer_generic_function_type_aliases",
+ "description": "Prefer generic function type aliases."
+ },
+ {
+ "name": "prefer_if_elements_to_conditional_expressions",
+ "description": "Prefer if elements to conditional expressions where possible."
+ },
+ {
+ "name": "prefer_if_null_operators",
+ "description": "Prefer using if null operators."
+ },
+ {
+ "name": "prefer_initializing_formals",
+ "description": "Use initializing formals when possible."
+ },
+ {
+ "name": "prefer_inlined_adds",
+ "description": "Inline list item declarations where possible."
+ },
+ {
+ "name": "prefer_int_literals",
+ "description": "Prefer int literals over double literals."
+ },
+ {
+ "name": "prefer_interpolation_to_compose_strings",
+ "description": "Use interpolation to compose strings and values."
+ },
+ {
+ "name": "prefer_is_empty",
+ "description": "Use `isEmpty` for Iterables and Maps."
+ },
+ {
+ "name": "prefer_is_not_empty",
+ "description": "Use `isNotEmpty` for Iterables and Maps."
+ },
+ {
+ "name": "prefer_is_not_operator",
+ "description": "Prefer is! operator."
+ },
+ {
+ "name": "prefer_iterable_whereType",
+ "description": "Prefer to use whereType on iterable."
+ },
+ {
+ "name": "prefer_mixin",
+ "description": "Prefer using mixins."
+ },
+ {
+ "name": "prefer_null_aware_method_calls",
+ "description": "Prefer null aware method calls."
+ },
+ {
+ "name": "prefer_null_aware_operators",
+ "description": "Prefer using null aware operators."
+ },
+ {
+ "name": "prefer_single_quotes",
+ "description": "Only use double quotes for strings containing single quotes."
+ },
+ {
+ "name": "prefer_spread_collections",
+ "description": "Use spread collections when possible."
+ },
+ {
+ "name": "prefer_typing_uninitialized_variables",
+ "description": "Prefer typing uninitialized variables and fields."
+ },
+ {
+ "name": "provide_deprecation_message",
+ "description": "Provide a deprecation message, via @Deprecated(\"message\")."
+ },
+ {
+ "name": "public_member_api_docs",
+ "description": "Document all public members."
+ },
+ {
+ "name": "recursive_getters",
+ "description": "Property getter recursively returns itself."
+ },
+ {
+ "name": "require_trailing_commas",
+ "description": "Use trailing commas for all function calls and declarations."
+ },
+ {
+ "name": "sized_box_for_whitespace",
+ "description": "SizedBox for whitespace."
+ },
+ {
+ "name": "sized_box_shrink_expand",
+ "description": "Use SizedBox shrink and expand named constructors."
+ },
+ {
+ "name": "slash_for_doc_comments",
+ "description": "Prefer using /// for doc comments."
+ },
+ {
+ "name": "sort_child_properties_last",
+ "description": "Sort child properties last in widget instance creations."
+ },
+ {
+ "name": "sort_constructors_first",
+ "description": "Sort constructor declarations before other members."
+ },
+ {
+ "name": "sort_unnamed_constructors_first",
+ "description": "Sort unnamed constructor declarations first."
+ },
+ {
+ "name": "super_goes_last",
+ "description": "Place the `super` call last in a constructor initialization list."
+ },
+ {
+ "name": "tighten_type_of_initializing_formals",
+ "description": "Tighten type of initializing formal."
+ },
+ {
+ "name": "type_annotate_public_apis",
+ "description": "Type annotate public APIs."
+ },
+ {
+ "name": "type_init_formals",
+ "description": "Don't type annotate initializing formals."
+ },
+ {
+ "name": "type_literal_in_constant_pattern",
+ "description": "Don't use constant patterns with type literals."
+ },
+ {
+ "name": "unawaited_futures",
+ "description": "`Future` results in `async` function bodies must be `await`ed or marked `unawaited` using `dart:async`."
+ },
+ {
+ "name": "unnecessary_await_in_return",
+ "description": "Unnecessary await keyword in return."
+ },
+ {
+ "name": "unnecessary_brace_in_string_interps",
+ "description": "Avoid using braces in interpolation when not needed."
+ },
+ {
+ "name": "unnecessary_breaks",
+ "description": "Don't use explicit `break`s when a break is implied."
+ },
+ {
+ "name": "unnecessary_const",
+ "description": "Avoid const keyword."
+ },
+ {
+ "name": "unnecessary_constructor_name",
+ "description": "Unnecessary `.new` constructor name."
+ },
+ {
+ "name": "unnecessary_final",
+ "description": "Don't use `final` for local variables."
+ },
+ {
+ "name": "unnecessary_getters_setters",
+ "description": "Avoid wrapping fields in getters and setters just to be \"safe\"."
+ },
+ {
+ "name": "unnecessary_lambdas",
+ "description": "Don't create a lambda when a tear-off will do."
+ },
+ {
+ "name": "unnecessary_late",
+ "description": "Don't specify the `late` modifier when it is not needed."
+ },
+ {
+ "name": "unnecessary_library_directive",
+ "description": "Avoid library directives unless they have documentation comments or annotations."
+ },
+ {
+ "name": "unnecessary_new",
+ "description": "Unnecessary new keyword."
+ },
+ {
+ "name": "unnecessary_null_aware_assignments",
+ "description": "Avoid null in null-aware assignment."
+ },
+ {
+ "name": "unnecessary_null_aware_operator_on_extension_on_nullable",
+ "description": "Unnecessary null aware operator on extension on a nullable type."
+ },
+ {
+ "name": "unnecessary_null_checks",
+ "description": "Unnecessary null checks."
+ },
+ {
+ "name": "unnecessary_null_in_if_null_operators",
+ "description": "Avoid using `null` in `if null` operators."
+ },
+ {
+ "name": "unnecessary_nullable_for_final_variable_declarations",
+ "description": "Use a non-nullable type for a final variable initialized with a non-nullable value."
+ },
+ {
+ "name": "unnecessary_overrides",
+ "description": "Don't override a method to do a super method invocation with the same parameters."
+ },
+ {
+ "name": "unnecessary_parenthesis",
+ "description": "Unnecessary parentheses can be removed."
+ },
+ {
+ "name": "unnecessary_raw_strings",
+ "description": "Unnecessary raw string."
+ },
+ {
+ "name": "unnecessary_string_escapes",
+ "description": "Remove unnecessary backslashes in strings."
+ },
+ {
+ "name": "unnecessary_string_interpolations",
+ "description": "Unnecessary string interpolation."
+ },
+ {
+ "name": "unnecessary_this",
+ "description": "Don't access members with `this` unless avoiding shadowing."
+ },
+ {
+ "name": "unnecessary_to_list_in_spreads",
+ "description": "Unnecessary toList() in spreads."
+ },
+ {
+ "name": "unreachable_from_main",
+ "description": "Unreachable top-level members in executable libraries."
+ },
+ {
+ "name": "use_colored_box",
+ "description": "Use `ColoredBox`."
+ },
+ {
+ "name": "use_decorated_box",
+ "description": "Use `DecoratedBox`."
+ },
+ {
+ "name": "use_enums",
+ "description": "Use enums rather than classes that behave like enums."
+ },
+ {
+ "name": "use_full_hex_values_for_flutter_colors",
+ "description": "Prefer an 8-digit hexadecimal integer(0xFFFFFFFF) to instantiate Color."
+ },
+ {
+ "name": "use_function_type_syntax_for_parameters",
+ "description": "Use generic function type syntax for parameters."
+ },
+ {
+ "name": "use_if_null_to_convert_nulls_to_bools",
+ "description": "Use if-null operators to convert nulls to bools."
+ },
+ {
+ "name": "use_is_even_rather_than_modulo",
+ "description": "Prefer intValue.isOdd/isEven instead of checking the result of % 2."
+ },
+ {
+ "name": "use_late_for_private_fields_and_variables",
+ "description": "Use late for private members with a non-nullable type."
+ },
+ {
+ "name": "use_named_constants",
+ "description": "Use predefined named constants."
+ },
+ {
+ "name": "use_raw_strings",
+ "description": "Use raw string to avoid escapes."
+ },
+ {
+ "name": "use_rethrow_when_possible",
+ "description": "Use rethrow to rethrow a caught exception."
+ },
+ {
+ "name": "use_setters_to_change_properties",
+ "description": "Use a setter for operations that conceptually change a property."
+ },
+ {
+ "name": "use_string_buffers",
+ "description": "Use string buffers to compose strings."
+ },
+ {
+ "name": "use_string_in_part_of_directives",
+ "description": "Use string in part of directives."
+ },
+ {
+ "name": "use_super_parameters",
+ "description": "Use super-initializer parameters where possible."
+ },
+ {
+ "name": "use_test_throws_matchers",
+ "description": "Use throwsA matcher instead of fail()."
+ },
+ {
+ "name": "use_to_and_as_if_applicable",
+ "description": "Start the name of the method with to/_to or as/_as if applicable."
+ },
+ {
+ "name": "void_checks",
+ "description": "Don't assign to void."
+ }
+]
\ No newline at end of file
diff --git a/pkgs/lints/tool/validate_lib.dart b/pkgs/lints/tool/validate_lib.dart
new file mode 100644
index 0000000..38b1ce8
--- /dev/null
+++ b/pkgs/lints/tool/validate_lib.dart
@@ -0,0 +1,26 @@
+// Copyright (c) 2023, 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 'dart:io';
+
+import 'package:path/path.dart' as p;
+
+void main(List<String> args) {
+ print('Validating that there are no .dart source files in lib/ ...');
+
+ final dartSourceFiles = Directory('lib')
+ .listSync(recursive: true)
+ .whereType<File>()
+ .where((file) => p.extension(file.path) == '.dart')
+ .toList();
+
+ if (dartSourceFiles.isEmpty) {
+ print('No Dart files found.');
+ } else {
+ for (var file in dartSourceFiles) {
+ print(' error: found ${file.path}');
+ }
+ exit(1);
+ }
+}
