Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j178/prefligit
pre-commit re-implemented in Rust
https://github.com/j178/prefligit
Last synced: 5 days ago
JSON representation
pre-commit re-implemented in Rust
- Host: GitHub
- URL: https://github.com/j178/prefligit
- Owner: j178
- License: mit
- Created: 2024-10-07T08:21:29.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-12-19T04:15:54.000Z (6 days ago)
- Last Synced: 2024-12-19T05:20:34.704Z (5 days ago)
- Language: Rust
- Homepage:
- Size: 609 KB
- Stars: 57
- Watchers: 3
- Forks: 5
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# prefligit
[](https://github.com/j178/prefligit/actions/workflows/ci.yml)
A reimplementation of the [pre-commit](https://pre-commit.com/) 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 to `prefligit` to prevent confusion with the existing pre-commit tool.
> See [#73](https://github.com/j178/prefligit/issues/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 [`uv`](https://github.com/astral-sh/uv) for 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:
```console
# 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`:
```console
pip install prefligit
# or
uv tool install prefligit
# or
pipx install prefligit
```
### Homebrew
```console
brew install j178/tap/prefligit
```
### Cargo
Build from source using Cargo:
```console
cargo install --locked prefligit
```
Install from the binary directly using `cargo binstall`:
```console
cargo binstall prefligit
```
### GitHub Releases
`prefligit` release artifacts can be downloaded directly from the [GitHub releases](https://github.com/j178/prefligit/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](https://pre-commit.com/) for more information on how to configure and use pre-commit.
## Acknowledgements
This project is heavily inspired by the original [pre-commit](https://pre-commit.com/) 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](https://github.com/astral-sh) team for their remarkable projects, particularly [uv](https://github.com/astral-sh/uv),
from which I've learned a lot on how to write efficient and idiomatic Rust code.