whisky

whisky

轻量级 Git 钩子管理工具 助力团队代码质量把控

Whisky 是一个框架无关的命令行工具,专门用于管理和执行 PHP 项目的 Git 钩子。该工具通过简单的 JSON 配置文件,允许开发团队统一设置 pre-commit 和 pre-push 等钩子,实现代码自动格式化和测试。Whisky 支持全局和项目级安装,适用于各种规模的开发团队,有效确保代码质量标准的一致性。

WhiskyGit钩子PHP项目命令行工具代码质量Github开源项目
<p align="center"><img src="https://yellow-cdn.veclightyear.com/2b54e442/bdde4b72-eebe-4fd0-bfa2-4a7e474dca88.svg" width="75%" alt="Whisky 标志"></p> <p align="center"><img src="https://yellow-cdn.veclightyear.com/2b54e442/c172c5df-29a7-4cab-9937-d56f12544d76.png" width="75%" alt="Whisky 终端示例"></p>

Packagist 上的最新版本 GitHub 测试操作状态 GitHub 代码风格操作状态 GitHub 静态分析操作状态 总下载量

简介

Whisky 是最简单的、框架无关的 CLI 工具,用于管理和执行整个团队的 PHP 项目 git 钩子。

Git 钩子是确保进入版本控制的代码满足组织代码质量标准的绝佳工具。然而,.git/hooks 并不包含在 git 树中。这使得让所有项目贡献者使用相同的检查和相同的设置变得不切实际。

安装

Whisky 的唯一依赖是 php^8.1

你可以通过 composer 安装该包:

composer require --dev projektgopher/whisky ./vendor/bin/whisky install

这是推荐的方法,因为项目中的每个开发者都将可以使用该工具。

全局安装

Whisky 可以全局安装,但这意味着如果项目中的任何开发者想要使用它,他们也需要全局安装。

composer global require projektgopher/whisky whisky install

如果 Whisky 在项目中同时全局和本地安装,运行的版本将取决于如何调用命令。

使用方法

install 命令将在项目根目录创建一个 whisky.json 文件:

// whisky.json { "disabled": [], "hooks": { "pre-commit": [ "./vendor/bin/pint --dirty" ], "pre-push": [ "php artisan test" ] } }

有关支持的 git 钩子的完整列表,请参阅 Git 文档

警告 所有钩子都会按原样在终端中执行。在提交涉及 whisky.json 更改的内容时请记住这一点。

whisky.json 文件中添加或删除任何钩子(而不是单个命令)后,应该执行 ./vendor/bin/whisky update 以确保这些更改反映在你的 .git/hooks 目录中。

自动更新钩子

虽然我们建议将 Whisky 作为一个"选择加入"的工具,但通过添加几个 Composer 脚本,我们可以确保所有项目贡献者使用一致的 git 钩子。这将强制项目中的每个人使用 Whisky:

// composer.json // ... "scripts": { "post-install-cmd": [ "whisky update" ], "post-update-cmd": [ "whisky update" ] } // ...

跳过钩子

有时你需要在不运行 git 钩子的情况下提交或推送更改, 比如当你要将工作转移到另一台计算机时。这通常可以通过使用 git 的原生 --no-verify 标志来完成。

git commit -m "wip" --no-verify

然而,某些 git 操作不支持此标志,比如 git merge --continue。 在这种情况下,运行以下命令将产生完全相同的效果。

./vendor/bin/whisky skip-once

注意 通过在你的 bash.rc 文件中添加 alias whisky=./vendor/bin/whisky,你可以缩短此命令的长度。

禁用钩子

将钩子的名称添加到 whisky.json 中的 disabled 数组中将禁用该钩子的运行。 这在构建尚未准备好供团队其他成员使用的工作流时很有用。

高级用法

对于比简单终端命令更复杂的操作,建议在项目根目录创建一个 scripts 目录。这还有一个额外的好处,即允许你运行用任何语言编写的脚本。

// whisky.json // ... "pre-push": [ "composer lint", "rustc ./scripts/complicated_thing.rs" ] // ...

注意 在执行此操作时,请确保引用的任何脚本都是可执行的:

chmod +x ./scripts/*

测试

# 运行测试套件 composer test # 无需进行虚拟提交即可测试钩子 git hook run pre-commit

故障排除

如果你同时在本地全局安装了 Whisky,并且你的钩子被运行了两次,请尝试从其中一个安装中卸载 Whisky 的钩子。

# 移除全局 Whisky 钩子,保留本地钩子, # 同时保留项目根目录中的 `whisky.json`。 whisky uninstall -n

贡献

注意 在贡献时不要构建二进制文件。二进制文件将在发布标记时构建。

请查看 CONTRIBUTING 以获取更多详细信息。

安全漏洞

请查看我们的安全策略,了解如何报告安全漏洞。

致谢

非常感谢 EXACTsports 对本包开发的支持。

许可证

MIT 许可证 (MIT)。请查看 许可证文件 以获取更多信息。

编辑推荐精选

讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

TRELLIS

TRELLIS

用于可扩展和多功能 3D 生成的结构化 3D 潜在表示

TRELLIS 是一个专注于 3D 生成的项目,它利用结构化 3D 潜在表示技术,实现了可扩展且多功能的 3D 生成。项目提供了多种 3D 生成的方法和工具,包括文本到 3D、图像到 3D 等,并且支持多种输出格式,如 3D 高斯、辐射场和网格等。通过 TRELLIS,用户可以根据文本描述或图像输入快速生成高质量的 3D 资产,适用于游戏开发、动画制作、虚拟现实等多个领域。

下拉加载更多