linter: Rename State to RuleState, and sub-classes

Change-Id: Id74c1a34e0a3154e1720d323bf4002aceb092dd4
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/429160
Reviewed-by: Konstantin Shcheglov <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: srawlins

pkg/analysis_server/test/shared/shared_code_actions_fixes_tests.dart

@@ -881,7 +881,7 @@ class _DeprecatedCamelCaseTypes extends LintRule {
   _DeprecatedCamelCaseTypes()
     : super(
         name: 'camel_case_types',
-        state: State.deprecated(),
+        state: RuleState.deprecated(),
         description: '',
       );
 

pkg/analysis_server/test/src/services/completion/yaml/analysis_options_generator_test.dart

@@ -313,7 +313,11 @@ class InternalRule extends LintRule {
   );
 
   InternalRule()
-    : super(name: 'internal_lint', state: State.internal(), description: '');
+    : super(
+        name: 'internal_lint',
+        state: RuleState.internal(),
+        description: '',
+      );
 
   @override
   DiagnosticCode get diagnosticCode => code;
@@ -323,7 +327,7 @@ class _RemovedLint extends LintRule {
   static const LintCode _code = LintCode('removed_lint', 'Removed rule.');
 
   _RemovedLint()
-    : super(name: 'removed_lint', state: State.removed(), description: '');
+    : super(name: 'removed_lint', state: RuleState.removed(), description: '');
 
   @override
   DiagnosticCode get diagnosticCode => _code;

pkg/analysis_server/test/src/services/correction/fix/analysis_options/remove_lint_test.dart

@@ -27,7 +27,7 @@ class DeprecatedRule extends LintRule {
     : super(
         name: 'deprecated_rule',
         description: '',
-        state: State.deprecated(since: dart2_12),
+        state: RuleState.deprecated(since: dart2_12),
       );
 
   @override
@@ -42,7 +42,7 @@ class RemovedRule extends LintRule {
   );
 
   RemovedRule()
-    : super(name: 'removed_rule', description: '', state: State.removed());
+    : super(name: 'removed_rule', description: '', state: RuleState.removed());
 
   @override
   DiagnosticCode get diagnosticCode => code;

pkg/analyzer/lib/src/error/ignore_validator.dart

@@ -207,9 +207,9 @@ class IgnoreValidator {
         } else {
           var state = rule.state;
           var since = state.since.toString();
-          if (state is DeprecatedState) {
+          if (state is DeprecatedRuleState) {
             // `todo`(pq): implement
-          } else if (state is RemovedState) {
+          } else if (state is RemovedRuleState) {
             var replacedBy = state.replacedBy;
             if (replacedBy != null) {
               _errorReporter.atOffset(

pkg/analyzer/lib/src/lint/linter.dart

@@ -21,7 +21,7 @@ import 'package:meta/meta.dart';
 
 export 'package:analyzer/src/lint/linter_visitor.dart' show NodeLintRegistry;
 export 'package:analyzer/src/lint/state.dart'
-    show dart2_12, dart3, dart3_3, State;
+    show dart2_12, dart3, dart3_3, RuleState;
 
 /// Describes an [AbstractAnalysisRule] which reports diagnostics using exactly
 /// one [DiagnosticCode].
@@ -41,13 +41,14 @@ sealed class AbstractAnalysisRule {
   /// Lint name.
   final String name;
 
-  /// The state of a lint, and optionally since when the state began.
-  final State state;
+  /// The state of this analysis rule, optionally indicating the "version" that
+  /// this state started applying to this rule.
+  final RuleState state;
 
   AbstractAnalysisRule({
     required this.name,
     required this.description,
-    this.state = const State.stable(),
+    this.state = const RuleState.stable(),
   });
 
   /// Indicates whether this analysis rule can work with just the parsed

pkg/analyzer/lib/src/lint/options_rule_validator.dart

@@ -39,11 +39,11 @@ class LinterRuleOptionsValidator extends OptionsValidator {
       .rules
       .firstWhereOrNull((rule) => rule.name == value);
 
-  bool isDeprecatedInCurrentSdk(DeprecatedState state) =>
+  bool isDeprecatedInCurrentSdk(DeprecatedRuleState state) =>
       currentSdkAllows(state.since);
 
-  bool isRemovedInCurrentSdk(State state) {
-    if (state is! RemovedState) return false;
+  bool isRemovedInCurrentSdk(RuleState state) {
+    if (state is! RemovedRuleState) return false;
     return currentSdkAllows(state.since);
   }
 
@@ -103,7 +103,7 @@ class LinterRuleOptionsValidator extends OptionsValidator {
       // includes).
       if (sourceIsOptionsForContextRoot) {
         var state = rule.state;
-        if (state is DeprecatedState && isDeprecatedInCurrentSdk(state)) {
+        if (state is DeprecatedRuleState && isDeprecatedInCurrentSdk(state)) {
           var replacedBy = state.replacedBy;
           if (replacedBy != null) {
             reporter.atSourceSpan(
@@ -120,7 +120,7 @@ class LinterRuleOptionsValidator extends OptionsValidator {
           }
         } else if (isRemovedInCurrentSdk(state)) {
           var since = state.since.toString();
-          var replacedBy = (state as RemovedState).replacedBy;
+          var replacedBy = (state as RemovedRuleState).replacedBy;
           if (replacedBy != null) {
             reporter.atSourceSpan(
               node.span,

pkg/analyzer/lib/src/lint/state.dart

@@ -13,91 +13,91 @@ final Version dart3 = Version(3, 0, 0);
 /// A version describing Dart language version 3.3.0.
 final Version dart3_3 = Version(3, 3, 0);
 
-/// A state that marks a lint as deprecated.
-final class DeprecatedState extends State {
-  /// An optional lint name that replaces the rule with this state.
+@Deprecated("Prefer to use 'RuleState'")
+typedef State = RuleState;
+
+/// A state that marks an analysis rule as deprecated.
+final class DeprecatedRuleState extends RuleState {
+  /// The optional name of an analysis rule which replaces the rule with this
+  /// state.
   final String? replacedBy;
 
-  /// Initialize a newly created deprecated state with given values.
-  const DeprecatedState._({super.since, this.replacedBy});
+  const DeprecatedRuleState._({super.since, this.replacedBy});
 
   @override
   String get label => 'deprecated';
 }
 
-/// A state that marks a lint as experimental.
-final class ExperimentalState extends State {
-  /// Initialize a newly created experimental state with given values.
-  const ExperimentalState._({super.since});
+/// A state that marks an analysis rule as experimental.
+final class ExperimentalRuleState extends RuleState {
+  const ExperimentalRuleState._({super.since});
 
   @override
   String get label => 'experimental';
 }
 
-/// A state that marks a lint as for internal (Dart SDK) use only.
-final class InternalState extends State {
-  /// Initialize a newly created internal state with given values.
-  const InternalState._({super.since});
+/// A state that marks an analysis rule as for internal (Dart SDK) use only.
+final class InternalRuleState extends RuleState {
+  const InternalRuleState._({super.since});
 
   @override
   String get label => 'internal';
 }
 
-/// A state that identifies a lint as having been removed.
-final class RemovedState extends State {
+/// A state that identifies an analysis rule as having been removed.
+final class RemovedRuleState extends RuleState {
   /// An optional lint name that replaces the rule with this state.
   final String? replacedBy;
 
-  /// Initialize a newly created removed state with given values.
-  const RemovedState._({super.since, this.replacedBy});
+  const RemovedRuleState._({super.since, this.replacedBy});
 
   @override
   String get label => 'removed';
 }
 
-/// A state that marks a lint as stable.
-final class StableState extends State {
-  /// Initialize a newly created stable state with given values.
-  const StableState._({super.since});
-
-  @override
-  String get label => 'stable';
-}
-
 /// Describes the state of a lint.
-sealed class State {
+sealed class RuleState {
   /// An Optional Dart language version that identifies the start of this state.
   final Version? since;
 
   /// Initialize a newly created State object.
-  const State({this.since});
+  const RuleState({this.since});
 
   /// Initialize a newly created deprecated state with given values.
-  const factory State.deprecated({Version? since, String? replacedBy}) =
-      DeprecatedState._;
+  const factory RuleState.deprecated({Version? since, String? replacedBy}) =
+      DeprecatedRuleState._;
 
   /// Initialize a newly created experimental state with given values.
-  const factory State.experimental({Version? since}) = ExperimentalState._;
+  const factory RuleState.experimental({Version? since}) =
+      ExperimentalRuleState._;
 
   /// Initialize a newly created internal state with given values.
-  const factory State.internal({Version? since}) = InternalState._;
+  const factory RuleState.internal({Version? since}) = InternalRuleState._;
 
   /// Initialize a newly created removed state with given values.
-  const factory State.removed({Version? since, String? replacedBy}) =
-      RemovedState._;
+  const factory RuleState.removed({Version? since, String? replacedBy}) =
+      RemovedRuleState._;
 
   /// Initialize a newly created stable state with given values.
-  const factory State.stable({Version? since}) = StableState._;
+  const factory RuleState.stable({Version? since}) = StableRuleState._;
 
   /// A short description, suitable for displaying in documentation or a
   /// diagnostic message.
   String get label;
 }
 
-extension StateExtension on State {
-  bool get isDeprecated => this is DeprecatedState;
-  bool get isExperimental => this is ExperimentalState;
-  bool get isInternal => this is InternalState;
-  bool get isRemoved => this is RemovedState;
-  bool get isStable => this is StableState;
+/// A state that marks an analysis rule as stable.
+final class StableRuleState extends RuleState {
+  const StableRuleState._({super.since});
+
+  @override
+  String get label => 'stable';
+}
+
+extension StateExtension on RuleState {
+  bool get isDeprecated => this is DeprecatedRuleState;
+  bool get isExperimental => this is ExperimentalRuleState;
+  bool get isInternal => this is InternalRuleState;
+  bool get isRemoved => this is RemovedRuleState;
+  bool get isStable => this is StableRuleState;
 }

pkg/analyzer/test/src/diagnostics/removed_lint_use_test.dart

@@ -20,7 +20,7 @@ class RemovedLint extends LintRule {
   RemovedLint()
     : super(
         name: 'removed_lint',
-        state: State.removed(since: dart3),
+        state: RuleState.removed(since: dart3),
         description: '',
       );
 

pkg/analyzer/test/src/diagnostics/replaced_lint_use_test.dart

@@ -20,7 +20,7 @@ class RemovedLint extends LintRule {
   RemovedLint()
     : super(
         name: 'removed_lint',
-        state: State.removed(since: dart3, replacedBy: 'replacing_lint'),
+        state: RuleState.removed(since: dart3, replacedBy: 'replacing_lint'),
         description: '',
       );
 
@@ -78,7 +78,7 @@ class ReplacingLint extends LintRule {
   ReplacingLint()
     : super(
         name: 'replacing_lint',
-        state: State.removed(since: dart3),
+        state: RuleState.removed(since: dart3),
         description: '',
       );
 

pkg/analyzer/test/src/options/options_rule_validator_test.dart

@@ -23,22 +23,23 @@ main() {
 }
 
 class DeprecatedLint extends TestLintRule {
-  DeprecatedLint() : super(name: 'deprecated_lint', state: State.deprecated());
+  DeprecatedLint()
+    : super(name: 'deprecated_lint', state: RuleState.deprecated());
 }
 
 class DeprecatedLintWithReplacement extends TestLintRule {
   DeprecatedLintWithReplacement()
     : super(
         name: 'deprecated_lint_with_replacement',
-        state: State.deprecated(replacedBy: 'replacing_lint'),
+        state: RuleState.deprecated(replacedBy: 'replacing_lint'),
       );
 }
 
 class DeprecatedSince3Lint extends TestLintRule {
   DeprecatedSince3Lint()
     : super(
         name: 'deprecated_since_3_lint',
-        state: State.deprecated(since: dart3),
+        state: RuleState.deprecated(since: dart3),
       );
 }
 
@@ -301,15 +302,15 @@ class RemovedIn2_12Lint extends TestLintRule {
   RemovedIn2_12Lint()
     : super(
         name: 'removed_in_2_12_lint',
-        state: State.removed(since: dart2_12),
+        state: RuleState.removed(since: dart2_12),
       );
 }
 
 class ReplacedLint extends TestLintRule {
   ReplacedLint()
     : super(
         name: 'replaced_lint',
-        state: State.removed(since: dart3, replacedBy: 'replacing_lint'),
+        state: RuleState.removed(since: dart3, replacedBy: 'replacing_lint'),
       );
 }
 
@@ -332,7 +333,7 @@ class RulePos extends TestLintRule {
 }
 
 class StableLint extends TestLintRule {
-  StableLint() : super(name: 'stable_lint', state: State.stable());
+  StableLint() : super(name: 'stable_lint', state: RuleState.stable());
 }
 
 abstract class TestLintRule extends LintRule {