Flutter文本标记分析插件markup_analyzer的使用

Flutter文本标记分析插件markup_analyzer的使用

描述

MarkupAnalyzer 是 custom_lint 包在 Dart/Flutter 中的一个可定制的 lint 规则。它允许你禁止 Flutter 小部件参数中特定类型的字符串表达式。

此规则使你可以根据配置控制简单字符串字面量、插值、二元表达式等字符串表达式的使用。

安装

1. 添加包到项目依赖中： 在项目的 pubspec.yaml 文件中添加以下内容到 dev_dependencies 下：

   dev_dependencies:
     custom_lint: 
     markup_analyzer: ^latest_version
   

2. 获取依赖项：

   flutter pub get
   

3. 在 analysis_options.yaml 中激活插件： 在项目的根目录下创建或更新 analysis_options.yaml 文件：

   analyzer:
     plugins:
       - custom_lint
   
   custom_lint:
     rules:
       - markup_analyzer
   

配置

你可以通过 analysis_options.yaml 文件来配置 MarkupAnalyzer 规则，指定要禁止的字符串表达类型及其错误级别。

示例配置：

custom_lint:
  rules:
    markup_analyzer:
      simple: true
      prefixed_identifier: false
      interpolation: true
      binary: true
      adjacent: true
      method: false
      simple_identifier: false
      property: false
      function: false
      severity: error  # Possible values: error, warning, info

配置参数：

• simple: 禁止使用简单字符串字面量。
• prefixed_identifier: 禁止使用前缀标识符（例如 widget.title）。
• interpolation: 禁止使用字符串插值（例如 'Hello, $name'）。
• binary: 禁止使用 + 运算符进行字符串拼接的二元表达式。
• adjacent: 禁止使用相邻的字符串字面量（例如 'Hello, ''world'）。
• method: 禁止调用返回字符串的方法（例如 'Hello'.toUpperCase()）。
• simple_identifier: 禁止使用简单标识符（例如变量 title）。
• property: 禁止访问返回字符串的对象属性（例如 object.property）。
• function: 禁止调用返回字符串的函数（例如 getString()）。
• severity: 错误的严重级别。可能的值为：error, warning, info。

使用

在设置好插件并配置了规则后，运行分析器检查你的项目：

dart run custom_lint

所有违反规则的情况都会在控制台中显示，并且如果你的IDE支持 custom_lint，它们也会在IDE中高亮显示。

示例

1. 简单字符串字面量 (simple)

配置：

custom_lint:
rules:
  markup_analyzer:
    simple: true

示例代码：

// BAD
Text('Hello, world!'); // 禁止使用简单字符串字面量。

// GOOD
final greeting = 'Hello, world!';
Text(greeting); // 使用变量代替字面量。

2. 前缀标识符 (prefixed_identifier)

配置：

custom_lint:
rules:
  markup_analyzer:
    prefixed_identifier: true

示例代码：

// BAD
Text(widget.title); // 禁止使用前缀标识符。

// GOOD
final title = widget.title;
Text(title); // 先赋值给本地变量。

3. 字符串插值 (interpolation)

配置：

custom_lint:
rules:
  markup_analyzer:
    interpolation: true

示例代码：

// BAD
Text('Hello, $name!'); // 禁止使用字符串插值。

// GOOD
Text('Hello, ' + name + '!'); // 使用字符串连接。

4. 二元表达式 (binary)

配置：

custom_lint:
rules:
  markup_analyzer:
    binary: true

示例代码：

// BAD
Text('Hello, ' + 'world!'); // 禁止使用 `+` 拼接字符串。

// GOOD
Text('Hello, world!'); // 使用单一字符串字面量。

5. 相邻字符串 (adjacent)

配置：

custom_lint:
rules:
  markup_analyzer:
    adjacent: true

示例代码：

// BAD
Text(
'Hello, '
'world!'
); // 禁止使用相邻字符串。

// GOOD
Text('Hello, world!'); // 合并为一个字符串。

6. 方法调用 (method)

配置：

custom_lint:
rules:
  markup_analyzer:
    method: true

示例代码：

// BAD
Text('hello'.toUpperCase()); // 禁止方法调用。

// GOOD
final upperCaseHello = 'hello'.toUpperCase();
Text(upperCaseHello); // 使用保存结果的变量。

7. 简单标识符 (simple_identifier)

配置：

custom_lint:
rules:
  markup_analyzer:
    simple_identifier: true

示例代码：

// BAD
Text(title); // 禁止使用简单标识符。

// GOOD
Text('Static Title'); // 使用静态字符串字面量。

8. 属性访问 (property)

配置：

custom_lint:
rules:
  markup_analyzer:
    property: true

示例代码：

// BAD
Text(user.name); // 禁止属性访问。

// GOOD
final userName = user.name;
Text(userName); // 先将属性赋值给变量。

9. 函数调用 (function)

配置：

custom_lint:
rules:
  markup_analyzer:
    function: true

示例代码：

// BAD
Text(getGreeting()); // 禁止函数调用。

// GOOD
final greeting = getGreeting();
Text(greeting); // 使用包含结果的变量。

如果配置中包含 simple: true，运行分析器将会产生错误：

dart run custom_lint

完整示例代码

以下是一个完整的示例代码，展示了如何在实际项目中使用 MarkupAnalyzer：

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final String string = 'Hello, World';
  final int counter = 42;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text('Hello, World'),

            // 2. PrefixedIdentifier()
            Text(widget.title), // 假设 widget.title 已定义在 StatefulWidget 中

            // 3. StringInterpolation()
            Text('点击次数: $counter'),

            // 4. BinaryExpression with +
            Text('Hello' ' World'),

            // 5. AdjacentStrings
            Text(
              'Hello, '
              'world!',
            ),

            // 6. MethodInvocation()
            Text('Hello'.toString()),

            // 7. SimpleIdentifier()
            Text(string),

            // 8. FunctionExpressionInvocation or PropertyAccess
            Text(Theme.of(context).textTheme.headlineMedium.toString()),

            // 9. NamedExpression()
            Text(
              '标题',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
    );
  }
}