autohooks-plugin-ruff

一个autohooks插件，用于通过ruff进行Python代码格式化。

安装

使用pip安装

[注意] 由于PEP 668，新发行版（如Ubuntu >= 23.04）中的pip install命令不再直接工作。

您可以使用pip从Python包索引安装autohooks-plugin-ruff的最新稳定版本。

python3 -m pip install --user autohooks-plugin-ruff

使用poetry安装

强烈建议使用poetry来维护项目的依赖项。通常autohooks-plugin-ruff作为开发依赖项安装。

poetry add --group dev autohooks-plugin-ruff

用法

要激活ruff自动钩子插件，请运行

poetry run autohooks plugins add autohooks.plugins.ruff

或者，您可以添加以下设置到您的pyproject.toml文件中。

[tool.autohooks]
pre-commit = ["autohooks.plugins.ruff"]

该插件实际上在git提交上执行ruff check .，因此您应该能够使用与ruff文档中相同的设置。

注意

此项目仅作为预提交钩子运行ruff，因此，ruff的所有功能都应可用。

要激活此预提交钩子，请记住在开始之前运行此命令

poetry run autohooks activate --mode poetry

维护者

此项目由Greenbone AG维护。

贡献

我们非常欢迎您的贡献。请在GitHub上创建一个pull request。较大的更改需要先通过GitHub上的问题部分与开发团队讨论。

许可证

版权 (C) 2023 - 2024 Greenbone AG

根据GNU通用公共许可证v3.0或更高版本许可。