Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/workflows/linting.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ jobs:
- name: 🚀 Run ruff formatter
run: uv run ruff format --check .

pre-commit-hooks:
name: Pre-commit hooks
prek-hooks:
name: Prek hooks
runs-on: ubuntu-latest
steps:
- name: ⤵️ Check out code from GitHub
Expand All @@ -45,14 +45,14 @@ jobs:
- name: 🏗 Install project dependencies
run: uv sync --all-extras --dev
- name: 🚀 Check Python AST
run: uv run pre-commit run check-ast --all-files
run: uv run prek run check-ast --all-files
- name: 🚀 Check for case conflicts
run: uv run pre-commit run check-case-conflict --all-files
run: uv run prek run check-case-conflict --all-files
- name: 🚀 Check docstring is first
run: uv run pre-commit run check-docstring-first --all-files
run: uv run prek run check-docstring-first --all-files
- name: 🚀 Detect Private Keys
run: uv run pre-commit run detect-private-key --all-files
run: uv run prek run detect-private-key --all-files
- name: 🚀 Check End of Files
run: uv run pre-commit run end-of-file-fixer --all-files
run: uv run prek run end-of-file-fixer --all-files
- name: 🚀 Trim Trailing Whitespace
run: uv run pre-commit run trailing-whitespace --all-files
run: uv run prek run trailing-whitespace --all-files
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,26 @@ You need the following tools to get started:
uv sync
```

3. Setup the pre-commit check, you must run this inside the virtual environment
3. Setup the prek check, you must run this inside the virtual environment

```bash
uv run pre-commit install
uv run prek install
```

### Run pre-commit checks
### Run prek checks

As this repository uses the [pre-commit][pre-commit] framework, all changes
As this repository uses the [prek][prek] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:

```bash
uv run pre-commit run --all-files
uv run prek run --all-files
```

To manual run only on the staged files, use the following command:

```bash
uv run pre-commit run
uv run prek run
```

## License
Expand All @@ -64,7 +64,7 @@ Distributed under the **MIT** License. See [`LICENSE`](LICENSE) for more informa
<!-- LINK -->
[uv]: https://docs.astral.sh/uv/
[Python]: https://www.python.org/
[pre-commit]: https://pre-commit.com/
[prek]: https://prek.j178.dev/

[rhfest-shield]: https://github.com/RotorHazard/plugin-template/actions/workflows/rhfest.yaml/badge.svg
[rhfest-url]: https://github.com/RotorHazard/plugin-template/actions/workflows/rhfest.yaml
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ dependencies = []

[dependency-groups]
dev = [
"pre-commit==4.6.0",
"pre-commit-hooks==6.0.0",
"prek==0.4.0",
"ruff==0.15.13",
]

Expand Down
Loading
Loading