Flutter依赖严格校验插件lint_strict_dependencies的使用

Flutter依赖严格校验插件lint_strict_dependencies的使用

lint_strict_dependencies 是一个用于Flutter应用的简单依赖严格校验插件。

使用

安装

在 pubspec.yaml 文件中添加 lint_strict_dependencies 作为开发依赖：

dev_dependencies:
  lint_strict_dependencies: any

配置

要使用 lint_strict_dependencies，你需要在 strict_dependencies.yaml 文件中添加配置。以下是一个示例配置文件：

rules:
  - module: "ui/components"
    allowReferenceFrom:
      - "ui/pages"
    allowSameModule: true
  - module: "view_models"
    allowReferenceFrom:
      - "ui/pages"
    allowSameModule: false
  - module: "models"
    allowReferenceFrom:
      - "view_models"
      - "ui/pages"
    allowSameModule: false

• module 表示模块名称。
• allowReferenceFrom 列表表示允许从哪些模块引用当前模块。
• allowSameModule 设置为 true 允许模块内部引用，设置为 false 则不允许。

执行校验

运行以下命令来执行依赖校验：

flutter pub run lint_strict_dependencies:main

完整示例

为了更好地理解如何使用 lint_strict_dependencies，我们来看一个完整的示例。

步骤1：创建项目结构

假设我们有一个简单的Flutter项目结构如下：

my_flutter_app/
├── lib/
│   ├── main.dart
│   ├── ui/
│   │   ├── components/
│   │   │   └── component_a.dart
│   │   ├── pages/
│   │   │   └── page_a.dart
│   ├── view_models/
│   │   └── view_model_a.dart
│   └── models/
│       └── model_a.dart
├── pubspec.yaml
└── strict_dependencies.yaml

步骤2：配置 pubspec.yaml

在 pubspec.yaml 文件中添加 lint_strict_dependencies 作为开发依赖：

name: my_flutter_app
description: A new Flutter project.

publish_to: 'none' # Remove this line if you wish to publish to pub.dev

version: 1.0.0+1

environment:
  sdk: ">=2.12.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter

  cupertino_icons: ^1.0.2

dev_dependencies:
  flutter_test:
    sdk: flutter
  lint_strict_dependencies: any

步骤3：配置 strict_dependencies.yaml

在项目根目录下创建 strict_dependencies.yaml 文件，并添加以下内容：

rules:
  - module: "ui/components"
    allowReferenceFrom:
      - "ui/pages"
    allowSameModule: true
  - module: "view_models"
    allowReferenceFrom:
      - "ui/pages"
    allowSameModule: false
  - module: "models"
    allowReferenceFrom:
      - "view_models"
      - "ui/pages"
    allowSameModule: false

步骤4：编写代码

编写一些示例代码以测试依赖关系：

lib/ui/components/component_a.dart:

class ComponentA {}

lib/ui/pages/page_a.dart:

import 'package:my_flutter_app/ui/components/component_a.dart';

class PageA {
  void showComponent() {
    var component = ComponentA();
  }
}

lib/view_models/view_model_a.dart:

import 'package:my_flutter_app/models/model_a.dart';

class ViewModelA {
  void processModel() {
    var model = ModelA();
  }
}

lib/models/model_a.dart:

class ModelA {}

步骤5：运行校验

在终端中运行以下命令来执行依赖校验：

flutter pub run lint_strict_dependencies:main