docs/.pre-commit-config.yaml at 717777e031302f782f3bd9d3bfbbe3fdb8623d4e · opalmedapps/docs · 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# SPDX-FileCopyrightText: Copyright (C) 2024 Opal Health Informatics Group at the Research Institute of the McGill University Health Centre <john.kildea@mcgill.ca>
#
# SPDX-License-Identifier: MIT

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-added-large-files
      - id: check-executables-have-shebangs
      - id: check-json
        # file contains comments
        exclude: |
          (?x)(
            ^(
              \.vscode/settings\.json
              |\.vscode/extensions\.json
              |\.devcontainer/devcontainer.json
            )
          )
      - id: check-merge-conflict
      - id: check-toml
      - id: check-xml
      - id: check-yaml
      - id: detect-private-key
      - id: end-of-file-fixer

  - repo: https://github.com/abravalheri/validate-pyproject
    rev: v0.25
    hooks:
      - id: validate-pyproject

  - repo: https://github.com/executablebooks/mdformat
    rev: 1.0.0
    hooks:
      - id: mdformat
        language: python
        additional_dependencies:
          - mdformat-mkdocs==5.1.4
          - mdformat-footnote==0.1.3
          - mdformat-front-matters==2.0.0

  - repo: https://github.com/DavidAnson/markdownlint-cli2
    rev: v0.21.0
    hooks:
      - id: markdownlint-cli2

  - repo: https://github.com/astral-sh/uv-pre-commit
    rev: 0.11.0
    hooks:
      - id: uv-lock

  - repo: https://github.com/crate-ci/typos
    rev: v1.44.0
    hooks:
      - id: typos

  - repo: https://github.com/fsfe/reuse-tool
    rev: v6.2.0
    hooks:
      - id: reuse-lint-file

  # zizmor detects security vulnerabilities in GitHub Actions workflows.
  - repo: https://github.com/woodruffw/zizmor-pre-commit
    rev: v1.23.1
    hooks:
      - id: zizmor

  - repo: https://github.com/python-jsonschema/check-jsonschema
    rev: 0.37.0
    hooks:
      - id: check-github-workflows
        args: ["--verbose"]
      - id: check-compose-spec
        args: ["--verbose"]
      - id: check-renovate
        args: ["--verbose"]
        additional_dependencies: ['json5']
      # - id: check-jsonschema
      #   name: "Validate devcontainer"
      #   files: ^\.devcontainer/.*\.json$
      #   additional_dependencies: ['json5']
      #   args: [
      #     "--schemafile",
      #     "https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.schema.json",
      #     "--force-filetype",
      #     "json5",
      #     "--verbose",
      #   ]
      # waiting for custom YAML tags support: https://github.com/python-jsonschema/check-jsonschema/issues/489
      # - id: check-jsonschema
      #   name: "Validate MkDocs file"
      #   files: ^mkdocs\.ya?ml$
      #   types: [yaml]
      #   args: ["--verbose", "--schemafile", "https://squidfunk.github.io/mkdocs-material/schema.json"]

  # `actionlint` hook, for verifying correct syntax in GitHub Actions workflows.
  # Some additional configuration for `actionlint` can be found in `.github/actionlint.yaml`.
  - repo: https://github.com/rhysd/actionlint
    rev: v1.7.11
    hooks:
      - id: actionlint
        language: golang
        additional_dependencies:
          # actionlint has a shellcheck integration which extracts shell scripts in `run:` steps from GitHub Actions
          # and checks these with shellcheck. This is arguably its most useful feature,
          # but the integration only works if shellcheck is installed
          - "github.com/wasilibs/go-shellcheck/cmd/shellcheck@v0.11.1"