Lib.rs

git-mit 是一组git钩子。它的目的是使结对编程、将问题编号添加到您的提交以及遵循良好的提交信息实践变得无需思考。

用法

准备仓库

此功能通过git钩子实现，因此您需要将这些钩子放在您要使用的git仓库中。

git init .
git mit-install

此功能通过在您的仓库钩子目录中创建一个符号链接来实现。您可以通过将它们添加到您的 初始化模板 来自动执行此操作。这是git在您运行 git init 时用于创建 .git 目录的模板。

git mit-install --scope=global

您还可以在现有仓库上运行此命令，以设置已经检出仓库。您可以使用此命令从主目录递归地重新初始化所有仓库。

find "$HOME" -type d -name .git -exec sh -c 'git init "$1"/..' -- {} \;

代码检查列表

git mit-config lint available

╭───────────────────────────────────┬──────────╮
│ Lint                              ┆ Status   │
╞═══════════════════════════════════╪══════════╡
│ duplicated-trailers               ┆ enabled  │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ pivotal-tracker-id-missing        ┆ disabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ jira-issue-key-missing            ┆ disabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ github-id-missing                 ┆ disabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ subject-not-separated-from-body   ┆ enabled  │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ subject-longer-than-72-characters ┆ enabled  │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ subject-line-not-capitalized      ┆ disabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ subject-line-ends-with-period     ┆ disabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ body-wider-than-72-characters     ┆ enabled  │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ not-conventional-commit           ┆ disabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┤
│ not-emoji-log                     ┆ disabled │
╰───────────────────────────────────┴──────────╯

默认情况下启用确保git正常工作的代码检查

git mit-config lint enabled

╭───────────────────────────────────┬─────────╮
│ Lint                              ┆ Status  │
╞═══════════════════════════════════╪═════════╡
│ duplicated-trailers               ┆ enabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
│ subject-not-separated-from-body   ┆ enabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
│ subject-longer-than-72-characters ┆ enabled │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
│ body-wider-than-72-characters     ┆ enabled │
╰───────────────────────────────────┴─────────╯

您可以在 代码检查页面 上阅读更多详细信息，包括示例

集中代码检查配置

您可以将 .git-mit.toml 或 .git-mit.toml.dist 添加到您的仓库根目录，我们将读取它并尝试启用正确的代码检查（.git-mit.toml 优先）。

我建议您提交 .git-mit.toml.dist 并将 .git-mit.toml 添加到您的 .gitignore，以便于轻松本地重新配置

例如

[mit.lint]
"pivotal-tracker-id-missing" = true

使用此方法可以启用代码检查

git mit-config lint status pivotal-tracker-id-missing

╭────────────────────────────┬─────────╮
│ Lint                       ┆ Status  │
╞════════════════════════════╪═════════╡
│ pivotal-tracker-id-missing ┆ enabled │
╰────────────────────────────┴─────────╯

您可以在 配置页面 上阅读更多关于此的信息

附加问题编号

在项目中，通过将您提交的代码关联回待办事项列表中的问题来帮助同事是一个好习惯。但记住这一点可能会有些麻烦，所以这里有一个命令可以减少输入量。

假设您刚刚为Pivotal Tracker ID [#12321513] 创建了这个出色的 README.md 文件。

# The Best Readme

This is the best readme

如果您运行以下命令：

git mit-relates-to "[#12321513]"

下次您提交代码时

git add README.md
git mit bt
git commit -m "Wrote a great README"

提交信息将包含ID

git show --pretty='format:author: [%an %ae] signed-by: [%GS] 
---
%B' -q

author: [Billie Thompson billie@example.com] signed-by: [] 
---
Wrote a great README

Relates-to: [#12321513]

更多关于此功能的信息，请参阅相关页面

设置作者和共同作者

结对编程是一种很好的编程方式，如果您给予认可，那就更好了。您可以使用 mit 命令来给予认可

按照示例配置您的作者，在 $HOME/.config/git-mit/mit.toml 中创建配置文件

git-mit-config mit example

[ae]
name = "Anyone Else"
email = "anyone@example.com"

[bt]
name = "Billie Thompson"
email = "billie@example.com"
signingkey = "0A46826A"

[se]
name = "Someone Else"
email = "someone@example.com"

然后您可以运行

git mit ae bt se

然后下次您提交代码时，将设置 Co-authored-by 尾部信息为所选作者的首字母缩写。

echo "# Hello, world!" > README.md

git add .
git commit --message="Initial Commit" --quiet
git show --pretty='format:author: [%an %ae] signed-by: [%GS] 
---
%B' -q

author: [Anyone Else anyone@example.com] signed-by: [] 
---
Initial Commit

Co-authored-by: Billie Thompson <billie@example.com>
Co-authored-by: Someone Else <someone@example.com>
Relates-to: [#12321513]

注意，即使我们没有触发它，这里的“相关于”标签也在。这是从页面上的示例中来的，git-mit 会记住您的作者和票号60分钟

有关更多信息，请参阅mit 页面

安装

您可以使用 brew 安装此工具！这是首选的安装方法。

brew install PurpleBooth/repo/git-mit

您也可以使用 Cargo，但这不会安装补全

cargo install git-mit-config
cargo install git-mit
cargo install git-mit-install
cargo install mit-commit-msg
cargo install mit-pre-commit
cargo install mit-prepare-commit-msg

您还可以下载最新的发布版并运行它。

补全

我们为 fish、zsh 和 bash 生成补全。它们与 homebrew 软件包一起安装。您无需执行任何操作即可激活它们。

您还可以从发布页面手动下载它们。

文档

常见任务

• 使用工具的结对编程部分
• 使用工具的问题编号插入部分
• 配置代码检查
• 代码检查列表

用法

• git-mit
• git-mit-config
• git-mit-install
• git-mit-relates-to
• 钩子：mit-commit-msg
• 钩子：mit-pre-commit
• 钩子：mit-prepare-commit-msg