Jason’s Pre-commit Hooks

This repo contains pre-commit hooks that Jason uses for his personal projects. If you aren’t Jason and you also aren’t contributing to one of Jason’s projects, then this repo probably won’t be helpful to you.

If you want to know more about what the hooks in this repo do, then take a look at VERSIONING.md. Specifically, VERSIONING.md will tell you what you need to to in order to find the API docs for the scripts in this repo.

The stable branch

This repository has a branch that’s named stable. Whenever a new release of this project is made, the tip of the stable branch should be updated so that it points to the latest stable release of Jason’s Pre-commit Hooks. If it’s been more than a day since a stable release has been made and the stable branch still hasn’t been updated, then someone should open a GitHub issue. It should never take that long to update the stable branch.

This repository contains a Nix flake. If you want to use this repository’s flake as an input for another flake, then I recommend using this repository’s stable branch. The stable branch allows you to easily ensure that you’re always using the latest stable version of Jason’s Pre-commit Hooks.

Hints for Contributors

• You can use pre-commit to automatically check your contributions. Follow these instructions to get started. Skip the part about creating a pre-commit configuration.

• This repo uses an EditorConfig file.

• Try to keep lines shorter than seventy-three characters.

• Use CommonMark for Markdown files.

• If you’re using NixOS, then the ruff pre-commit hook probably won’t work. Here’s how you fix it:

  1. Set the PIP_NO_BINARY environment variable to “ruff”.
  2. Run pre-commit clean
  3. Run pre-commit install-hooks

Copying

See copying.md.