Dart扩展提示一招解决，牛叉！

2023-08-01 10:58:06

提升 Dart 开发效率的秘诀：analyzer_plugin

作为一名 Dart 开发者，你可能遇到过 IDE 代码提示不足的情况，影响了你的开发效率。现在，你可以通过 analyzer_plugin 来解决这个问题，它是一种强大的 Dart 插件，让你能够自定义 Lint 和扩展提示，从而显著提升你的开发体验。

什么是 analyzer_plugin？

analyzer_plugin 是一款 Dart 插件，允许你根据自己的需要定制 Lint 和扩展提示。Lint 是一种代码检查工具，可帮助你识别代码中的错误和警告。扩展提示是一种代码提示工具，可以让你快速高效地输入代码。

自定义 Lint

要自定义 Lint，你可以创建一个继承自 LintRule 的类。在这个类中，你需要实现 lint 方法，它将对代码进行检查并返回错误或警告。例如，你可以创建一个 LintRule 来检查变量是否未初始化：

import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer_plugin/utilities/lint_rule_visitor.dart';

class UninitializedVariableLintRule extends LintRule {
  static const String ruleId = 'uninitialized_variable';

  @override
  List<Lint> getLints(ResolvedUnitResult result) {
    var errors = <Lint>[];
    var visitor = UninitializedVariableLintVisitor(errors);
    result.unit.visitChildren(visitor);
    return errors;
  }
}

class UninitializedVariableLintVisitor
    extends LintRuleVisitor<List<Lint>> {
  UninitializedVariableLintVisitor(List<Lint> errors) : super(errors);

  @override
  void visitSimpleIdentifier(SimpleIdentifier node) {
    if (node.inDeclarationContext() || node.inSetterContext()) {
      return;
    }

    var element = node.staticElement;
    if (element is VariableElement && element.initializer == null) {
      errors.add(Lint(
        ruleId,
        node.offset,
        node.length,
        'Variable ${element.name} is not initialized.',
      ));
    }
  }
}

扩展提示

要扩展提示，你可以创建一个继承自 CompletionContributor 的类。在这个类中，你需要实现 computeSuggestions 方法，它将为代码提供提示。例如，你可以创建一个 CompletionContributor 来提供变量提示：

import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer_plugin/utilities/completion/completion_target.dart';
import 'package:analyzer_plugin/utilities/completion/completion_target_range.dart';
import 'package:analyzer_plugin/utilities/completion/dart/completion_proposal.dart';
import 'package:analyzer_plugin/utilities/completion/dart/op_type.dart';

class VariableCompletionContributor implements CompletionContributor {
  @override
  Future<List<CompletionProposal>> computeSuggestions(
      CompletionTarget target) async {
    var suggestions = <CompletionProposal>[];
    var range = target.targetRange;
    var node = target.node;
    if (node is SimpleIdentifier) {
      var type = node.staticType;
      if (type != null) {
        for (var variable in type.fields) {
          suggestions.add(DartCompletionProposal(
            range,
            OpType.LITERAL,
            variable.name,
            variable.type.displayName,
          ));
        }
      }
    }
    return suggestions;
  }
}

插件开发

要开发一个插件，你可以创建一个继承自 Plugin 的类。在这个类中，你需要实现 registerExtensions 方法，它将注册 Lint 和扩展提示。例如，你可以创建一个插件来注册上面的 LintRule 和 CompletionContributor：

import 'package:analyzer/dart/analysis/context/analysis_context.dart';
import 'package:analyzer_plugin/utilities/plugins/analysis_plugin.dart';
import 'package:uninitialized_variable_lint_rule/uninitialized_variable_lint_rule.dart';
import 'package:variable_completion_contributor/variable_completion_contributor.dart';

class MyPlugin extends AnalysisPlugin {
  @override
  void registerExtensions(RegisterExtensionCallback callback) {
    callback.registerLint(UninitializedVariableLintRule());
    callback.registerCompletionContributor(VariableCompletionContributor());
  }
}