github-docs-cookiecutter/.pre-commit-config.yaml at master · jcook3701/github-docs-cookiecutter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# pre-commit-config.yaml for github-docs-cookiecutter
#
# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook
# SPDX-License-Identifier: AGPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
---
default_install_hook_types:
  - pre-commit
  - commit-msg

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: end-of-file-fixer
      - id: trailing-whitespace
        args: [--markdown-linebreak-ext=md, --markdown-linebreak-ext=mdx]
      - id: mixed-line-ending
        args: [--fix=lf]
      - id: check-yaml
        exclude: '{{ cookiecutter.project_slug }}/.*'
      - id: check-json
        exclude: '{{ cookiecutter.project_slug }}/.*'
      - id: check-toml
        exclude: '{{ cookiecutter.project_slug }}/.*'
      - id: detect-private-key
      - id: check-case-conflict
      - id: check-added-large-files
      - id: check-symlinks

  - repo: https://github.com/psf/black
    rev: 25.11.0
    hooks:
      - id: black
        exclude: '{{ cookiecutter.project_slug }}/.*'

  - repo: local
    hooks:
      - id: generate-changelog
        name: Generate CHANGELOG.md
        entry: make changelog
        language: system
        files: CHANGELOG.md
        always_run: true
        pass_filenames: false

  - repo: local
    hooks:
      - id: generate-docs
        name: Generate Documentation
        entry: make build-docs
        language: system
        always_run: true
        pass_filenames: false

  - repo: https://github.com/streetsidesoftware/cspell-cli
    rev: v9.3.3
    hooks:
      - id: cspell
        stages: [commit-msg]
        args: ["--config", "./cspell.json"]

  - repo: https://github.com/compilerla/conventional-pre-commit
    rev: v4.3.0
    hooks:
      - id: conventional-pre-commit
        stages: [commit-msg]