https://github.com/simone-viozzi/rusty-todo-md-pre-commit
Pre-commit hook shim for Rusty TODO MD. Fetches prebuilt wheels from PyPI so the hook works without a Rust toolchain. Mirrors upstream tags and is drop-in for `.pre-commit-config.yaml`.
https://github.com/simone-viozzi/rusty-todo-md-pre-commit
pre-commit pre-commit-hook todo
Last synced: 10 days ago
JSON representation
Pre-commit hook shim for Rusty TODO MD. Fetches prebuilt wheels from PyPI so the hook works without a Rust toolchain. Mirrors upstream tags and is drop-in for `.pre-commit-config.yaml`.
- Host: GitHub
- URL: https://github.com/simone-viozzi/rusty-todo-md-pre-commit
- Owner: simone-viozzi
- License: mit
- Created: 2025-08-06T12:36:20.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-11-26T23:30:42.000Z (7 months ago)
- Last Synced: 2026-04-04T06:42:08.919Z (2 months ago)
- Topics: pre-commit, pre-commit-hook, todo
- Language: Shell
- Homepage: https://github.com/simone-viozzi/rusty-todo-md
- Size: 27.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rusty-todo-md-pre-commit
[](https://github.com/simone-viozzi/rusty-todo-md-pre-commit/actions)
[](https://pypi.org/project/rusty-todo-md/)
[](https://pypi.org/project/rusty-todo-md/)
[](LICENSE)
A [pre-commit](https://pre-commit.com/) hook shim for [Rusty TODO.md](https://github.com/simone-viozzi/rusty-todo-md),
installing **prebuilt wheels from PyPI** so you can use it **without a Rust toolchain**.
---
## 🚀 Quick start
Add this to your `.pre-commit-config.yaml`:
```yaml
repos:
- repo: https://github.com/simone-viozzi/rusty-todo-md-pre-commit
rev: v1.10.2
hooks:
- id: rusty-todo-md
```
Then install the hook:
```sh
pre-commit install
```
Now `rusty-todo-md` will run on staged files at commit time.
For CLI usage, configuration options, and advanced examples, see the **[main Rusty TODO.md repository](https://github.com/simone-viozzi/rusty-todo-md)**.
---
## 📦 Requirements
- **Python** ≥ 3.10
- **No Rust toolchain** required if a prebuilt wheel exists for your platform
---
## 🖥️ Supported platforms (prebuilt wheels)
Rusty TODO.md publishes wheels for:
| OS / libc | Architectures |
| --------------------- | ---------------------------------------------- |
| **Linux (manylinux)** | `x86_64`, `x86`, `aarch64`, `armv7`, `ppc64le` |
| **Linux (musllinux)** | `x86_64`, `x86`, `aarch64`, `armv7` |
| **Windows** | `x64`, `x86` |
| **macOS** | `x86_64` (macOS 13), `aarch64` (macOS 14) |
> ✅ Platform coverage may evolve — check [upstream releases](https://github.com/simone-viozzi/rusty-todo-md/releases) for the latest wheel list.
---
## 📌 Why this repo exists
When `pre-commit` runs a hook from a Git repository, it **clones** the repo and runs:
```sh
pip install .
```
This triggers a **source install** of Rusty TODO.md, which would require a Rust toolchain to build from source.
This **shim repository** solves that:
it lists `rusty-todo-md` as a PyPI dependency in its `pyproject.toml`, so `pre-commit` will fetch **prebuilt wheels** from PyPI for your platform — no compilation needed.
Tags in this repository **match upstream tags exactly** and are kept in sync via CI.
---
## 📚 More info
- **Main project** (features, CLI docs, configuration): [github.com/simone-viozzi/rusty-todo-md](https://github.com/simone-viozzi/rusty-todo-md)
- **PyPI package**: [pypi.org/project/rusty-todo-md](https://pypi.org/project/rusty-todo-md)
---
## ⚖️ License
This project is licensed under the [MIT License](LICENSE).