mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2026-02-11 05:39:45 +08:00
Compare commits
9 Commits
46da4f843c
...
b87cb0138a
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b87cb0138a | ||
|
|
41c5b9677a | ||
|
|
116be8badd | ||
|
|
9df4ea095f | ||
|
|
1a253c375a | ||
|
|
67cd8c4673 | ||
|
|
0074e724f8 | ||
|
|
db66764f46 | ||
|
|
5bc432473c |
6
.github/workflows/dependencies.yml
vendored
6
.github/workflows/dependencies.yml
vendored
@ -13,12 +13,12 @@ jobs:
|
||||
contents: write # this is needed to push commits and branches
|
||||
steps:
|
||||
- name: Harden the runner (Audit all outbound calls)
|
||||
uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
|
||||
uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
|
||||
with:
|
||||
egress-policy: audit
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Authenticate as @ohmyzsh
|
||||
@ -28,7 +28,7 @@ jobs:
|
||||
app-id: ${{ secrets.OHMYZSH_APP_ID }}
|
||||
private-key: ${{ secrets.OHMYZSH_APP_PRIVATE_KEY }}
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
|
||||
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
|
||||
with:
|
||||
python-version: "3.12"
|
||||
cache: "pip"
|
||||
|
||||
8
.github/workflows/installer.yml
vendored
8
.github/workflows/installer.yml
vendored
@ -26,12 +26,12 @@ jobs:
|
||||
- macos-latest
|
||||
steps:
|
||||
- name: Harden the runner (Audit all outbound calls)
|
||||
uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
|
||||
uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
|
||||
with:
|
||||
egress-policy: audit
|
||||
|
||||
- name: Set up git repository
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
- name: Install zsh
|
||||
if: runner.os == 'Linux'
|
||||
run: sudo apt-get update; sudo apt-get install zsh
|
||||
@ -47,12 +47,12 @@ jobs:
|
||||
- test
|
||||
steps:
|
||||
- name: Harden the runner (Audit all outbound calls)
|
||||
uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
|
||||
uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
|
||||
with:
|
||||
egress-policy: audit
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
- name: Install Vercel CLI
|
||||
run: npm install -g vercel
|
||||
- name: Setup project and deploy
|
||||
|
||||
4
.github/workflows/main.yml
vendored
4
.github/workflows/main.yml
vendored
@ -24,12 +24,12 @@ jobs:
|
||||
if: github.repository == 'ohmyzsh/ohmyzsh'
|
||||
steps:
|
||||
- name: Harden the runner (Audit all outbound calls)
|
||||
uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
|
||||
uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
|
||||
with:
|
||||
egress-policy: audit
|
||||
|
||||
- name: Set up git repository
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
- name: Install zsh
|
||||
run: sudo apt-get update; sudo apt-get install zsh
|
||||
- name: Check syntax
|
||||
|
||||
2
.github/workflows/project.yml
vendored
2
.github/workflows/project.yml
vendored
@ -17,7 +17,7 @@ jobs:
|
||||
if: github.repository == 'ohmyzsh/ohmyzsh'
|
||||
steps:
|
||||
- name: Harden the runner (Audit all outbound calls)
|
||||
uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
|
||||
uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
|
||||
with:
|
||||
egress-policy: audit
|
||||
- name: Authenticate as @ohmyzsh
|
||||
|
||||
6
.github/workflows/scorecard.yml
vendored
6
.github/workflows/scorecard.yml
vendored
@ -36,12 +36,12 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Harden the runner (Audit all outbound calls)
|
||||
uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
|
||||
uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
|
||||
with:
|
||||
egress-policy: audit
|
||||
|
||||
- name: "Checkout code"
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
@ -60,6 +60,6 @@ jobs:
|
||||
retention-days: 5
|
||||
|
||||
- name: "Upload to code-scanning"
|
||||
uses: github/codeql-action/upload-sarif@cdefb33c0f6224e58673d9004f47f7cb3e328b89 # v4.31.10
|
||||
uses: github/codeql-action/upload-sarif@45cbd0c69e560cd9e7cd7f8c32362050c9b7ded2 # v4.32.2
|
||||
with:
|
||||
sarif_file: results.sarif
|
||||
|
||||
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'
|
||||
Loading…
Reference in New Issue
Block a user