From fe4cfb9d792284fcd1b4f5332720a834f599b78f Mon Sep 17 00:00:00 2001 From: Lars Bilke Date: Tue, 18 Jul 2023 20:58:34 +0200 Subject: [PATCH 1/3] [web] Added note on running clang-format. --- .../development-workflows/code-format/index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/web/content/docs/devguide/development-workflows/code-format/index.md b/web/content/docs/devguide/development-workflows/code-format/index.md index 056b904232e..a8623a96378 100644 --- a/web/content/docs/devguide/development-workflows/code-format/index.md +++ b/web/content/docs/devguide/development-workflows/code-format/index.md @@ -21,6 +21,16 @@ Use [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html). It can be ad The current style is defined in [.clang-format](https://gitlab.opengeosys.org/ogs/ogs/-/blob/master/.clang-format). +You can also run via the command line: + +```bash +clang-format -i path/to/file.cpp +# OR clang-format on changed lines only: +git clang-format -i path/to/file.cpp +# OR run on all files, e.g.: +find -E . -regex '.*\.(cpp|h)' -exec clang-format -i {} \; +``` + ## Python Use [`black`](https://black.readthedocs.io/en/stable/). It can be added to be automatically run on save in your editor / IDE: From 2220f5d59dfbdff837c7718dd48d8498101c658c Mon Sep 17 00:00:00 2001 From: Lars Bilke Date: Tue, 18 Jul 2023 21:04:37 +0200 Subject: [PATCH 2/3] [pre-commit] Added disable hook for running clang-format on all files. --- .pre-commit-config.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f0bdbd2b323..92ee1bd8171 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -82,3 +82,11 @@ repos: hooks: - id: ruff files: "Applications/Python/.*" + # Enable on demand, run with + # pre-commit run --all-files clang-format + # + # - repo: https://github.com/pocc/pre-commit-hooks + # rev: master + # hooks: + # - id: clang-format + # args: ["-i"] From d0aab3c6248a3b1bc37203930f20b41916ab48bc Mon Sep 17 00:00:00 2001 From: Lars Bilke Date: Tue, 18 Jul 2023 21:05:43 +0200 Subject: [PATCH 3/3] [ci] Arm clang-format job. --- scripts/ci/jobs/pre-commit.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/ci/jobs/pre-commit.yml b/scripts/ci/jobs/pre-commit.yml index 5f3d00b3edb..eabca775316 100644 --- a/scripts/ci/jobs/pre-commit.yml +++ b/scripts/ci/jobs/pre-commit.yml @@ -16,7 +16,6 @@ clang-format: rules: - if: $CI_MERGE_REQUEST_IID needs: [ci_images] - allow_failure: true script: - git clang-format --extensions "h,cpp" ${CI_MERGE_REQUEST_DIFF_BASE_SHA} - if [[ $(git diff) ]]; then exit 1; fi