Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-commit to CI #111

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Add pre-commit to CI #111

wants to merge 12 commits into from

Conversation

calumy
Copy link
Contributor

@calumy calumy commented Dec 30, 2024

Summary

This PR adds a pre-commit config and associated config files and fixes the issues raised. This has been added in advance of ruff-format docs (PR number TBC) so to reduce the changes introduced in that PR.

The hooks added are as follows with the ones that match the main ruff repo marked

  • check-hooks-apply - Check that all hooks remain relevant to the repo over time
  • check-useless-excludes - Check that all excludes are relevant to the repo
  • check-case-conflict - Check for files with names that would conflict on a case-insensitive filesystem
  • end-of-file-fixer - Standardises all files with a new line at the end
  • trailing-whitespace - Trims extra whitespace in all files
  • validate-pyproject (In Ruff repo)
  • mdformat (In Ruff repo)
  • markdownlint-fix (In Ruff repo)
  • blacken-docs (In Ruff repo)
  • typos (In Ruff repo)
  • mypy - Type checks python code
  • ruff (In Ruff repo)
  • ruff-format (In Ruff repo) - Order swapped to match the read me in this repo
  • prettier (In Ruff repo)
  • zizmor (In Ruff repo)
  • check-github-workflows (In Ruff repo)
  • actionlint (In Ruff repo)

Test Plan

Check that the new CI check passes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant