linter: Allow each LintRule multiple categories

Spelled out at https://github.com/dart-lang/linter/issues/1020 Fixes https://github.com/dart-lang/linter/issues/1020 This CL does not change the categories/groups that any rule has. We can add/change categories in later CLs. Cq-Include-Trybots: luci.dart.try:flutter-analyze-try,analyzer-win-release-try,pkg-win-release-try Change-Id: Ief2856a6c472492bbad19fc95df172ef8d19fe7b Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/369861 Reviewed-by: Brian Wilkerson <[email protected]> Reviewed-by: Phil Quitslund <[email protected]> Commit-Queue: Sam Rawlins <[email protected]>
dart-lang · Jun 7, 2024 · 6c6b104 · 6c6b104
1 parent 63d6e6f
commit 6c6b104
Show file tree

Hide file tree

Showing 252 changed files with 274 additions and 297 deletions.
diff --git a/pkg/analysis_server/test/lsp/code_actions_fixes_test.dart b/pkg/analysis_server/test/lsp/code_actions_fixes_test.dart
@@ -27,7 +27,7 @@ class DeprecatedCamelCaseTypes extends LintRule {
   DeprecatedCamelCaseTypes()
       : super(
           name: 'camel_case_types',
-          group: Group.style,
+          categories: {Category.style},
           state: State.deprecated(),
           description: '',
           details: '',

diff --git a/pkg/analysis_server/test/src/services/completion/yaml/analysis_options_generator_test.dart b/pkg/analysis_server/test/src/services/completion/yaml/analysis_options_generator_test.dart
@@ -259,7 +259,7 @@ class InternalLint extends LintRule {
   InternalLint()
       : super(
           name: 'internal_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.internal(),
           description: '',
           details: '',

diff --git a/pkg/analysis_server/test/src/services/correction/fix/analysis_options/remove_lint_test.dart b/pkg/analysis_server/test/src/services/correction/fix/analysis_options/remove_lint_test.dart
@@ -21,7 +21,7 @@ class DeprecatedRule extends LintRule {
           name: 'deprecated_rule',
           description: '',
           details: '...',
-          group: Group.errors,
+          categories: {Category.errors},
           state: State.deprecated(since: dart2_12),
         );
 }
@@ -32,7 +32,7 @@ class RemovedRule extends LintRule {
             name: 'removed_rule',
             description: '',
             details: '...',
-            group: Group.errors,
+            categories: {Category.errors},
             state: State.removed());
 }
 

diff --git a/pkg/analyzer/lib/src/lint/linter.dart b/pkg/analyzer/lib/src/lint/linter.dart
@@ -35,31 +35,18 @@ export 'package:analyzer/src/lint/linter_visitor.dart' show NodeLintRegistry;
 export 'package:analyzer/src/lint/state.dart'
     show dart2_12, dart3, dart3_3, State;
 
-abstract class Group {
-  /// A group representing possible coding errors.
+final class Category {
+  /// A category representing possible coding errors.
   static const String errors = 'errors';
 
-  /// A group representing Pub-related rules.
+  /// A category representing Pub-related rules.
   static const String pub = 'pub';
 
-  /// A group representing matters of style, largely derived from Effective
+  /// A category representing matters of style, largely derived from Effective
   /// Dart.
   static const String style = 'style';
 }
 
-@visibleForTesting
-class Hyperlink {
-  final String _label;
-  final String _href;
-  final bool _bold;
-
-  const Hyperlink(this._label, this._href, {bool bold = false}) : _bold = bold;
-
-  String get html => '<a href="$_href">${_emph(_label)}</a>';
-
-  String _emph(String msg) => _bold ? '<strong>$msg</strong>' : msg;
-}
-
 /// The result of attempting to evaluate an expression.
 class LinterConstantEvaluationResult {
   /// The value of the expression, or `null` if has [errors].
@@ -213,8 +200,8 @@ abstract class LintRule {
   /// Short description suitable for display in console output.
   final String description;
 
-  /// Lint group (for example, 'style').
-  final String group;
+  /// Lint groups (for example, 'style', 'errors', 'pub').
+  final Set<String> categories;
 
   /// Lint name.
   final String name;
@@ -233,7 +220,7 @@ abstract class LintRule {
 
   LintRule({
     required this.name,
-    required this.group,
+    required this.categories,
     required this.description,
     required this.details,
     State? state,

diff --git a/pkg/analyzer/test/src/diagnostics/removed_lint_use_test.dart b/pkg/analyzer/test/src/diagnostics/removed_lint_use_test.dart
@@ -19,7 +19,7 @@ class RemovedLint extends LintRule {
   RemovedLint()
       : super(
           name: 'removed_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.removed(since: dart3),
           description: '',
           details: '',

diff --git a/pkg/analyzer/test/src/diagnostics/replaced_lint_use_test.dart b/pkg/analyzer/test/src/diagnostics/replaced_lint_use_test.dart
@@ -19,7 +19,7 @@ class RemovedLint extends LintRule {
   RemovedLint()
       : super(
           name: 'removed_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.removed(since: dart3, replacedBy: 'replacing_lint'),
           description: '',
           details: '',
@@ -65,7 +65,7 @@ class ReplacingLint extends LintRule {
   ReplacingLint()
       : super(
           name: 'replacing_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.removed(since: dart3),
           description: '',
           details: '',

diff --git a/pkg/analyzer/test/src/diagnostics/unignorable_ignore_test.dart b/pkg/analyzer/test/src/diagnostics/unignorable_ignore_test.dart
@@ -77,7 +77,7 @@ class _AvoidIntRule extends LintRule {
           name: 'avoid_int',
           description: '',
           details: '',
-          group: Group.errors,
+          categories: {Category.errors},
         );
 
   @override

diff --git a/pkg/analyzer/test/src/lint/lint_rule_test.dart b/pkg/analyzer/test/src/lint/lint_rule_test.dart
@@ -139,7 +139,7 @@ class TestRule extends LintRule {
           name: 'test_rule',
           description: '',
           details: '... tl;dr ...',
-          group: Group.errors,
+          categories: {Category.errors},
         );
 }
 

diff --git a/pkg/analyzer/test/src/options/apply_options_test.dart b/pkg/analyzer/test/src/options/apply_options_test.dart
@@ -375,14 +375,14 @@ class TestRule extends LintRule {
           name: 'fantastic_test_rule',
           description: '',
           details: '',
-          group: Group.style,
+          categories: {Category.style},
         );
 
   TestRule.withName(String name)
       : super(
           name: name,
           description: '',
           details: '',
-          group: Group.style,
+          categories: {Category.style},
         );
 }
diff --git a/pkg/analyzer/test/src/options/options_rule_validator_test.dart b/pkg/analyzer/test/src/options/options_rule_validator_test.dart
@@ -27,7 +27,7 @@ class DeprecatedLint extends LintRule {
   DeprecatedLint()
       : super(
           name: 'deprecated_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.deprecated(),
           description: '',
           details: '',
@@ -38,7 +38,7 @@ class DeprecatedLintWithReplacement extends LintRule {
   DeprecatedLintWithReplacement()
       : super(
           name: 'deprecated_lint_with_replacement',
-          group: Group.style,
+          categories: {Category.style},
           state: State.deprecated(replacedBy: 'replacing_lint'),
           description: '',
           details: '',
@@ -49,7 +49,7 @@ class DeprecatedSince3Lint extends LintRule {
   DeprecatedSince3Lint()
       : super(
           name: 'deprecated_since_3_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.deprecated(since: dart3),
           description: '',
           details: '',
@@ -293,7 +293,7 @@ class RemovedIn2_12Lint extends LintRule {
   RemovedIn2_12Lint()
       : super(
           name: 'removed_in_2_12_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.removed(since: dart2_12),
           description: '',
           details: '',
@@ -304,7 +304,7 @@ class ReplacedLint extends LintRule {
   ReplacedLint()
       : super(
           name: 'replaced_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.removed(since: dart3, replacedBy: 'replacing_lint'),
           description: '',
           details: '',
@@ -315,7 +315,7 @@ class ReplacingLint extends LintRule {
   ReplacingLint()
       : super(
           name: 'replacing_lint',
-          group: Group.style,
+          categories: {Category.style},
           description: '',
           details: '',
         );
@@ -325,7 +325,7 @@ class RuleNeg extends LintRule {
   RuleNeg()
       : super(
           name: 'rule_neg',
-          group: Group.style,
+          categories: {Category.style},
           description: '',
           details: '',
         );
@@ -338,7 +338,7 @@ class RulePos extends LintRule {
   RulePos()
       : super(
           name: 'rule_pos',
-          group: Group.style,
+          categories: {Category.style},
           description: '',
           details: '',
         );
@@ -351,7 +351,7 @@ class StableLint extends LintRule {
   StableLint()
       : super(
           name: 'stable_lint',
-          group: Group.style,
+          categories: {Category.style},
           state: State.stable(),
           description: '',
           details: '',

diff --git a/pkg/analyzer/test/src/task/options_test.dart b/pkg/analyzer/test/src/task/options_test.dart
@@ -575,14 +575,14 @@ class TestRule extends LintRule {
           name: 'fantastic_test_rule',
           description: '',
           details: '',
-          group: Group.style,
+          categories: {Category.style},
         );
 
   TestRule.withName(String name)
       : super(
           name: name,
           description: '',
           details: '',
-          group: Group.style,
+          categories: {Category.style},
         );
 }
diff --git a/pkg/linter/lib/src/analyzer.dart b/pkg/linter/lib/src/analyzer.dart
@@ -22,7 +22,7 @@ export 'package:analyzer/src/lint/linter.dart'
         dart2_12,
         dart3,
         dart3_3,
-        Group,
+        Category,
         LintFilter,
         LintRule,
         LinterContext,

diff --git a/pkg/linter/lib/src/rules/always_declare_return_types.dart b/pkg/linter/lib/src/rules/always_declare_return_types.dart
@@ -55,7 +55,7 @@ class AlwaysDeclareReturnTypes extends LintRule {
             name: 'always_declare_return_types',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/always_put_control_body_on_new_line.dart b/pkg/linter/lib/src/rules/always_put_control_body_on_new_line.dart
@@ -59,7 +59,7 @@ class AlwaysPutControlBodyOnNewLine extends LintRule {
             name: 'always_put_control_body_on_new_line',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/always_put_required_named_parameters_first.dart b/pkg/linter/lib/src/rules/always_put_required_named_parameters_first.dart
@@ -47,7 +47,7 @@ class AlwaysPutRequiredNamedParametersFirst extends LintRule {
             name: 'always_put_required_named_parameters_first',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/always_require_non_null_named_parameters.dart b/pkg/linter/lib/src/rules/always_require_non_null_named_parameters.dart
@@ -48,7 +48,7 @@ class AlwaysRequireNonNullNamedParameters extends LintRule {
             description: _desc,
             details: _details,
             state: State.removed(since: dart3_3),
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/always_specify_types.dart b/pkg/linter/lib/src/rules/always_specify_types.dart
@@ -70,7 +70,7 @@ class AlwaysSpecifyTypes extends LintRule {
             name: 'always_specify_types',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   List<String> get incompatibleRules =>

diff --git a/pkg/linter/lib/src/rules/always_use_package_imports.dart b/pkg/linter/lib/src/rules/always_use_package_imports.dart
@@ -55,7 +55,7 @@ class AlwaysUsePackageImports extends LintRule {
             name: 'always_use_package_imports',
             description: _desc,
             details: _details,
-            group: Group.errors);
+            categories: {Category.errors});
 
   @override
   List<String> get incompatibleRules => const ['prefer_relative_imports'];

diff --git a/pkg/linter/lib/src/rules/annotate_overrides.dart b/pkg/linter/lib/src/rules/annotate_overrides.dart
@@ -58,7 +58,7 @@ class AnnotateOverrides extends LintRule {
             name: 'annotate_overrides',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/annotate_redeclares.dart b/pkg/linter/lib/src/rules/annotate_redeclares.dart
@@ -57,7 +57,7 @@ class AnnotateRedeclares extends LintRule {
             name: 'annotate_redeclares',
             description: _desc,
             details: _details,
-            group: Group.style,
+            categories: {Category.style},
             state: State.experimental());
 
   @override

diff --git a/pkg/linter/lib/src/rules/avoid_annotating_with_dynamic.dart b/pkg/linter/lib/src/rules/avoid_annotating_with_dynamic.dart
@@ -47,7 +47,7 @@ class AvoidAnnotatingWithDynamic extends LintRule {
             name: 'avoid_annotating_with_dynamic',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/avoid_as.dart b/pkg/linter/lib/src/rules/avoid_as.dart
@@ -52,7 +52,7 @@ class AvoidAs extends LintRule {
           name: 'avoid_as',
           description: _desc,
           details: _details,
-          group: Group.style,
+          categories: {Category.style},
           state: State.removed(since: dart2_12),
         );
 

diff --git a/pkg/linter/lib/src/rules/avoid_bool_literals_in_conditional_expressions.dart b/pkg/linter/lib/src/rules/avoid_bool_literals_in_conditional_expressions.dart
@@ -42,7 +42,7 @@ class AvoidBoolLiteralsInConditionalExpressions extends LintRule {
             name: 'avoid_bool_literals_in_conditional_expressions',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/avoid_catches_without_on_clauses.dart b/pkg/linter/lib/src/rules/avoid_catches_without_on_clauses.dart
@@ -63,7 +63,7 @@ class AvoidCatchesWithoutOnClauses extends LintRule {
             name: 'avoid_catches_without_on_clauses',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/avoid_catching_errors.dart b/pkg/linter/lib/src/rules/avoid_catching_errors.dart
@@ -50,7 +50,7 @@ class AvoidCatchingErrors extends LintRule {
             name: 'avoid_catching_errors',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   List<LintCode> get lintCodes => [classCode, subclassCode];

diff --git a/pkg/linter/lib/src/rules/avoid_classes_with_only_static_members.dart b/pkg/linter/lib/src/rules/avoid_classes_with_only_static_members.dart
@@ -56,7 +56,7 @@ class AvoidClassesWithOnlyStaticMembers extends LintRule {
             name: 'avoid_classes_with_only_static_members',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;

diff --git a/pkg/linter/lib/src/rules/avoid_double_and_int_checks.dart b/pkg/linter/lib/src/rules/avoid_double_and_int_checks.dart
@@ -51,7 +51,7 @@ class AvoidDoubleAndIntChecks extends LintRule {
             name: 'avoid_double_and_int_checks',
             description: _desc,
             details: _details,
-            group: Group.style);
+            categories: {Category.style});
 
   @override
   LintCode get lintCode => code;