Flutter项目结构管理插件flutter_project_structure的使用

Flutter项目结构管理插件flutter_project_structure的使用

Flutter Project Structure 插件介绍

Flutter Project Structure 是一个 Dart 包，用于展示您的 Flutter 项目的当前结构，并在每个 Dart 文件的顶部添加路径注释。该插件提供了多种功能，包括生成项目结构的markdown文件、为每个文件添加路径注释、列出项目中每个文件的导入列表等。

版本信息

请确保检查最新版本以获取所有新功能。您可以查看CHANGELOG.md文件来了解详细信息。

安装步骤

1. 将以下内容添加到您的包的 pubspec.yaml 文件中：

   dependencies:
     flutter_project_structure: ^1.0.2
   

2. 运行以下命令安装依赖项：

   flutter pub get
   

使用方法

您可以通过命令行工具或编程方式使用此插件来生成项目结构。

基础使用

要生成默认设置下的项目结构：

dart run flutter_project_structure

这将分析 lib 目录并生成一个 project_structure.md 文件在项目根目录下。

自定义使用

您可以指定自定义的根目录和输出文件名：

dart run flutter_project_structure --root-dir=src --output=custom_structure.md --no-file-stats --no-todo-comments

这将分析 src 目录并输出结构到 custom_structure.md。

参数选项

• --root-dir 或 -r: 指定要分析的根目录（默认值：‘lib’）
• --output 或 -o: 指定输出文件名（默认值：‘project_structure.md’）
• --file-stats 或 -f: 包含文件统计（默认值：true）
• --todo-comments 或 -t: 包含 TODO 和 FIXME 注释（默认值：true）
• --dependency-analysis 或 -d: 包含依赖分析（默认值：true）
• --code-metrics 或 -m: 包含代码指标（默认值：true）
• --help 或 -h: 显示帮助信息

您可以使用 --no-file-stats, --no-todo-comments, --no-dependency-analysis, 或 --no-code-metrics 来排除特定功能的分析。

程序化使用

您也可以通过Dart代码程序化地使用此插件：

import 'package:flutter_project_structure/flutter_project_structure.dart';

void main() {
  final projectStructure = FlutterProjectStructure(
    rootDir: 'lib',
    outputFile: 'project_structure.md',
    includeFileStats: true,
    includeTodoComments: true,
    includeDependencyAnalysis: true,
    includeCodeMetrics: true,
  );

  projectStructure.generate();
}

示例代码

下面是一个完整的示例代码，展示了如何使用 flutter_project_structure 插件进行项目结构管理。

// example/main.dart
import 'dart:io';

import 'package:flutter_project_structure/flutter_project_structure.dart';
import 'package:path/path.dart' as path;

void main() async {
  print('Flutter Project Structure Example\n');

  // 创建一个示例项目结构
  final projectDir = await createSampleProject();

  // 基础使用
  print('1. 基础使用 (包含所有功能):');
  simpleUsage(projectDir);

  print('\n2. 自定义使用 (选择特定功能):');
  customUsage(projectDir);

  // 清理
  projectDir.deleteSync(recursive: true);
}

void simpleUsage(Directory projectDir) {
  // 创建一个带有默认设置的 FlutterProjectStructure 实例
  final structure = FlutterProjectStructure(
    rootDir: path.join(projectDir.path, 'lib'),
    outputFile: path.join(projectDir.path, 'project_structure.md'),
    includeFileStats: true,
    includeTodoComments: true,
    includeDependencyAnalysis: true,
    includeCodeMetrics: true,
  );

  // 生成项目结构
  structure.generate();

  print('项目结构已生成 ( 包含所有功能.');
  print('请检查项目目录中的 project_structure.md 文件.');

  // 显示生成的结构
  final content = File(path.join(projectDir.path, 'project_structure.md'))
      .readAsStringSync();
  print('\n生成的项目结构:');
  print(content);
}

void customUsage(Directory projectDir) {
  // 创建一个带有自定义设置的 FlutterProjectStructure 实例
  final customStructure = FlutterProjectStructure(
    rootDir: path.join(projectDir.path, 'src'),
    outputFile: path.join(projectDir.path, 'custom_structure.md'),
    includeFileStats: true,
    includeTodoComments: false,
    includeDependencyAnalysis: true,
    includeCodeMetrics: false,
  );

  // 生成项目结构
  customStructure.generate();

  print('自定义项目结构已生成 (选择特定功能).');
  print('请检查项目目录中的 custom_structure.md 文件.');

  // 显示生成的结构
  final content = File(path.join(projectDir.path, 'custom_structure.md'))
      .readAsStringSync();
  print('\n生成的自定义项目结构:');
  print(content);
}

Future<Directory> createSampleProject() async {
  final projectDir =
      Directory.systemTemp.createTempSync('flutter_project_structure_example_');

  // 创建 lib 目录
  final libDir = Directory(path.join(projectDir.path, 'lib'))..createSync();
  File(path.join(libDir.path, 'main.dart')).writeAsStringSync('''
import 'package:flutter/material.dart';
import 'widgets/button.dart';

// TODO: 实现应用初始化
void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: CustomButton(),
        ),
      ),
    );
  }
}
''');

  final widgetsDir = Directory(path.join(libDir.path, 'widgets'))..createSync();
  File(path.join(widgetsDir.path, 'button.dart')).writeAsStringSync('''
import 'package:flutter/material.dart';

// FIXME: 实现适当的样式
class CustomButton extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: () {},
      child: Text('Click me'),
    );
  }
}
''');

  // 创建 src 目录 (用于自定义使用示例)
  final srcDir = Directory(path.join(projectDir.path, 'src'))..createSync();
  File(path.join(srcDir.path, 'utils.dart')).writeAsStringSync('''
import 'dart:math';

class Utils {
  static int generateRandomNumber() {
    return Random().nextInt(100);
  }
}
''');

  print('示例项目创建于: ${projectDir.path}');
  return projectDir;
}