prefligit
| Crates.io | prefligit |
| lib.rs | prefligit |
| version | |
| source | src |
| created_at | 2024-12-03 04:12:56.354146 |
| updated_at | 2024-12-09 09:41:27.183853 |
| description | pre-commit implemeneted in Rust |
| homepage | https://github.com/j178/prefligit |
| repository | https://github.com/j178/prefligit |
| max_upload_size | |
| id | 1469649 |
| Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Jo (j178)
documentation
README
prefligit
A reimplementation of the pre-commit tool in Rust, designed to be a faster, dependency-free and drop-in alternative, while also providing some additional opinionated features.
[!WARNING] This project is still in very early development, only a few of the original pre-commit features are implemented. It is not recommended for normal use yet, but feel free to try it out and provide feedback.
[!NOTE] This project was previously named
pre-commit-rs, but it was renamed toprefligitto prevent confusion with the existing pre-commit tool. See #73 for more information.
Features
- A single binary with no dependencies, does not require Python or any other runtime.
- Improved performance in hook preparation and execution.
- Fully compatible with the original pre-commit configurations and hooks.
- Integration with
uvfor managing Python tools and environments. - (TODO) Built-in support for monorepos.
- (TODO) Built-in implementation of some common hooks.
Installation
Standalone installer
prefligit provides a standalone installer script to download and install the tool:
# On Linux and macOS
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/j178/prefligit/releases/download/v0.0.7/prefligit-installer.sh | sh
# On Windows
powershell -ExecutionPolicy ByPass -c "irm https://github.com/j178/prefligit/releases/download/v0.0.7/prefligit-installer.ps1 | iex"
PyPI
prefligit is published as Python binary wheel to PyPI, you can install it using pip, uv (recommended), or pipx:
pip install prefligit
# or
uv tool install prefligit
# or
pipx install prefligit
Homebrew
brew install j178/tap/prefligit
Cargo
Build from source using Cargo:
cargo install --locked prefligit
Install from the binary directly using cargo binstall:
cargo binstall prefligit
GitHub Releases
prefligit release artifacts can be downloaded directly from the GitHub releases.
Usage
This tool is designed to be a drop-in replacement for the original pre-commit tool, so you can use it with your existing configurations and hooks.
Please refer to the official documentation for more information on how to configure and use pre-commit.
Acknowledgements
This project is heavily inspired by the original pre-commit tool, and it wouldn't be possible without the hard work of the maintainers and contributors of that project.
And a special thanks to the Astral team for their remarkable projects, particularly uv, from which I've learned a lot on how to write efficient and idiomatic Rust code.