prefer_first_rule.dart

import 'package:analyzer/error/listener.dart';
import 'package:custom_lint_builder/custom_lint_builder.dart';
import 'package:solid_lints/src/lints/prefer_first/fixes/prefer_first_fix.dart';
import 'package:solid_lints/src/lints/prefer_first/visitors/prefer_first_visitor.dart';
import 'package:solid_lints/src/models/rule_config.dart';
import 'package:solid_lints/src/models/solid_lint_rule.dart';

/// Warns about usage of iterable[0] or iterable.elementAt(0) instead of
/// iterable.first.
///
/// ### Example
///
/// #### BAD:
///
/// ```dart
/// final a = [1, 2, 3];
///
/// a[0];           // LINT
/// a.elementAt(0); // LINT
/// ```
///
/// #### GOOD:
///
/// ```dart
/// final a = [1, 2, 3];
///
/// a.first; // OK
/// ```
class PreferFirstRule extends SolidLintRule {
  /// This lint rule represents the error if number of
  /// parameters reaches the maximum value.
  static const lintName = 'prefer_first';

  PreferFirstRule._(super.config);

  /// Creates a new instance of [PreferFirstRule]
  /// based on the lint configuration.
  factory PreferFirstRule.createRule(CustomLintConfigs configs) {
    final config = RuleConfig(
      configs: configs,
      name: lintName,
      problemMessage: (value) =>
          'Use first instead of accessing the element at zero index.',
    );

    return PreferFirstRule._(config);
  }

  @override
  void runRule(
    CustomLintResolver resolver,
    ErrorReporter reporter,
    CustomLintContext context,
  ) {
    context.registry.addCompilationUnit((node) {
      final visitor = PreferFirstVisitor();
      node.accept(visitor);

      for (final element in visitor.expressions) {
        reporter.atNode(element, code);
      }
    });
  }

  @override
  List<Fix> getFixes() => [PreferFirstFix()];
}