Lintje

Lintje 是一个针对 Git 的有见地的代码检查器。它根据一组预配置的规则检查提交信息，这些规则旨在促进人与人之间的沟通。目的是编写2+个月后其他人阅读的提交信息。

• 无需配置。不要花时间配置您的 Git 提交代码检查器，而是采用一组预配置的 规则。
• 便携性。Lintje 是一个为多个 操作系统 构建的 Rust 项目，没有依赖关系。将其放入您的项目即可使用。

文档

访问 Lintje.dev 了解有关 Lintje 的更多信息，以及 Lintje 文档。

• 安装
• 用法
  • Git 钩子
  • Git 别名
• 规则文档
• 配置
• 获取帮助
• 开发文档

示例

假设项目中的最后一个提交是这样的

Fix bug

当运行 lintje 来检查最后一个提交时，输出将是

$ lintje
Error[SubjectCliche]: The subject does not explain the change in much detail
  9a2ae29:1:1: Fix bug
    |
  1 | Fix bug
    | ^^^^^^^ Describe the change in more detail

Error[MessagePresence]: No message body was found
  9a2ae29:3:1: Fix bug
    |
  1 | Fix bug
  2 |
  3 |
    | ^ Add a message body with context about the change and why it was made

Error[BranchNameTicketNumber]: A ticket number was detected in the branch name
  Branch:1: fix-123
  |
  | fix-123
  | ^^^^^^^ Remove the ticket number from the branch name or expand the branch name with more details

1 commit and branch inspected, 3 errors detected

有关更多用法示例，请参阅[用法文档]。

获取帮助

需要帮助 Lintje？发现了一个错误或有问题？

通过 问题跟踪器、讨论、Twitter @tombruijn（私信已开放）或在您能找到我的任何 Slack 团队中与我联系。

开发

设置

在继续之前，请确保已安装 Rust。

cargo build

测试

cargo test

构建

构建所有不同的目标版本需要 Docker，并使用 cross。

要构建所有不同的目标，请运行构建脚本。

rake build

构建输出可以在 dist/ 目录中找到。

发布

在发布之前，所有支持的目标都将被构建。有关构建步骤的更多信息，请参阅 构建。

要发布所有不同的目标，请运行发布脚本。

rake release

发布内容将被推送到 GitHub。

最后更新 Lintje Homebrew tap。

行为准则

本项目有一个 行为准则，并期望贡献者遵守。