diff --git a/README.md b/README.md index cc02601..36a5b58 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ # sync-with-uv +**Pin pre-commit hooks to the versions already resolved in your `uv.lock`.** +One source of truth for black, ruff, mypy, and the rest. + +

+ Versions resolved in uv.lock flow into .pre-commit-config.yaml: ruff rev v0.1.9 becomes v0.14.2, black rev 23.9.1 becomes 25.9.0 +

+ [![Tests][tests-badge]][tests-link] -[![uv][uv-badge]][uv-link] -[![Ruff][ruff-badge]][ruff-link] -[![Black][black-badge]][black-link] [![codecov][codecov-badge]][codecov-link] -\ [![PyPI version][pypi-version-badge]][pypi-link] -[![PyPI platforms][pypi-platforms-badge]][pypi-link] [![Total downloads][pepy-badge]][pepy-link] -\ [![Made Using tsvikas/python-template][template-badge]][template-link] [![GitHub Discussion][github-discussions-badge]][github-discussions-link] -[![PRs Welcome][prs-welcome-badge]][prs-welcome-link] ## Overview @@ -162,24 +163,15 @@ using `${version}` as a placeholder for the package version. Interested in contributing? See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guideline. -[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg -[black-link]: https://github.com/psf/black [codecov-badge]: https://codecov.io/gh/tsvikas/sync-with-uv/graph/badge.svg [codecov-link]: https://codecov.io/gh/tsvikas/sync-with-uv [github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github [github-discussions-link]: https://github.com/tsvikas/sync-with-uv/discussions [pepy-badge]: https://img.shields.io/pepy/dt/sync-with-uv [pepy-link]: https://pepy.tech/project/sync-with-uv -[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg -[prs-welcome-link]: https://opensource.guide/how-to-contribute/ [pypi-link]: https://pypi.org/project/sync-with-uv/ -[pypi-platforms-badge]: https://img.shields.io/pypi/pyversions/sync-with-uv [pypi-version-badge]: https://img.shields.io/pypi/v/sync-with-uv -[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json -[ruff-link]: https://github.com/astral-sh/ruff [template-badge]: https://img.shields.io/badge/%F0%9F%9A%80_Made_Using-tsvikas%2Fpython--template-gold [template-link]: https://github.com/tsvikas/python-template [tests-badge]: https://github.com/tsvikas/sync-with-uv/actions/workflows/ci.yml/badge.svg [tests-link]: https://github.com/tsvikas/sync-with-uv/actions/workflows/ci.yml -[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json -[uv-link]: https://github.com/astral-sh/uv diff --git a/assets/readme/sync-flow.png b/assets/readme/sync-flow.png new file mode 100644 index 0000000..2e99ffe Binary files /dev/null and b/assets/readme/sync-flow.png differ diff --git a/assets/readme/sync-flow.svg b/assets/readme/sync-flow.svg new file mode 100644 index 0000000..ce07f95 --- /dev/null +++ b/assets/readme/sync-flow.svg @@ -0,0 +1,67 @@ + + How sync-with-uv updates a pre-commit config + The versions resolved in uv.lock (ruff 0.14.2, black 25.9.0, mypy 1.18.2) flow into .pre-commit-config.yaml, where rev v0.1.9 becomes v0.14.2 for ruff and 23.9.1 becomes 25.9.0 for black. The leading v is preserved per repository. + + + + + + + + + + + + + + uv.lock + + + + ruff + 0.14.2 + black + 25.9.0 + mypy + 1.18.2 + + + + + + + sync + + + + + .pre-commit-config.yaml + + + + repo: astral-sh/ruff-pre-commit + + + - + rev: v0.1.9 + + + + + rev: v0.14.2 + + repo: psf/black + + + - + rev: 23.9.1 + + + + + rev: 25.9.0 + + +