Lib.rs

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

使用方法

准备仓库

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

git init .
git mit-install

这是通过在仓库的钩子目录中创建符号链接来实现的。您可以通过将它们添加到您的 init 模板 来自动完成此操作。这是 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 = "[email protected]"

[bt]
name = "Billie Thompson"
email = "[email protected]"
signingkey = "0A46826A"

[se]
name = "Someone Else"
email = "[email protected]"

然后，下次您提交时

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包一起安装。您不需要做任何事情来激活它们。

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

文档

常见任务

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

使用方法

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