.pre-commit-config.yaml

# This file configures pre-commit hooks.
# See https://pre-commit.com/ for general information
# See https://pre-commit.com/hooks.html for a listing of possible hooks

repos:
  # General hooks
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v5.0.0
    hooks:
      - id: check-docstring-first
      - id: check-json
        exclude: "tsconfig.*json"
      - id: check-yaml
        args:
          - "--unsafe"
      - id: check-toml
      - id: check-executables-have-shebangs
      - id: end-of-file-fixer
        exclude_types:
          - svg
          - pofile
        exclude: "(^LICENSE$)"
      - id: mixed-line-ending
        args:
          - "--fix=lf"
      - id: trailing-whitespace
        exclude_types:
          - svg
      - id: check-case-conflict
      - id: detect-private-key
  - repo: https://github.com/codespell-project/codespell
    rev: v2.4.0
    hooks:
      - id: codespell
        exclude: "(^src-ui/src/locale/)|(^src-ui/pnpm-lock.yaml)|(^src-ui/e2e/)|(^src/paperless_mail/tests/samples/)"
        exclude_types:
          - pofile
          - json
  # See https://github.com/prettier/prettier/issues/15742 for the fork reason
  - repo: https://github.com/rbubley/mirrors-prettier
    rev: 'v3.3.3'
    hooks:
      - id: prettier
        types_or:
          - javascript
          - ts
          - markdown
        additional_dependencies:
          - prettier@3.3.3
          - 'prettier-plugin-organize-imports@4.1.0'
  # Python hooks
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.9.9
    hooks:
      - id: ruff
      - id: ruff-format
  - repo: https://github.com/tox-dev/pyproject-fmt
    rev: "v2.5.1"
    hooks:
      - id: pyproject-fmt
  # Dockerfile hooks
  - repo: https://github.com/AleksaC/hadolint-py
    rev: v2.12.0.3
    hooks:
      - id: hadolint
  # Shell script hooks
  - repo: https://github.com/lovesegfault/beautysh
    rev: v6.2.1
    hooks:
      - id: beautysh
        additional_dependencies:
          - setuptools
        args:
          - "--tab"
  - repo: https://github.com/shellcheck-py/shellcheck-py
    rev: "v0.10.0.1"
    hooks:
      - id: shellcheck
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`# This file configures pre-commit hooks.`
			`# See https://pre-commit.com/ for general information`
			`# See https://pre-commit.com/hooks.html for a listing of possible hooks`

			`repos:`
Adds commenting and a little organization to the hook configuration 2022-03-03 09:35:00 -08:00			`# General hooks`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`- repo: https://github.com/pre-commit/pre-commit-hooks`
Chore: Bulk backend dependency updates (#8212 ) 2024-11-11 11:54:51 -08:00			`rev: v5.0.0`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`hooks:`
			`- id: check-docstring-first`
			`- id: check-json`
			`exclude: "tsconfig.*json"`
			`- id: check-yaml`
Feature: Workflows (#5121 ) 2024-01-03 00:19:19 -08:00			`args:`
			`- "--unsafe"`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`- id: check-toml`
			`- id: check-executables-have-shebangs`
			`- id: end-of-file-fixer`
			`exclude_types:`
			`- svg`
			`- pofile`
Reverts commit `a8f3c4be54` 2023-01-08 13:50:48 -08:00			`exclude: "(^LICENSE$)"`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`- id: mixed-line-ending`
			`args:`
			`- "--fix=lf"`
			`- id: trailing-whitespace`
			`exclude_types:`
			`- svg`
			`- id: check-case-conflict`
			`- id: detect-private-key`
Chore: add pre-commit hook for codespell (#5324 ) 2024-01-08 13:03:05 -08:00			`- repo: https://github.com/codespell-project/codespell`
Chore: Upgrades dependencies and hook versions (#8895 ) 2025-01-24 12:08:58 -08:00			`rev: v2.4.0`
Chore: add pre-commit hook for codespell (#5324 ) 2024-01-08 13:03:05 -08:00			`hooks:`
			`- id: codespell`
Development: change frontend package manager to pnpm (#9363 ) 2025-03-11 10:59:44 -07:00			`exclude: "(^src-ui/src/locale/)\|(^src-ui/pnpm-lock.yaml)\|(^src-ui/e2e/)\|(^src/paperless_mail/tests/samples/)"`
Chore: add pre-commit hook for codespell (#5324 ) 2024-01-08 13:03:05 -08:00			`exclude_types:`
			`- pofile`
			`- json`
Chore: Update backend dependencies in bulk (#7656 ) 2024-09-08 13:03:38 -07:00			`# See https://github.com/prettier/prettier/issues/15742 for the fork reason`
			`- repo: https://github.com/rbubley/mirrors-prettier`
			`rev: 'v3.3.3'`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`hooks:`
			`- id: prettier`
			`types_or:`
			`- javascript`
			`- ts`
			`- markdown`
Chore: add prettier organize imports 2024-12-13 00:27:30 -08:00			`additional_dependencies:`
			`- prettier@3.3.3`
			`- 'prettier-plugin-organize-imports@4.1.0'`
Adds commenting and a little organization to the hook configuration 2022-03-03 09:35:00 -08:00			`# Python hooks`
Unlocks all things which were locked due to ARMv7, etc 2023-09-08 08:53:07 -07:00			`- repo: https://github.com/astral-sh/ruff-pre-commit`
Chore(deps-dev): Bump the development group with 2 updates (#9253 ) 2025-02-28 21:38:18 +00:00			`rev: v0.9.9`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`hooks:`
Configures ruff as the one stop linter and resolves warnings it raised 2023-03-28 09:39:30 -07:00			`- id: ruff`
Chore: Change the code formatter to Ruff (#6756 ) 2024-05-17 19:26:50 -07:00			`- id: ruff-format`
Chore: Switch from pipenv to uv (#9251 ) 2025-03-04 08:15:51 -08:00			`- repo: https://github.com/tox-dev/pyproject-fmt`
Chore: Combine Python settings files (#9292 ) 2025-03-04 09:19:47 -08:00			`rev: "v2.5.1"`
Chore: Switch from pipenv to uv (#9251 ) 2025-03-04 08:15:51 -08:00			`hooks:`
			`- id: pyproject-fmt`
Adds commenting and a little organization to the hook configuration 2022-03-03 09:35:00 -08:00			`# Dockerfile hooks`
Incorporates the base image building back into the main repo with multi stage building 2022-04-18 08:18:20 -07:00			`- repo: https://github.com/AleksaC/hadolint-py`
Chore: Backend bulk updates (#4509 ) 2023-11-13 09:09:56 -08:00			`rev: v2.12.0.3`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`hooks:`
Incorporates the base image building back into the main repo with multi stage building 2022-04-18 08:18:20 -07:00			`- id: hadolint`
Adds commenting and a little organization to the hook configuration 2022-03-03 09:35:00 -08:00			`# Shell script hooks`
			`- repo: https://github.com/lovesegfault/beautysh`
			`rev: v6.2.1`
			`hooks:`
			`- id: beautysh`
Chore: Drop Python 3.9 support (#7774 ) 2024-09-26 12:22:24 -07:00			`additional_dependencies:`
			`- setuptools`
Updates the beautysh hook to use tabs, as this reduces the diff of the output. Updates .editorconfig to use spaces in Markdown files to match prettier formatting 2022-03-07 13:53:35 -08:00			`args:`
			`- "--tab"`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`- repo: https://github.com/shellcheck-py/shellcheck-py`
Chore(deps-dev): Bump the development group with 4 updates (#6131 ) 2024-03-21 02:09:37 +00:00			`rev: "v0.10.0.1"`
Adds and configures pre-commit hooks for linting and formatting during development 2022-02-27 09:33:59 -08:00			`hooks:`
			`- id: shellcheck`