findex-server/.pre-commit-config.yaml at develop · Cosmian/findex-server · 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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
---
# Pre-requisites:
# pip install pre-commit conventional-pre-commit
# pre-commit install
# pre-commit install --install-hooks -t commit-msg
# pre-commit autoupdate
#
# (optional) Creating a virtual environment
# ```
# sudo pip3 install virtualenv
# virtualenv venv
# source venv/bin/activate
# ```
# Known issues:
# - If markdownlint-cli fails to install, try installing node js LTS :
# first, install nvm according to the docs : https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating
# then, run the following commands:
# ```
# nvm install --lts
# nvm use --lts
# ```
# - If docker-compose-up fails to install, try installing docker-compose and installing the latest docker version.
# If you get an error related to unavailable ports, you might have an instance of redis-server running on the same port. If so, stop the redis-server with the following command: `sudo systemctl stop redis-server.service` and relaunch the pre-commit hooks.
exclude: test_data|documentation/docs/images
repos:
  - repo: https://github.com/compilerla/conventional-pre-commit
    rev: v4.0.0
    hooks:
      - id: conventional-pre-commit
        stages: [commit-msg]
        args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]

  - repo: https://github.com/igorshubovych/markdownlint-cli
    rev: v0.44.0
    hooks:
      - id: markdownlint-fix
        args: [--disable=MD013, --disable=MD041, --disable=MD046, --fix]

  - repo: https://github.com/tcort/markdown-link-check
    rev: v3.13.7
    hooks:
      - id: markdown-link-check
        args: [-q, --config, .markdown-link-check.json]

  - repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt
    rev: 0.2.3
    hooks:
      - id: yamlfmt
        args: [--mapping, '2', --sequence, '4', --offset, '2']
        exclude: ansible

  - repo: https://github.com/crate-ci/typos
    rev: v1.31.1
    hooks:
      - id: typos
        exclude: crate/test_server/certificates

  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.5.5
    hooks:
      - id: forbid-crlf
      - id: remove-crlf
      - id: forbid-tabs
        exclude: ^.git/
      - id: remove-tabs
        exclude: ^.git/

  - repo: https://github.com/sirosen/texthooks
    rev: 0.6.8
    hooks:
      - id: fix-smartquotes
      - id: fix-ligatures
      - id: fix-spaces
      - id: forbid-bidi-controls
      - id: macro-expand

  - repo: https://github.com/jumanjihouse/pre-commit-hooks
    rev: 3.0.0
    hooks:
      - id: shellcheck

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v5.0.0
    hooks:
      - id: check-added-large-files
      - id: check-ast
      - id: check-byte-order-marker
      - id: check-builtin-literals
      - id: check-case-conflict
      - id: check-docstring-first
      - id: check-json
      - id: check-merge-conflict
      - id: check-symlinks
      - id: check-toml
      - id: check-vcs-permalinks
      - id: check-xml
      - id: check-yaml
      - id: debug-statements
      - id: destroyed-symlinks
      - id: detect-private-key
        exclude: crate/test_server/certificates
      - id: double-quote-string-fixer
      - id: end-of-file-fixer
      - id: file-contents-sorter
      - id: fix-byte-order-marker
      - id: fix-encoding-pragma
      - id: mixed-line-ending
        args: [--fix=lf]
      - id: name-tests-test
      - id: requirements-txt-fixer
      - id: sort-simple-yaml
      - id: trailing-whitespace

  - repo: https://github.com/psf/black
    rev: 25.1.0
    hooks:
      - id: black
        # avoid clash with `double-quote-string-fixer`
        args: [--skip-string-normalization]

  - repo: https://github.com/Cosmian/git-hooks.git
    rev: v1.0.36
    hooks:
      - id: nightly-cargo-format
      - id: dprint-toml-fix
        stages: [manual]
      - id: cargo-upgrade
        stages: [manual]
      - id: cargo-update
        stages: [manual]
      - id: cargo-machete
      - id: docker-compose-up
      - id: cargo-build
      - id: cargo-test
      - id: cargo-build-all
      - id: cargo-test
        alias: cargo-test-all
        args: [--all-features]
      - id: clippy-all-targets-all-features
      - id: clippy-all-targets
      - id: cargo-format # in last due to clippy fixes
      - id: docker-compose-down

  - repo: https://github.com/EmbarkStudios/cargo-deny
    rev: 0.18.4
    hooks:
      - id: cargo-deny
        args: [--all-features, check]
        stages: [manual]