blob: 1ad93470adc3aef94a5255afeab4d84a59ee64a4 (
plain)
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
|
#.rst:
# KDEGitCommitHooks
# --------------------
#
# This module provides a functionality to enforce formatting
# or in the future other QS checks.
#
# This module provides the following function:
#
# ::
#
# kde_configure_pre_commit_hook(
# CHECKS <check1> [<check2> [...]]
# [GIT_DIR <dir>]
# )
#
# This function will create a pre-commit hook which contains all the given checks.
# In case the source dir does not contain the .git folder, the GIT_DIR
# parameter can be passed in.
#
# Checks:
#
# - ``CLANG_FORMAT`` With this check enabled the ``git clang-format`` tool will be used to make sure that
# the changed parts are properly formatted. In case the changes are not properly formatted an error
# message with the command to preview the formatting changes and to format the files in place
# will be displayed. This tool will reuse the exsting ``.clang-format`` file, in case you
# want to use the one provided by ECM you can include ``include(KDEClangFormat)`` which will copy
# the file to the source dir. It is also recommended to reformat the entire project before enforcing
# the formatting using this commit hook.
#
# Example usage:
#
# .. code-block:: cmake
#
# include(KDEGitCommitHooks)
# kde_configure_git_pre_commit_hook(CHECKS CLANG_FORMAT)
#
# Since 5.79
#=============================================================================
# SPDX-FileCopyrightText: 2020 Alexander Lohnau <alexander.lohnau@gmx.de>
#
# SPDX-License-Identifier: BSD-3-Clause
# try to find clang-format in path
find_program(KDE_CLANG_FORMAT_EXECUTABLE clang-format)
include(CMakeParseArguments)
set(PRE_COMMIT_HOOK_UNIX "${CMAKE_CURRENT_LIST_DIR}/kde-git-commit-hooks/pre-commit.in")
set(CLANG_FORMAT_UNIX "${CMAKE_CURRENT_LIST_DIR}/kde-git-commit-hooks/clang-format.sh")
function(KDE_CONFIGURE_GIT_PRE_COMMIT_HOOK)
set(_oneValueArgs GIT_DIR)
set(_multiValueArgs CHECKS)
cmake_parse_arguments(ARG "" "${_oneValueArgs}" "${_multiValueArgs}" ${ARGN} )
if(NOT ARG_CHECKS)
message(FATAL_ERROR "No checks were specified")
endif()
if(NOT ARG_GIT_DIR)
set(ARG_GIT_DIR "${CMAKE_SOURCE_DIR}/.git")
endif()
# In case of tarballs there is no .git directory
if (EXISTS ${ARG_GIT_DIR})
# The pre-commit hook is a bash script, consequently it won't work on non-unix platforms
if (UNIX)
if(KDE_CLANG_FORMAT_EXECUTABLE)
list(FIND ARG_CHECKS "CLANG_FORMAT" _index)
if (${_index} GREATER -1)
set(CLANG_FORMAT_SCRIPT ${CLANG_FORMAT_UNIX})
endif()
else()
message(WARNING "No clang-format executable was found, skipping the formatting pre-commit hook")
endif()
configure_file(${PRE_COMMIT_HOOK_UNIX} "${ARG_GIT_DIR}/hooks/pre-commit")
endif()
endif()
endfunction()
|
