Flutter版本控制插件rw_git的使用

关于rw_git

rw_git是一个git封装工具，它简化了常见的git操作。

功能特性

• ✅ init: 初始化本地GIT目录。如果本地目录不存在，则会创建。
• ✅ clone: 将远程仓库克隆到本地文件夹。如果本地目录不存在，则会创建。
• ✅ checkout: 在指定的现有目录上签出GIT分支。
• ✅ fetchTags: 获取指定仓库的标签列表。
• ✅ getCommitsBetween: 获取两个给定标签之间的提交列表。
• ✅ stats: 获取插入的行数、删除的行数和更改的文件数。

入门指南

在您的pubspec.yaml文件中添加依赖：

dependencies:
  rw_git: 1.0.0

使用方法

初始化RwGit服务

RwGit rwGit = RwGit();

创建一个本地目录并克隆远程仓库

String localDirectoryToCloneInto = _createCheckoutDirectory(localDirectoryName);
rwGit.clone(localDirectoryToCloneInto, repositoryToClone);

获取所有标签

List<String> tags = await rwGit.fetchTags(localDirectoryToCloneInto);
print("Number of tags: ${tags.length}");

获取两个标签之间的所有提交

List<String> listOfCommitsBetweenTwoTags = await rwGit.getCommitsBetween(localDirectoryToCloneInto, oldTag, newTag);
print("Number of commits between $oldTag and $newTag: ${listOfCommitsBetweenTwoTags.length}");

获取代码变更统计信息

ShortStatDto shortStatDto = await rwGit.stats(localDirectoryToCloneInto, oldTag, newTag);
print('Number of lines inserted: ${shortStatDto.insertions}'
      ' Number of lines deleted: ${shortStatDto.deletions}'
      ' Number of files changed: ${shortStatDto.numberOfChangedFiles}');

示例代码完整版

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

void main() async {
  // Initialize RwGit service.
  final rwGit = RwGit();

  // Initializations.
  final localDirectoryName = "RW_GIT";
  final oldTag = "v6.0.8";
  final newTag = "v7.0.0";
  final repositoryToClone =
      "https://github.com/jasontaylordev/CleanArchitecture";

  // Create a local directory and clone into it.
  String localDirectoryToCloneInto =
      _createCheckoutDirectory(localDirectoryName);
  rwGit.clone(localDirectoryToCloneInto, repositoryToClone);

  // Retrieve and count all the tags.
  List<String> tags = await rwGit.fetchTags(localDirectoryToCloneInto);
  print("Number of tags: ${tags.length}");

  // Count all commits between two tags.
  List<String> listOfCommitsBetweenTwoTags =
      await rwGit.getCommitsBetween(localDirectoryToCloneInto, oldTag, newTag);
  print(
      "Number of commits between $oldTag and $newTag: ${listOfCommitsBetweenTwoTags.length}");

  // Retrieve lines of code inserted, deleted and number of changed files.
  ShortStatDto shortStatDto =
      await rwGit.stats(localDirectoryToCloneInto, oldTag, newTag);
  print('Number of lines inserted: ${shortStatDto.insertions}'
      ' Number of lines deleted: ${shortStatDto.deletions}'
      ' Number of files changed: ${shortStatDto.numberOfChangedFiles}');
}

/// Creates the directory where the repository will be checked out,
/// If the directory already exists, it will delete it along with any content inside
/// and a new one will be created.
String _createCheckoutDirectory(String directoryName) {
  Directory checkoutDirectory = Directory(directoryName);
  try {
    checkoutDirectory.deleteSync(recursive: true);
  } catch (e) {
    // Handle the exception
  }
  checkoutDirectory.createSync();

  return "${Directory.current.path}\\$directoryName";
}

额外信息

如果您遇到任何问题，请在GitHub issue tracker上提交。

希望这些信息对您有所帮助！如果您有任何疑问或需要进一步的帮助，请随时提问。