mirror of
https://github.com/j178/prek.git
synced 2026-04-25 02:11:36 +02:00
Update docs (#337)
This commit is contained in:
@@ -2,7 +2,8 @@
|
||||
|
||||
- `prefligit` supports both `.pre-commit-config.yaml` and `.pre-commit-config.yml` configuration files.
|
||||
- `prefligit` implements some common hooks from `pre-commit-hooks` in Rust for better performance.
|
||||
- `prefligit` uses `~/.prefligit` as the default cache directory for toolchains and environments, and stores repos and hooks separately.
|
||||
- `prefligit` uses `~/.prefligit` as the default cache directory for repos, environments and toolchains.
|
||||
- `prefligit` decoupled hook environment from their repositories, allowing shared toolchains and environments across hooks.
|
||||
- `prefligit` uses `uv` for managing Python installations, environments and dependencies.
|
||||
- `prefligit` supports `language-version` as a version specifier and automatically installs the required toolchains.
|
||||
- `prefligit sample-config` command has a `--file` option to write the sample configuration to a specific file.
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
|
||||
<img width="250" alt="prefligit" src="https://github.com/user-attachments/assets/49080cb0-f528-4aa5-acb7-5a88eb9eff4a">
|
||||
|
||||
[pre-commit](https://pre-commit.com/) is a framework to run hooks written in over a dozen languages, and it manages the toolchain and dependencies for running the hooks.
|
||||
[pre-commit](https://pre-commit.com/) is a framework to run hooks written in many languages, and it manages the language toolchain and dependencies for running the hooks.
|
||||
|
||||
`prefligit` is a reimplementation of the tool in Rust, designed to be a faster, dependency-free and drop-in alternative for pre-commit, while also providing some additional opinionated features.
|
||||
`prefligit` is a reimagined version of pre-commit, built in Rust. It is designed to be a faster, dependency-free and drop-in alternative for it, while also providing some additional long-requested features.
|
||||
|
||||
> [!WARNING]
|
||||
> This project is still in early stage of development, only a few of the original pre-commit features are implemented.
|
||||
|
||||
Reference in New Issue
Block a user