Flutter版本控制插件better_commit的使用

简介

Better Commit 是一个基于AI的Dart包，它可以根据你的代码更改生成有意义的提交消息。相比于手动输入简单的提交信息，这个工具可以帮助你创建更加规范和详细的提交日志。

示例对比

Before 使用前:

git commit -m "update version"

After 使用后:

git commit -m "🚀 [RELEASE] Update version to 1.4.0" -m "Update version number in pubspec.yaml and changelog."

安装步骤

首先需要全局安装 better_commit 插件：

dart pub global activate better_commit

快速上手指南

1. 获取API Key

使用Google AI Dart SDK需要一个API密钥。请访问官方文档获取并创建一个API Key。

2. 设置API Key

根据操作系统设置环境变量：

Linux 和 MacOS:
```
export GOOGLE_API_KEY="your_api_key"
```
要永久保存此设置，请将其添加到 ~/.zshrc 或 ~/.bashrc 文件中。
Windows:
```
set GOOGLE_API_KEY=your_api_key
```
要永久保存此设置，请将其添加到系统的环境变量中。

3. 开始使用

准备好之后，只需将更改加入暂存区然后运行：

git add .
better-commit

AI会分析你的更改并为你生成一个提交信息。

自定义提交信息

向AI建议一条信息

如果你想为AI提供更多的上下文，可以使用 -sm 参数或者 --suggest-message 标志：

better-commit -sm "Your suggested message"
better-commit --suggest-message

强制使用自定义信息

如果你希望强制AI使用你的提交信息，可以使用 -fm 参数或 --force-message 标志：

better-commit -fm "Your force message"
better-commit --force-message

示例项目

为了更好地理解如何使用 better_commit，你可以参考以下示例：

Cookbook

Usage

准备就绪后，只需将更改加入暂存区然后运行：

git add .
better-commit

AI将会分析你的更改并生成一个提交信息。

自定义提交信息

向AI建议一条信息

如果你想为AI提供更多的上下文，可以使用 -sm 参数或者 --suggest-message 标志：

better-commit -sm "Your suggested message"
better-commit --suggest-message

强制使用自定义信息

如果你希望强制AI使用你的提交信息，可以使用 -fm 参数或 --force-message 标志：

better-commit -fm "Your force message"
better-commit --force-message


通过以上步骤，你可以轻松地在Flutter项目中集成并使用 `better_commit` 来自动化生成高质量的Git提交信息。这不仅提高了效率，也使得项目的版本历史更加清晰明了。

更多关于Flutter版本控制插件better_commit的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

htzhanglong 1楼•2 天前

更多关于Flutter版本控制插件better_commit的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

在Flutter项目中，better_commit 插件并不是官方或广泛认可的版本控制插件。通常，Flutter开发者使用Git进行版本控制，并结合一些Git钩子（hooks）或CI/CD工具来确保提交信息的规范性和质量。不过，如果你指的是一个自定义的或社区维护的插件用于规范Git提交信息，这里提供一个概念性的示例，展示如何在Flutter项目中结合Git钩子实现类似的功能。

假设你有一个自定义的脚本或工具想要集成到Git提交流程中，以下是一个基本的Git钩子示例，它会在每次提交之前检查提交信息是否符合特定格式。这虽然不是直接使用better_commit插件，但展示了如何在Flutter（或任何Git仓库）中实现版本控制提交信息的规范化。

步骤 1: 创建Git钩子

在你的Flutter项目的根目录下，导航到 .git/hooks 目录。
创建一个名为 commit-msg 的文件（如果不存在）。

cd path/to/your/flutter/project/.git/hooks
touch commit-msg
chmod +x commit-msg

编辑 commit-msg 文件，添加以下内容来检查提交信息：

#!/bin/sh
# .git/hooks/commit-msg

# 读取提交信息文件
COMMIT_MSG_FILE="$1"

# 定义提交信息格式的正则表达式，例如要求以"feat:", "fix:"等开头
PATTERN="^(feat|fix|docs|style|refactor|perf|test|chore|revert): .{1,}"

# 读取提交信息
if ! grep -qE "$PATTERN" "$COMMIT_MSG_FILE"; then
  echo "提交信息不符合规范。请使用以下格式之一:"
  echo "  feat: 新功能"
  echo "  fix: 修复bug"
  echo "  docs: 文档变更"
  echo "  style: 代码格式(不影响代码运行的变动)"
  echo "  refactor: 重构(即不是新增功能，也不是修改bug的代码变动)"
  echo "  perf: 性能改进"
  echo "  test: 增加测试"
  echo "  chore: 构建过程或辅助工具的变动"
  echo "  revert: 回滚之前的提交"
  exit 1
fi

步骤 2: 测试Git钩子

现在，当你尝试进行Git提交时，如果提交信息不符合指定的格式，Git将阻止提交并显示错误信息。

git add .
git commit -m "这是一个不符合规范的提交信息"
# 这将触发commit-msg钩子并阻止提交

步骤 3: 自动化和集成到Flutter工作流

虽然上述步骤已经实现了基本的提交信息规范化，但在实际开发中，你可能希望将这个流程自动化，并集成到你的Flutter项目的CI/CD管道中。这通常涉及到配置如GitHub Actions、GitLab CI、CircleCI等服务，使用这些服务提供的脚本和任务来执行类似的检查。

示例：GitHub Actions 工作流

以下是一个简化的GitHub Actions YAML配置示例，用于在推送代码时检查提交信息：

name: Check Commit Message

on: [push]

jobs:
  check-commit-message:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Check commit message
        run: |
          #!/bin/bash
          COMMIT_MSG=$(git log -1 --pretty=%B)
          PATTERN="^(feat|fix|docs|style|refactor|perf|test|chore|revert): .{1,}"
          if ! [[ $COMMIT_MSG =~ $PATTERN ]]; then
            echo "提交信息不符合规范。请使用以下格式之一:"
            echo "  feat: 新功能"
            echo "  fix: 修复bug"
            echo "  docs: 文档变更"
            echo "  style: 代码格式(不影响代码运行的变动)"
            echo "  refactor: 重构(即不是新增功能，也不是修改bug的代码变动)"
            echo "  perf: 性能改进"
            echo "  test: 增加测试"
            echo "  chore: 构建过程或辅助工具的变动"
            echo "  revert: 回滚之前的提交"
            exit 1
          fi

请注意，上述GitHub Actions配置需要根据你的项目需求进行调整，并且通常你会希望将这个检查集成到一个更复杂的CI/CD管道中。

总之，虽然better_commit插件可能不是标准工具，但通过上述方法，你可以在Flutter项目中实现类似的版本控制提交信息规范化功能。