blob: 4d2327f30ffa454dbf7a45ce30b571d38b31e415 [file] [log] [blame]
Joey Armstrong125f8032024-05-01 16:20:11 -04001---
2
3# -----------------------------------------------------------------------
4# [NOTE] - Propogate .pre-commit-config.yaml edits to all repositories!
5# -----------------------------------------------------------------------
6# [NOTE] - Common config file source lives in repo:onf-make
7# - https://gerrit.opencord.org/plugins/gitiles/
8# onf-make/+/refs/heads/master/.pre-commit-config.yaml
9# -----------------------------------------------------------------------
10# [TODO]
11# - pre-commit yaml config exists individually within repositories.
12# - Generally lint config and benavior is consistent for all repos.
13# - Exclusions and bulk cleanup necessitate per-repo custom configs.
14# - Dynamically generate this config file from common and custom
15# -----------------------------------------------------------------------
16
17# -----------------------------------------------------------------------
18# Copyright 2024 Open Networking Foundation Contributors
19#
20# Licensed under the Apache License, Version 2.0 (the "License");
21# you may not use this file except in compliance with the License.
22# You may obtain a copy of the License at
23#
24# http://www.apache.org/licenses/LICENSE-2.0
25#
26# Unless required by applicable law or agreed to in writing, software
27# distributed under the License is distributed on an "AS IS" BASIS,
28# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29# See the License for the specific language governing permissions and
30# limitations under the License.
31# -----------------------------------------------------------------------
32# SPDX-FileCopyrightText: 2024 Open Networking Foundation Contributors
33# SPDX-License-Identifier: Apache-2.0
34# -----------------------------------------------------------------------
35# See https://pre-commit.com for more information
36# See https://pre-commit.com/hooks.html for more hooks
37# -----------------------------------------------------------------------
Joey Armstrong1a78c6c2024-05-03 18:55:00 -040038# .pre-commit-config-yaml v0.6
Joey Armstrong125f8032024-05-01 16:20:11 -040039# -----------------------------------------------------------------------
40
41# ci:
42# autofix_commit_msg: "Chore: pre-commit autoupdate"
43## skip: [sync]
44# skip:
45# # pre-commit.ci does not have actionlint installed
46# - actionlint
47#
48# exclude: '^docs/conf.py'
49
50repos:
51 - repo: https://github.com/pre-commit/pre-commit-hooks
52 rev: v4.5.0
53 hooks:
54 - id: trailing-whitespace
55 - id: check-added-large-files
56 - id: check-ast
57 - id: check-json
58 - id: check-merge-conflict
59 - id: check-xml
60 - id: check-yaml
61 # - id: debug-statements
62 - id: end-of-file-fixer
63 - id: fix-encoding-pragma
64 # - id: double-quote-string-fixer
65 - id: requirements-txt-fixer
66 - id: mixed-line-ending
67 args: ['--fix=lf']
68
69 - repo: https://github.com/jorisroovers/gitlint
70 rev: acc9d9de6369b76d22cb4167029d2035e8730b98 # frozen: v0.19.1
71 hooks:
72 - id: gitlint
73
74 - repo: https://github.com/koalaman/shellcheck-precommit
75 rev: v0.10.0
76 hooks:
77 - id: shellcheck
78
79 - repo: https://github.com/adrienverge/yamllint.git
80 rev: v1.35.1
81 hooks:
82 - id: yamllint
83
84 ## -----------------------------------------------------------------------
85 ## [SOURCE] Documentation
86 ## -----------------------------------------------------------------------
87 - repo: https://github.com/rstcheck/rstcheck
88 rev: v6.2.1
89 hooks:
90 - id: rstcheck
91
92 - repo: https://github.com/markdownlint/markdownlint
93 rev: v0.13.0
94 hooks:
95 - id: markdownlint
96 # - id: markdownlint_docker
97
98 ## -----------------------------------------------------------------------
99 ## [SOURCE] Docker
100 ## -----------------------------------------------------------------------
101 - repo: https://github.com/hadolint/hadolint
102 rev: v2.12.0
103 hooks:
104 # - id: hadolint # local tool install
105 - id: hadolint-docker
106
107 ## -----------------------------------------------------------------------
108 ## [SOURCE] Golang
109 ## -----------------------------------------------------------------------
110 - repo: https://github.com/golangci/golangci-lint
111 rev: v1.41.1
112 hooks:
113 - id: golangci-lint
114
115 ## -----------------------------------------------------------------------
116 ## [SOURCE] REUSE License Checking
117 ## -----------------------------------------------------------------------
Joey Armstrong1a78c6c2024-05-03 18:55:00 -0400118 # - repo: https://github.com/fsfe/reuse-tool
119 # rev: v3.0.2
120 # hooks:
121 # - id: reuse
Joey Armstrong125f8032024-05-01 16:20:11 -0400122 # - id: add-license-headers
123
124# - repo: https://github.com/ansys/pre-commit-hooks
125 # rev: v0.2.9
126 # hooks:
127 # - id: add-license-headers
128 # args:
129 # - --custom_copyright=custom copyright phrase
130 # - --custom_template=template_name
131 # - --custom_license=license_name
132 # - --ignore_license_check
133 # - --start_year=2023
134
135 ## -----------------------------------------------------------------------
136 ## [SOURCE] Python
137 ## -----------------------------------------------------------------------
138 - repo: https://github.com/psf/black
139 rev: 22.10.0
140 hooks:
141 - id: black
142
143# - repo: https://github.com/PyCQA/doc8
144 # rev: v1.1.1
145 # hooks:
146 # - id: doc8
147
148 ## -----------------------------------------------------------------------
149 ## [SOURCE] Spelling
150 ## -----------------------------------------------------------------------
151 - repo: https://github.com/codespell-project/codespell
152 rev: v2.2.4
153 hooks:
154 - id: codespell
155
156 ## -----------------------------------------------------------------------
157 ## [SOURCE] Testing
158 ## -----------------------------------------------------------------------
159 - repo: https://github.com/MarketSquare/robotframework-tidy
160 rev: 4.11.0
161 hooks:
162 - id: robotidy
163
164# -------------------------------------------------------------------
165# https://docs.python.org/3/library/re.html#regular-expression-syntax
166# -------------------------------------------------------------------
167exclude: |
168 (?x)^(
Joey Armstrong125f8032024-05-01 16:20:11 -0400169 ^makefiles/.* |
170 ^lf/.* |
171 ^.venv/.* |
Joey Armstrong1a78c6c2024-05-03 18:55:00 -0400172 ^.vendor/.* |
173 ^ignore--end-of-exclusion-marker
Joey Armstrong125f8032024-05-01 16:20:11 -0400174 )$
175
176# [SEE ALSO]
177# -----------------------------------------------------------------------
178# https://github.com/memfault/interrupt/blob/master/example/pre-commit/.pre-commit-config.yaml
179# https://pre-commit.com/hooks.html
180# https://github.com/floatingpurr/sync_with_poetry/blob/main/.pre-commit-config.yaml
181# https://github.com/the-common/pre-commit-config-template/blob/master/.pre-commit-config.yaml
182# https://github.com/memfault/interrupt/blob/master/example/pre-commit/.pre-commit-config.yaml
183# -----------------------------------------------------------------------
184# https://www.hatica.io/blog/pre-commit-git-hooks/
185# -----------------------------------------------------------------------
186
187# [EOF]