Flutter版本管理辅助插件phntmxyz_bump_version_sidekick_plugin的使用

Flutter版本管理辅助插件phntmxyz_bump_version_sidekick_plugin的使用

描述

phntmxyz_bump_version_sidekick_plugin 是一个用于 sidekick 命令行工具的插件，主要功能包括：

• 升级包的版本（主版本、次版本、修订版本）
• 可选地提交版本升级
• 提供修改API来调整其他文件（例如 CHANGELOG.md）

安装

先决条件

1. 安装 sidekick：

   dart pub global activate sidekick
   

2. 生成自定义的 sidekick CLI：

   sidekick init
   

安装插件到自定义的 sidekick CLI 类似于使用 pub 工具安装包。

从 pub.dev 安装此插件

your_custom_sidekick_cli sidekick plugins install phntmxyz_bump_version_sidekick_plugin

使用方法

your_custom_sidekick_cli bump_version [package-path] [--minor|patch|major] --[no-]commit

• package-path：包含 pubspec.yaml 文件的文件夹路径，该文件的版本将被升级。如果未提供此参数，默认为 mainProject，若未定义 mainProject，则默认为当前目录。
• 必须指定 --minor、--patch 或 --major 之一，以控制如何升级版本。例如，当前版本为 1.2.3，选择 --minor 将更新为 1.3.0。
• 如果提供了 --commit 参数，版本升级将自动提交。

修改API

以下是一个示例，展示如何使用修改API来更新 README.md 文件中的版本号：

// 添加命令并注册修改函数
runner..addCommand(BumpVersionCommand()..addModification(bumpChangelog));

// 修改函数实现
Future<void> bumpChangelog(DartPackage package, Version oldVersion, Version newVersion) async {
  // 获取 README.md 文件
  final readme = package.root.file('README.md');
  
  // 读取文件内容
  final content = readme.readAsStringSync();
  
  // 定义正则表达式匹配版本号
  final versionRegex = RegExp(r'my_package: \^(.+)');
  
  // 替换版本号
  final update = content.replaceFirst(versionRegex, 'my_package: ^${newVersion.canonicalizedVersion}');
  
  // 写入更新后的内容
  readme.writeAsStringSync(update);
}

许可证

Copyright 2023 phntm GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

完整示例Demo

假设你已经安装了 sidekick 并生成了自定义的 sidekick CLI，以下是完整的使用步骤和示例代码。

1. 安装插件

   your_custom_sidekick_cli sidekick plugins install phntmxyz_bump_version_sidekick_plugin
   

2. 创建一个简单的Flutter项目

   flutter create my_project
   cd my_project
   

3. 初始化 sidekick

   sidekick init
   

4. 升级版本

   your_custom_sidekick_cli bump_version --minor --commit
   

5. 查看 pubspec.yaml 文件 确认版本号已更新，例如从 1.0.0 更新为 1.1.0。

6. 使用修改API更新 README.md 在 sidekick_cli 项目的 lib/commands/bump_version_command.dart 文件中添加以下代码：

   import 'package:sidekick_core/sidekick_core.dart';
   import 'package:phntmxyz_bump_version_sidekick_plugin/phntmxyz_bump_version_sidekick_plugin.dart';
   
   class BumpVersionCommand extends Command {
     @override
     String get name => 'bump_version';
   
     @override
     String get description => 'Bumps the version of the package';
   
     BumpVersionCommand() {
       argParser.addFlag('commit', negatable: true, defaultsTo: false);
       argParser.addOption('level', allowed: ['major', 'minor', 'patch']);
     }
   
     @override
     Future<void> run() async {
       final level = argResults!['level'] as String;
       final commit = argResults!['commit'] as bool;
   
       runner..addCommand(BumpVersionCommand()..addModification(bumpChangelog));
   
       await runner.run(['bump_version', '.', '--$level', if (commit) '--commit']);
     }
   }
   
   Future<void> bumpChangelog(DartPackage package, Version oldVersion, Version newVersion) async {
     final readme = package.root.file('README.md');
     final content = readme.readAsStringSync();
   
     final versionRegex = RegExp(r'my_package: \^(.+)');
     final update = content.replaceFirst(versionRegex, 'my_package: ^${newVersion.canonicalizedVersion}');
     readme.writeAsStringSync(update);
   }
   

7. 运行命令

   your_custom_sidekick_cli bump_version --minor --commit