feat: added woodpecker config

Reviewed-on: #1
Co-authored-by: Tobias Schmidl <tobias@schmidl.dev>
Co-committed-by: Tobias Schmidl <tobias@schmidl.dev>

.cmake-format.yaml

@@ -3,12 +3,12 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 ---
 format:
-  line_width: 120
+  line_width: 140
   tab_size: 4
   use_tabchars: true
   fractional_tab_policy: round-up
-  max_subgroups_hwrap: 2
+  max_subgroups_hwrap: 3
-  max_pargs_hwrap: 3
+  max_pargs_hwrap: 6
   dangle_parens: true
   dangle_align: prefix
   min_prefix_chars: 0

.ecrc

@@ -0,0 +1,8 @@
+{
+    "IgnoreDefaults": false,
+    "Exclude": [
+        "^LICENSE$",
+        "^LICENSES/.*",
+        "documentation/pages/about.dox"
+    ]
+}

.ecrc.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Tobias Schmidl
+
+SPDX-License-Identifier: AGPL-3.0-or-later

.editorconfig

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: 2023 Tobias Schmidl
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{yaml,yml}]
+indent_size = 2
+
+[*.{cpp,hpp,h}]
+indent_size = 2
+
+[{CMakeLists.txt,*.cmake}]
+indent_style = tabs

.pre-commit-config.yaml

@@ -11,6 +11,7 @@ repos:
   - id: trailing-whitespace
   - id: check-merge-conflict
   - id: check-ast
+  - id: check-byte-order-marker
 - repo: https://github.com/fsfe/reuse-tool
   rev: v2.1.0
   hooks:
@@ -29,4 +30,15 @@ repos:
   hooks:
   - id: clang-format
   - id: clang-tidy
+- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
+  rev: '2.7.2'
+  hooks:
+  - id: editorconfig-checker
+    alias: ec
+    stages: [commit]
+- repo: https://github.com/compilerla/conventional-pre-commit
+  rev: v2.4.0
+  hooks:
+  - id: conventional-pre-commit
+    stages: [commit-msg]
 ...

.woodpecker.yml

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2023 Tobias Schmidl
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+---
+steps:
+
+  editor-config:
+    image: mstruebing/editorconfig-checker
+    group: lint
+
+  reuse:
+    image: fsfe/reuse:latest
+    group: lint
+
+...

CMakeLists.txt

@@ -8,18 +8,11 @@ include(cmake/version-from-git.cmake)
 
 # ---- Project ----
 
-project(
+project(Glimpses VERSION ${VERSION_STRING} LANGUAGES CXX)
-	Glimpses
-	VERSION ${VERSION_STRING}
-	LANGUAGES CXX
-)
 
 # ---- Include guards ----
 if(PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR)
-	message(
+	message(FATAL_ERROR "In-source builds not allowed. Please make a new directory (called a build directory) and run CMake from there.")
-		FATAL_ERROR
-			"In-source builds not allowed. Please make a new directory (called a build directory) and run CMake from there."
-	)
 endif()
 
 # ---- Add dependencies via CPM ----
@@ -30,22 +23,11 @@ include(cmake/CPM.cmake)
 # PackageProject.cmake will be used to make our target installable
 CPMAddPackage("gh:TheLartians/PackageProject.cmake@1.8.0")
 
-# CPMAddPackage( NAME fmt GIT_TAG 9.1.0 GITHUB_REPOSITORY fmtlib/fmt OPTIONS "FMT_INSTALL YES" # create an installable
+# CPMAddPackage( NAME fmt GIT_TAG 9.1.0 GITHUB_REPOSITORY fmtlib/fmt OPTIONS "FMT_INSTALL YES" # create an installable target )
-# target )
 
 # ---- Add source files ----
-file(
+file(GLOB_RECURSE headers CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h")
-	GLOB_RECURSE
+file(GLOB_RECURSE sources CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/source/*.cpp")
-	headers
-	CONFIGURE_DEPENDS
-	"${CMAKE_CURRENT_SOURCE_DIR}/include/*.h"
-)
-file(
-	GLOB_RECURSE
-	sources
-	CONFIGURE_DEPENDS
-	"${CMAKE_CURRENT_SOURCE_DIR}/source/*.cpp"
-)
 
 # ---- Create library ----
 
@@ -60,8 +42,7 @@ target_link_libraries(${PROJECT_NAME} PRIVATE # fmt::fmt
 )
 
 target_include_directories(
-	${PROJECT_NAME} PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+	${PROJECT_NAME} PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include> $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
-							$<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
 )
 
 # the location where the project's version header will be placed should match the project's regular header paths

LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

all/CMakeLists.txt

@@ -2,8 +2,7 @@
 #
 # SPDX-License-Identifier: CC0-1.0
 
-# this script adds all subprojects to a single build to allow IDEs understand the full project
+# this script adds all subprojects to a single build to allow IDEs understand the full project structure.
-# structure.
 
 cmake_minimum_required(VERSION 3.14...3.22)
 

cmake/CPM.cmake

@@ -16,9 +16,8 @@ endif()
 # Expand relative path. This is important if the provided path contains a tilde (~)
 get_filename_component(CPM_DOWNLOAD_LOCATION ${CPM_DOWNLOAD_LOCATION} ABSOLUTE)
 
-file(DOWNLOAD
+file(DOWNLOAD https://github.com/cpm-cmake/CPM.cmake/releases/download/v${CPM_DOWNLOAD_VERSION}/CPM.cmake ${CPM_DOWNLOAD_LOCATION}
-     https://github.com/cpm-cmake/CPM.cmake/releases/download/v${CPM_DOWNLOAD_VERSION}/CPM.cmake
+		EXPECTED_HASH SHA256=${CPM_HASH_SUM}
-     ${CPM_DOWNLOAD_LOCATION} EXPECTED_HASH SHA256=${CPM_HASH_SUM}
 )
 
 include(${CPM_DOWNLOAD_LOCATION})

cmake/tools.cmake

@@ -2,8 +2,8 @@
 #
 # SPDX-License-Identifier: CC0-1.0
 
-# this file contains a list of tools that can be activated and downloaded on-demand each tool is
+# this file contains a list of tools that can be activated and downloaded on-demand each tool is enabled during configuration by passing an
-# enabled during configuration by passing an additional `-DUSE_<TOOL>=<VALUE>` argument to CMake
+# additional `-DUSE_<TOOL>=<VALUE>` argument to CMake
 
 # only activate tools for top level project
 if(NOT PROJECT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
@@ -12,8 +12,8 @@ endif()
 
 include(${CMAKE_CURRENT_LIST_DIR}/CPM.cmake)
 
-# enables sanitizers support using the the `USE_SANITIZER` flag available values are: Address,
+# enables sanitizers support using the the `USE_SANITIZER` flag available values are: Address, Memory, MemoryWithOrigins, Undefined, Thread,
-# Memory, MemoryWithOrigins, Undefined, Thread, Leak, 'Address;Undefined'
+# Leak, 'Address;Undefined'
 if(USE_SANITIZER OR USE_STATIC_ANALYZER)
 	CPMAddPackage("gh:StableCoder/cmake-scripts#1f822d1fc87c8d7720c074cde8a278b44963c354")
 
@@ -21,39 +21,22 @@ if(USE_SANITIZER OR USE_STATIC_ANALYZER)
 		include(${cmake-scripts_SOURCE_DIR}/sanitizers.cmake)
 	endif()
 
+	# cmake-lint: disable=C0103
 	if(USE_STATIC_ANALYZER)
 		if("clang-tidy" IN_LIST USE_STATIC_ANALYZER)
-      set(CLANG_TIDY
+			set(CLANG_TIDY ON CACHE INTERNAL "")
-          ON
-          CACHE INTERNAL ""
-      )
 		else()
-      set(CLANG_TIDY
+			set(CLANG_TIDY OFF CACHE INTERNAL "")
-          OFF
-          CACHE INTERNAL ""
-      )
 		endif()
 		if("iwyu" IN_LIST USE_STATIC_ANALYZER)
-      set(IWYU
+			set(IWYU ON CACHE INTERNAL "")
-          ON
-          CACHE INTERNAL ""
-      )
 		else()
-      set(IWYU
+			set(IWYU OFF CACHE INTERNAL "")
-          OFF
-          CACHE INTERNAL ""
-      )
 		endif()
 		if("cppcheck" IN_LIST USE_STATIC_ANALYZER)
-      set(CPPCHECK
+			set(CPPCHECK ON CACHE INTERNAL "")
-          ON
-          CACHE INTERNAL ""
-      )
 		else()
-      set(CPPCHECK
+			set(CPPCHECK OFF CACHE INTERNAL "")
-          OFF
-          CACHE INTERNAL ""
-      )
 		endif()
 
 		include(${cmake-scripts_SOURCE_DIR}/tools.cmake)

cmake/version-from-git.cmake

@@ -12,12 +12,7 @@ execute_process(
 	OUTPUT_STRIP_TRAILING_WHITESPACE
 )
 if(GIT_DESCRIBE_ERROR_CODE EQUAL 0)
-	string(
+	string(REGEX MATCH "^v?([0-9]+)(\\.([0-9]+))?(\\.([0-9]+))?(\\.([0-9]+))?.*$" _ "${GIT_DESCRIBE_VERSION_STRING}")
-		REGEX MATCH
-				"^v?([0-9]+)(\\.([0-9]+))?(\\.([0-9]+))?(\\.([0-9]+))?.*$"
-				_
-				"${GIT_DESCRIBE_VERSION_STRING}"
-	)
 	if(DEFINED CMAKE_MATCH_1)
 		set(VERSION_STRING "${CMAKE_MATCH_1}")
 		if(DEFINED CMAKE_MATCH_3)