pkg/analyzer/lib/src/analysis_options/code_style_options.dart

// Copyright (c) 2022, 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 'package:analyzer/dart/analysis/analysis_options.dart';
import 'package:analyzer/dart/analysis/code_style_options.dart';
import 'package:analyzer/dart/ast/ast.dart';

/// The concrete implementation of [CodeStyleOptions].
class CodeStyleOptionsImpl implements CodeStyleOptions {
  /// The analysis options that owns this instance.
  late final AnalysisOptions options;

  @override
  final bool useFormatter;

  CodeStyleOptionsImpl({required this.useFormatter});

  @override
  bool get addTrailingCommas => _isLintEnabled('require_trailing_commas');

  @override
  bool get avoidAnnotatingWithDynamic =>
      _isLintEnabled('avoid_annotating_with_dynamic');

  @override
  bool get avoidRenamingMethodParameters =>
      _isLintEnabled('avoid_renaming_method_parameters');

  @override
  bool get finalInForEach => _isLintEnabled('prefer_final_in_for_each');

  @override
  bool get makeLocalsFinal => _isLintEnabled('prefer_final_locals');

  @override
  bool get preferConstDeclarations =>
      _isLintEnabled('prefer_const_declarations');

  @override
  bool get preferIntLiterals => _isLintEnabled('prefer_int_literals');

  @override
  String get preferredQuoteForStrings => _lintQuote() ?? "'";

  @override
  bool get requiredNamedParametersFirst =>
      _isLintEnabled('always_put_required_named_parameters_first');

  @override
  bool get sortCombinators => _isLintEnabled('combinators_ordering');

  @override
  bool get sortConstructorsFirst => _isLintEnabled('sort_constructors_first');

  @override
  bool get sortUnnamedConstructorsFirst =>
      _isLintEnabled('sort_unnamed_constructors_first');

  @override
  bool get specifyReturnTypes =>
      _isLintEnabled('always_declare_return_types') || specifyTypes;

  @override
  bool get specifyTypes => _isLintEnabled('always_specify_types');

  @override
  bool get usePackageUris => _isLintEnabled('always_use_package_imports');

  @override
  bool get useRelativeUris => _isLintEnabled('prefer_relative_imports');

  @override
  String preferredQuoteForUris(Iterable<NamespaceDirective> directives) {
    var lintQuote = _lintQuote();
    if (lintQuote != null) {
      return lintQuote;
    }
    var singleCount = 0;
    var doubleCount = 0;

    void add(SimpleStringLiteral literal) {
      var lexeme = literal.literal.lexeme;
      if (lexeme.startsWith('"')) {
        doubleCount++;
      } else {
        singleCount++;
      }
    }

    for (var directive in directives) {
      var uri = directive.uri;
      if (uri is SimpleStringLiteral) {
        add(uri);
      } else if (uri is AdjacentStrings) {
        for (var string in uri.strings) {
          if (string is SimpleStringLiteral) {
            add(string);
          }
        }
      }
    }
    return doubleCount > singleCount ? '"' : "'";
  }

  /// Returns whether the lint rule with the given [name] is enabled.
  bool _isLintEnabled(String name) => options.isLintEnabled(name);

  /// Returns the preferred lint quote, otherwise `null`.
  String? _lintQuote() => _isLintEnabled('prefer_single_quotes')
      ? "'"
      : _isLintEnabled('prefer_double_quotes')
      ? '"'
      : null;
}