Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/GabDug/sync-pre-commit-lock

Automatically sync your pre-commit hooks version from your PDM or Poetry lockfile, and install them automatically.
https://github.com/GabDug/sync-pre-commit-lock

pdm-plugin poetry-plugin pre-commit pre-commit-config python

Last synced: 3 months ago
JSON representation

Automatically sync your pre-commit hooks version from your PDM or Poetry lockfile, and install them automatically.

Host: GitHub
URL: https://github.com/GabDug/sync-pre-commit-lock
Owner: GabDug
License: gpl-3.0
Created: 2023-06-29T19:31:59.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-26T14:19:34.000Z (4 months ago)
Last Synced: 2024-09-26T14:37:53.664Z (4 months ago)
Topics: pdm-plugin, poetry-plugin, pre-commit, pre-commit-config, python
Language: Python
Homepage:
Size: 547 KB
Stars: 23
Watchers: 3
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-pdm - sync-pre-commit-lock - A PDM plugin to ease your life with `pre-commit` (automatic install, sync) (Plugins)

README

        # sync-pre-commit-lock

[![Tests](https://github.com/GabDug/sync-pre-commit-lock/actions/workflows/ci.yml/badge.svg)](https://github.com/GabDug/sync-pre-commit-lock/actions/workflows/ci.yml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/GabDug/sync-pre-commit-lock/main.svg)](https://results.pre-commit.ci/latest/github/GabDug/sync-pre-commit-lock/main)

[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7529/badge)](https://bestpractices.coreinfrastructure.org/projects/7529)

[![pypi version](https://img.shields.io/pypi/v/sync-pre-commit-lock.svg)](https://pypi.org/project/sync-pre-commit-lock/)

[![License](https://img.shields.io/pypi/l/sync-pre-commit-lock.svg)](https://pypi.python.org/pypi/sync-pre-commit-lock)

[![Python version](https://img.shields.io/pypi/pyversions/sync-pre-commit-lock.svg)](https://pypi.python.org/pypi/sync-pre-commit-lock)

[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)

[![Ruff](https://img.shields.io/badge/ruff-lint-red)](https://github.com/charliermarsh/ruff)

PDM and Poetry plugin to sync your pre-commit versions with your lockfile and automatically install pre-commit hooks.

![Sample output](.github/sample_command.png)

## Features

- 🔁 Sync pre-commit versions (including `additional_dependencies`) with your lockfile

- ⏩ Run every time you run the lockfile is updated, not as a pre-commit hook

- 🔄 Install pre-commit hooks automatically, no need to run `pre-commit install` manually

- 💫 Preserve your pre-commit config file formatting

- 🍃 Lightweight, only depends on [strictyaml](https://pypi.org/project/strictyaml/) and [packaging](https://pypi.org/project/packaging/)

## Supported versions

- Python 3.9+

- PDM 2.7.4+

- Poetry 1.6.0+

## Installation

### For PDM

Install it [just like any other PDM plugin](https://pdm.fming.dev/latest/dev/write/#activate-the-plugin):

```bash

pdm self add "sync-pre-commit-lock"

```

Optionally, you can also specify [the plugin in your project](https://pdm.fming.dev/latest/dev/write/#specify-the-plugins-in-project) `pyproject.toml`, to make it installable with `pdm install --plugins`:

```toml

[tool.pdm]

plugins = [

    "sync-pre-commit-lock"

]

```

> Note: we have an extra group `[pdm]`, that adds PDM version constraints.

> While it's safer, it might result in PDM being installed twice.

### For Poetry

Install [like any other Poetry plugin](https://python-poetry.org/docs/plugins/#using-plugins), e.g.:

```bash

poetry self add "sync-pre-commit-lock[poetry]"

```

> Only Poetry 1.6.0+ is supported.

## Configuration

This plugin is configured using the `tool.sync-pre-commit-lock` section in your `pyproject.toml` file.

Here is the default configuration:

```toml

[tool.sync-pre-commit-lock]

# Run `pre-commit install` automatically if applicable

automatically-install-hooks = true

# Should we sync your pre-commit versions with your lockfile (when running lock, add, update, remove, etc.)?

disable-sync-from-lock = false

# Packages to ignore when syncing from lock

ignore = []

# Name of the pre-commit config file to sync with

pre-commit-config-file = ".pre-commit-config.yaml"

# Additional mapping of URLs to python packages

# Default is empty, but will merge with the default mapping

# "rev" indicates the format of the Git tags

dependency-mapping = {"package-name"= {"repo"= "https://github.com/example/package-name", "rev"= "v${rev}"}}

```

> Note: the `dependency-mapping` is merged with the default mapping, so you don't need to specify the default mapping if you want to add a new mapping.

> Repos urls will be normalized to http(s), with the trailing slash removed.

### From environment

Some settings are overridable by environment variables with the following `SYNC_PRE_COMMIT_LOCK_*` prefixed environment variables:

| `toml` setting                | environment                            | format                            |

| ------------------------------|----------------------------------------|-----------------------------------|

| `automatically-install-hooks` | `SYNC_PRE_COMMIT_LOCK_INSTALL`         | `bool` as string (`true`, `1`...) |

| `disable-sync-from-lock`      | `SYNC_PRE_COMMIT_LOCK_DISABLED`        | `bool` as string (`true`, `1`...) |

| `ignore`                      | `SYNC_PRE_COMMIT_LOCK_IGNORE`          | comma-separated list              |

| `pre-commit-config-file`      | `SYNC_PRE_COMMIT_LOCK_PRE_COMMIT_FILE` | `str`                             |

## Usage

Once installed, and optionally configured, the plugin usage should be transparent, and trigger when you run applicable PDM or Poetry commands, like `pdm lock`, or `poetry lock`.

> There should be a message in the output, when the sync or install or pre-commit is triggered.

You can manually trigger the sync with the CLI command:

```bash

pdm sync-pre-commit

```

or

```bash

poetry sync-pre-commit

```

Both commands support `--dry-run` and verbosity options.

### PDM Github Action support

If you use [pdm-project/update-deps-actions](https://github.com/pdm-project/update-deps-action) Github Action, you can get automatically update `your .pre-commit-config.yaml` file by adding the plugin in your `pyproject.toml` and setting a flag in your workflow:

```yaml

# In your workflow

      - name: Update dependencies

        uses: pdm-project/update-deps-action@main

        with:

          # Whether to install PDM plugins before update (defaults to "false")

          install-plugins: "true"

```

```toml

# In your pyproject.toml

[tool.pdm]

plugins = ["sync-pre-commit-lock"]

```

## Supported packages for pre-commits

Here is the list of default packages supported by this plugin, from [`db.py`](https://github.com/GabDug/sync-pre-commit-lock/blob/main/src/sync_pre_commit_lock/db.py). You can add more packages using the `dependency-mapping` configuration.

- [autopep8](https://github.com/hhatto/autopep8)

- [bandit](https://github.com/PyCQA/bandit)

- [black](https://github.com/psf/black-pre-commit-mirror)

- [check-jsonschema](https://github.com/python-jsonschema/check-jsonschema)

- [codespell](https://github.com/codespell-project/codespell)

- [commitizen](https://github.com/commitizen-tools/commitizen)

- [djade](https://github.com/adamchainz/djade-pre-commit)

- [djhtml](https://github.com/rtts/djhtml)

- [docformatter](https://github.com/PyCQA/docformatter)

- [flake8](https://github.com/pycqa/flake8)

- [flakeheaven](https://github.com/flakeheaven/flakeheaven)

- [isort](https://github.com/pycqa/isort)

- [mypy](https://github.com/pre-commit/mirrors-mypy)

- [pdm](https://github.com/pdm-project/pdm)

- [poetry](https://github.com/python-poetry/poetry)

- [pycln](https://github.com/hadialqattan/pycln)

- [pyroma](https://github.com/regebro/pyroma)

- [pyupgrade](https://github.com/asottile/pyupgrade)

- [rtscheck](https://github.com/rstcheck/rstcheck)

- [ruff](https://github.com/astral-sh/ruff-pre-commit)

- [yamllint](https://github.com/adrienverge/yamllint)

> Note: `pdm` or `poetry` version will be added, from the current instance version, and not from the lockfile.

## Improvement ideas

Feel free to open an issue or a PR if you have any idea, or if you want to help!

### Release / CI / DX

- [ ] Add a changelog

- [ ] Add "E2E" tests

- [ ] Add docs

### Features or fixes

- [X] Support hooks URL aliases for the same Python package

  - [ ] Support user configuration of aliases

- [ ] Support `pdm config` and clear configuration precedence

- [ ] Create a more verbose command

- [ ] Add support for other lockfiles / project managers (pipenv, flit, hatch, etc.)

- [ ] Expose a pre-commit hook to sync the lockfile

- [x] Support nested `additional_dependencies`, (i.e. mypy types)

- [ ] Support reading DB from a Python module?

- [ ] Support reordering DB inputs (file/global config/python module/cli)?

- [ ] Test using SSH/file dependencies?

- [ ] Check ref existence before writing?

- [ ] New feature to convert from pre-commit online to local?

- [ ] Warning if pre-commit CI auto update is also set?

- [x] Support automatic repository URL update (from legacy aliased repositories)

## Inspiration

This project is inspired by @floatingpurr's [sync_with_pdm](https://github.com/floatingpurr/sync_with_pdm/) and [sync_with_poetry](https://github.com/floatingpurr/sync_with_poetry/).

The code to install pre-commit hooks automatically is **adapted** from @vstrimaitis's [poetry-pre-commit-plugin](https://github.com/vstrimaitis/poetry-pre-commit-plugin/), licensed under GPL-3.