Flutter硬编码字符串管理插件hardcoded_strings的使用

Flutter硬编码字符串管理插件hardcoded_strings的使用

安装

要安装此插件，你需要在你的pubspec.yaml文件中添加它，如下所示：

dev_dependencies:
  custom_lint:
  hardcoded_strings:

然后，在你的analysis_options.yaml文件中添加：

linter:
  plugins:
    - custom_lint

首次运行

为了使插件开始工作，你首先需要下载本地化资源。你可以通过以下命令来完成：

flutter pub run hardcoded_strings -a <YOUR-API-KEY>

所有你在工作区中的键将被下载并保存到一个名为ditto_keys.json的文件中，该文件会被插件读取。

配置

你可以通过在analysis_options.yaml文件中添加一些键来配置此插件。可用的键如下所示，并且它们都是可选的。

hardcoded_strings:
  # 整数值定义需要评估的字符串的最小长度
  min_lint_length: 0
  # 下面的所有键都接受值 (info, warning, error)
  lint_levels:
    # 指定如何处理无效的Ditto关键字（即，不在第一次运行生成的文件中的键）
    invalid_ditto_keyword: error
    # 指定如何处理小部件中的硬编码字符串
    hardcoded_string: warning

示例代码

以下是使用hardcoded_strings插件的一个简单示例。

pubspec.yaml

dev_dependencies:
  custom_lint:
  hardcoded_strings:

analysis_options.yaml

linter:
  plugins:
    - custom_lint

hardcoded_strings:
  min_lint_length: 0
  lint_levels:
    invalid_ditto_keyword: error
    hardcoded_string: warning

主应用文件 main.dart

import 'package:flutter/material.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Hardcoded Strings Example'),
        ),
        body: Center(
          child: Text('This is a hardcoded string.'),
        ),
      ),
    );
  }
}