mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2025-12-12 15:34:50 +08:00
Compare commits
3 Commits
eab558991f
...
4b63ca3a46
| Author | SHA1 | Date | |
|---|---|---|---|
|
4b63ca3a46 | ||
|
|
72acd2ca90 | ||
|
|
5bc432473c |
119
plugins/prek/README.md
Normal file
119
plugins/prek/README.md
Normal file
@ -0,0 +1,119 @@
|
||||
# Prek plugin
|
||||
|
||||
This plugin adds aliases for common commands of [prek](https://prek.j178.dev/).
|
||||
|
||||
**Prek** is a faster, Rust-based drop-in replacement for pre-commit that provides better performance and additional features like workspace support and improved user experience. It's approximately **10x faster** than pre-commit for hook installation and **~7x faster** for execution.
|
||||
|
||||
To use this plugin, add it to the plugins array in your zshrc file:
|
||||
|
||||
```zsh
|
||||
plugins=(... prek)
|
||||
```
|
||||
|
||||
## About Prek
|
||||
|
||||
Prek offers several advantages over pre-commit:
|
||||
|
||||
- **~10x faster** installation and ~7x faster execution
|
||||
- **Single binary** - no Python or runtime dependencies required
|
||||
- **Workspace support** - manage multiple projects with separate configs in monorepos
|
||||
- **Better UX** - improved commands like `prek run --directory` and `prek run --last-commit`
|
||||
- **Drop-in replacement** - uses the same `.pre-commit-config.yaml` configuration
|
||||
|
||||
## Aliases
|
||||
|
||||
### Main Command
|
||||
|
||||
| Alias | Command | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| `pk` | `prek` | The `prek` command |
|
||||
|
||||
### Installation & Setup
|
||||
|
||||
| Alias | Command | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| `pki` | `prek install` | Install the prek git hook |
|
||||
| `pkii` | `prek install --install-hooks` | Install the git hook and hook environments in one command |
|
||||
| `pkih` | `prek install-hooks` | Install hook environments for all hooks in config |
|
||||
|
||||
### Running Hooks
|
||||
|
||||
| Alias | Command | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| `pkr` | `prek run` | Run hooks on staged files |
|
||||
| `pkra` | `prek run --all-files` | Run hooks on all files in the repository |
|
||||
| `pkrf` | `prek run --files` | Run hooks on specific files |
|
||||
| `pkrl` | `prek run --last-commit` | Run hooks on files changed in the last commit |
|
||||
| `pkrd` | `prek run --directory` | Run hooks on files in a specific directory |
|
||||
|
||||
### Management
|
||||
|
||||
| Alias | Command | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| `pku` | `prek uninstall` | Uninstall the prek git hook |
|
||||
| `pkl` | `prek list` | List all available hooks and their descriptions |
|
||||
|
||||
### Updates
|
||||
|
||||
| Alias | Command | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| `pkau` | `prek auto-update` | Auto-update config to the latest repo versions |
|
||||
| `pksu` | `prek self update` | Update prek itself to the latest version |
|
||||
|
||||
### Configuration
|
||||
|
||||
| Alias | Command | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| `pkvc` | `prek validate-config` | Validate `.pre-commit-config.yaml` file |
|
||||
| `pkvm` | `prek validate-manifest` | Validate `.pre-commit-hooks.yaml` file |
|
||||
| `pksc` | `prek sample-config` | Produce a sample `.pre-commit-config.yaml` file |
|
||||
|
||||
### Cache Management
|
||||
|
||||
| Alias | Command | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| `pkcd` | `prek cache dir` | Show the location of the prek cache |
|
||||
| `pkcgc` | `prek cache gc` | Clean unused cached repositories and environments |
|
||||
| `pkcc` | `prek cache clean` | Remove all prek cached data |
|
||||
|
||||
## Usage Examples
|
||||
|
||||
```zsh
|
||||
# Install prek hooks
|
||||
pki
|
||||
|
||||
# Run hooks on all files
|
||||
pkra
|
||||
|
||||
# Run hooks on files changed in the last commit
|
||||
pkrl
|
||||
|
||||
# Run a specific hook
|
||||
pkr ruff
|
||||
|
||||
# Run hooks on files in a specific directory
|
||||
pkrd src/
|
||||
|
||||
# Update hooks to latest versions
|
||||
pkau
|
||||
|
||||
# Clean up unused cache
|
||||
pkcgc
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
First, install prek itself:
|
||||
|
||||
```zsh
|
||||
# Using uv (recommended)
|
||||
uv tool install prek
|
||||
|
||||
# Using pip
|
||||
pip install prek
|
||||
|
||||
# Using Homebrew
|
||||
brew install prek
|
||||
```
|
||||
|
||||
For more installation options, see the [prek installation guide](https://prek.j178.dev/installation/).
|
||||
37
plugins/prek/prek.plugin.zsh
Normal file
37
plugins/prek/prek.plugin.zsh
Normal file
@ -0,0 +1,37 @@
|
||||
# Prek plugin for Oh My Zsh
|
||||
# Description: Adds aliases for prek, a faster drop-in replacement for pre-commit
|
||||
# Author: Based on the pre-commit plugin structure
|
||||
# Repository: https://github.com/j178/prek
|
||||
|
||||
# Main command
|
||||
alias pk='prek'
|
||||
|
||||
# Installation & Setup
|
||||
alias pki='prek install'
|
||||
alias pkii='prek install --install-hooks'
|
||||
alias pkih='prek install-hooks'
|
||||
|
||||
# Running Hooks
|
||||
alias pkr='prek run'
|
||||
alias pkra='prek run --all-files'
|
||||
alias pkrf='prek run --files'
|
||||
alias pkrl='prek run --last-commit'
|
||||
alias pkrd='prek run --directory'
|
||||
|
||||
# Management
|
||||
alias pku='prek uninstall'
|
||||
alias pkl='prek list'
|
||||
|
||||
# Updates
|
||||
alias pkau='prek auto-update'
|
||||
alias pksu='prek self update'
|
||||
|
||||
# Configuration
|
||||
alias pkvc='prek validate-config'
|
||||
alias pkvm='prek validate-manifest'
|
||||
alias pksc='prek sample-config'
|
||||
|
||||
# Cache Management
|
||||
alias pkcd='prek cache dir'
|
||||
alias pkcgc='prek cache gc'
|
||||
alias pkcc='prek cache clean'
|
||||
@ -1,6 +1,7 @@
|
||||
# uv plugin
|
||||
|
||||
This plugin automatically installs [uv](https://github.com/astral-sh/uv)'s completions for you, and keeps them up to date. It also adds convenient aliases for common usage.
|
||||
This plugin automatically installs [uv](https://github.com/astral-sh/uv)'s completions for you,
|
||||
and keeps them up to date. It also adds convenient aliases for common usage.
|
||||
|
||||
To use it, add `uv` to the plugins array in your zshrc file:
|
||||
|
||||
@ -10,20 +11,26 @@ plugins=(... uv)
|
||||
|
||||
## Aliases
|
||||
|
||||
| Alias | Command | Description |
|
||||
|:----- |------------------------------------------------------------------------ |:-------------------------------------------------------------------- |
|
||||
| uva | `uv add` | Add packages to the project |
|
||||
| uvexp | `uv export --format requirements-txt --no-hashes --output-file requirements.txt --quiet` | Export the lock file to `requirements.txt` |
|
||||
| uvl | `uv lock` | Lock the dependencies |
|
||||
| uvlr | `uv lock --refresh` | Rebuild the lock file without upgrading dependencies |
|
||||
| uvlu | `uv lock --upgrade` | Lock the dependencies to the newest compatible versions |
|
||||
| uvp | `uv pip` | Manage pip packages |
|
||||
| uvpy | `uv python` | Manage Python installs |
|
||||
| uvpp | `uv python pin` | Pin the current project to use a specific Python version |
|
||||
| uvr | `uv run` | Run commands within the project's environment |
|
||||
| uvrm | `uv remove` | Remove packages from the project |
|
||||
| uvs | `uv sync` | Sync the environment with the lock file |
|
||||
| uvsr | `uv sync --refresh` | "Force" sync the environment with the lock file (ignore cache) |
|
||||
| uvsu | `uv sync --upgrade` | Sync the environment, allowing upgrades and ignoring the lock file |
|
||||
| uvup | `uv self update` | Update the UV tool to the latest version |
|
||||
| uvv | `uv venv` | Manage virtual environments |
|
||||
| Alias | Command | Description |
|
||||
| :---- | ---------------------------------------------------------------------------------------- | :-------------------------------------------------------------------- |
|
||||
| uva | `uv add` | Add packages to the project |
|
||||
| uvexp | `uv export --format requirements-txt --no-hashes --output-file requirements.txt --quiet` | Export the lock file to `requirements.txt` |
|
||||
| uvi | `uv init` | Initialize a new project in current workspace and environment. |
|
||||
| uvinw | `uv init --no-workspace` | Initialize a new project in a new workspace and environment |
|
||||
| uvl | `uv lock` | Lock the dependencies |
|
||||
| uvlr | `uv lock --refresh` | Rebuild the lock file without upgrading dependencies |
|
||||
| uvlu | `uv lock --upgrade` | Lock the dependencies to the newest compatible versions |
|
||||
| uvp | `uv pip` | Manage pip packages |
|
||||
| uvpi | `uv python install` | Install a specific version of python |
|
||||
| uvpl | `uv python list` | Lists all python version installed |
|
||||
| uvpp | `uv python pin` | Pin the current project to use a specific Python version |
|
||||
| uvpu | `uv python uninstall` | Remove a specific version of python |
|
||||
| uvpy | `uv python` | Manage Python installs |
|
||||
| uvr | `uv run` | Run commands within the project's environment |
|
||||
| uvrm | `uv remove` | Remove packages from the project |
|
||||
| uvs | `uv sync` | Sync the environment with the lock file |
|
||||
| uvsr | `uv sync --refresh` | "Force" sync the environment with the lock file (ignore cache) |
|
||||
| uvsu | `uv sync --upgrade` | Sync the environment, allowing upgrades and ignoring the lock file |
|
||||
| uvtr | `uv tree` | Displays the full dependency tree for the current project environment |
|
||||
| uvup | `uv self update` | Update the UV tool to the latest version |
|
||||
| uvv | `uv venv` | Manage virtual environments |
|
||||
|
||||
@ -7,10 +7,15 @@ alias uv="noglob uv"
|
||||
|
||||
alias uva='uv add'
|
||||
alias uvexp='uv export --format requirements-txt --no-hashes --output-file requirements.txt --quiet'
|
||||
alias uvi='uv init'
|
||||
alias uvinw='uv init --no-workspace'
|
||||
alias uvl='uv lock'
|
||||
alias uvlr='uv lock --refresh'
|
||||
alias uvlu='uv lock --upgrade'
|
||||
alias uvp='uv pip'
|
||||
alias uvpi='uv python install'
|
||||
alias uvpl='uv python list'
|
||||
alias uvpu='uv python uninstall'
|
||||
alias uvpy='uv python'
|
||||
alias uvpp='uv python pin'
|
||||
alias uvr='uv run'
|
||||
@ -18,6 +23,7 @@ alias uvrm='uv remove'
|
||||
alias uvs='uv sync'
|
||||
alias uvsr='uv sync --refresh'
|
||||
alias uvsu='uv sync --upgrade'
|
||||
alias uvtr='uv tree'
|
||||
alias uvup='uv self update'
|
||||
alias uvv='uv venv'
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user