Kari Argillander
0177c59f4a
* Add editorconfig and pre-commit config Editorconfig is widly used and supported file. It says basic things how files should be formatted. pre-commit is tool which can automatically check some basic checks like code formatting everytime someone makes commit. This can also be used in CI to run these things. Then it is very easy to do same things locally as in CI. This also makes easy to select clang-format version so everyone is using same one. * clang-format: Ignore folders where are external code We should not format external code. Add clang-format files to exclude those. We should move external code always to example external/ folder so we can exclude those more easily. * clang-format: Remove custom zephyr/.clang-gormat This clang-format file where introduces before our root clang-format. It does not make sense anymore as we have root clang-format. Removing this will unifie formatting in whole repo. * clang-format: Add couple new rules Add couple new formatting rules. Always align const to left side. We did have only one place where it was right side so this make sense as it is already rule for us. I choose also insertbraces becuase when I run this I notice that we have lot of multiline code without braces. So very error prone places. This will take error possibility away. Repo also always use braces even with single line statments so this does not matter much. * ci: Add pre-commit validation Validate pre-commit in CI. * format: Convert spaces to tabs in Makefiles Makefile normally use tabs. We enforce that with editorconfig. Fix couple places where spaces where still in use. --------- Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
76 lines
2.6 KiB
YAML
76 lines
2.6 KiB
YAML
# Pre-commit is tool which we use to format and check this repository. This is
|
|
# also used in CI. You will still get nicer commits if you install it also
|
|
# locally.
|
|
#
|
|
# To install pre-commit run in repository root:
|
|
# pip install pre-commit
|
|
# pre-commit install
|
|
#
|
|
# To ignore pre-commit checks run:
|
|
# git commit --no-verify
|
|
# or
|
|
# pre-commit uninstall
|
|
|
|
# Just in case exclude build and .git folders. Others are for external files.
|
|
exclude: build|\.git|external/|BACnet\-Server\.X/|tools/(avstack|check\-stack\-usage|memap)|test/ztest/
|
|
|
|
repos:
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c # v4.6.0
|
|
hooks:
|
|
- id: check-merge-conflict
|
|
args: [--assume-in-merge]
|
|
# Editorconfig-checker does not care if file contains multiple newlines.
|
|
- id: end-of-file-fixer
|
|
exclude: '.*\.(cproj|vcxproj.*|props)$'
|
|
- id: check-yaml
|
|
args: [
|
|
# for .clang-format
|
|
--allow-multiple-documents,
|
|
]
|
|
- id: check-case-conflict
|
|
- id: check-shebang-scripts-are-executable
|
|
- id: fix-byte-order-marker
|
|
# Seems that VS files are using BOMs.
|
|
exclude: '.*\.(cproj|vcxproj.*|sln|atsln|props)$'
|
|
- id: trailing-whitespace
|
|
|
|
- repo: https://github.com/Lucas-C/pre-commit-hooks
|
|
rev: a30f0d816e5062a67d87c8de753cfe499672b959 # v1.5.5
|
|
hooks:
|
|
- id: remove-tabs
|
|
name: Remove tabs (4 spaces)
|
|
args: ["--whitespaces-count", "4"]
|
|
exclude: \.(yaml|yml|html|htm|sln|atsln|layout)$|Makefile|\.(mgw|mak|MAK)$|Dockerfile$
|
|
- id: remove-tabs
|
|
name: Remove tabs (2 spaces)
|
|
args: ["--whitespaces-count", "2"]
|
|
files: '.*\.(yaml|yml|html|htm)|Dockerfile$'
|
|
|
|
# We will enable this in future.
|
|
# - repo: https://github.com/pre-commit/mirrors-clang-format
|
|
# rev: 3b03191b6a60cba0fc25c2dc2e30ea4854d897eb # v17.0.5
|
|
# hooks:
|
|
# - id: clang-format
|
|
|
|
# We might enable this in future.
|
|
# - repo: https://github.com/pre-commit/mirrors-prettier
|
|
# rev: ffb6a759a979008c0e6dff86e39f4745a2d9eac4 # v3.1.0
|
|
# hooks:
|
|
# - id: prettier
|
|
|
|
- repo: https://github.com/pre-commit/pygrep-hooks
|
|
rev: 3a6eb0fadf60b3cccfd80bad9dbb6fae7e47b316 # v1.10.0
|
|
hooks:
|
|
- id: text-unicode-replacement-char
|
|
|
|
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
|
|
rev: 1c48f639855b49be07ace8b824757152b6747baa #2.6.2
|
|
hooks:
|
|
- id: editorconfig-checker
|
|
alias: ec
|
|
args: [
|
|
# Saddly we have to disable this, but it just won't work. Maybe some day.
|
|
-disable-indent-size,
|
|
]
|