Flutter功能变更插件change的使用

描述

change 是一个用于Dart中的更改日志（Changelog）操作的库。对于命令行工具，请参阅 Cider。

功能特性

• 支持基本的Markdown语法，如加粗、斜体、链接等。
• 对发布版本和更改记录进行CRUD（创建、读取、更新、删除）操作。

限制

• 只适用于遵循 Keep a Changelog 格式的更改日志。
• 隐式支持 语义化版本控制(Semantic Versioning)。
• 日期必须是ISO 8601格式（YYYY-MM-DD）。
• 不支持复杂的Markdown（例如表格、嵌套列表、HTML等）。若需要更好的Markdown支持，可以考虑为 marker 提交PR。

示例代码

以下示例展示了如何解析一个更改日志文件CHANGELOG.md。请确保在项目根目录下运行此代码：dart example/main.dart

import 'dart:io';
import 'package:change/change.dart';

/// 解析并打印更改日志信息
void main() {
  // 创建一个File对象，指向CHANGELOG.md文件
  final file = File('CHANGELOG.md');
  
  // 将文件内容作为字符串读取，并调用parseChangelog函数进行解析
  final log = parseChangelog(file.readAsStringSync());
  
  // 获取所有的发布历史记录，并取出最新的一个版本信息
  final latest = log.history().last;
  
  // 打印更改日志中包含的发布次数
  print('Changelog contains ${log.history().length} releases.');
  
  // 打印最新版本号
  print('The latest version is ${latest.version}');
  
  // 打印最新版本的发布时间
  print('released on ${latest.date}');
  
  // 打印最新版本包含的更改数量
  print('and containing ${latest.changes().length} change(s).');
}

完整示例Demo

为了更好地演示change插件的功能，我们可以创建一个完整的Flutter应用示例，该应用将展示如何加载和显示更改日志信息。

pubspec.yaml配置

首先，在您的pubspec.yaml文件中添加change依赖项：

dependencies:
  flutter:
    sdk: flutter
  change: ^x.x.x  # 请根据实际情况填写版本号

main.dart

接下来，我们将编写一个简单的Flutter界面来展示更改日志信息。

import 'dart:io';
import 'package:flutter/material.dart';
import 'package:change/change.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ChangeLog Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: ChangeLogPage(),
    );
  }
}

class ChangeLogPage extends StatefulWidget {
  @override
  _ChangeLogPageState createState() => _ChangeLogPageState();
}

class _ChangeLogPageState extends State<ChangeLogPage> {
  String _changelogContent = '';
  List<String> _releases = [];

  @override
  void initState() {
    super.initState();
    _loadChangeLog();
  }

  Future<void> _loadChangeLog() async {
    try {
      final file = File('CHANGELOG.md'); // 假设CHANGELOG.md在同一目录下
      final log = parseChangelog(await file.readAsString());
      setState(() {
        _changelogContent = file.readAsStringSync();
        _releases = log.history().map((release) => release.version.toString()).toList();
      });
    } catch (e) {
      setState(() {
        _changelogContent = 'Failed to load changelog.';
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('ChangeLog Demo'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            Expanded(
              child: SingleChildScrollView(
                child: Text(_changelogContent),
              ),
            ),
            SizedBox(height: 20),
            Text('Releases:'),
            ..._releases.map((version) => ListTile(title: Text(version))).toList(),
          ],
        ),
      ),
    );
  }
}

这个示例应用程序会在启动时尝试从本地文件系统加载CHANGELOG.md文件，并将其内容以及所有发布的版本号显示在一个简单的Flutter界面上。通过这种方式，您可以直观地看到change插件如何帮助您处理和展示更改日志数据。