Add code formatting (#17)

* add style config and enforce formatting

* remove leading underscore from var name

.clang-format

@@ -0,0 +1,16 @@
+---
+  BasedOnStyle: Google
+  AccessModifierOffset: '-2'
+  AlignTrailingComments: 'true'
+  AllowAllParametersOfDeclarationOnNextLine: 'false'
+  AlwaysBreakTemplateDeclarations: 'No'
+  BreakBeforeBraces: Attach
+  ColumnLimit: '100'
+  ConstructorInitializerAllOnOneLineOrOnePerLine: 'true'
+  IncludeBlocks: Regroup
+  IndentPPDirectives: AfterHash
+  IndentWidth: '2'
+  NamespaceIndentation: All
+  BreakBeforeBinaryOperators: All
+  BreakBeforeTernaryOperators: 'true'
+...

.cmake-format

@@ -0,0 +1,57 @@
+format:
+  tab_size: 2
+  line_width: 100
+  dangle_parens: true
+
+parse:
+  additional_commands:
+    cpmaddpackage:
+      pargs:
+        nargs: '*'
+        flags: []
+      spelling: CPMAddPackage
+      kwargs: &cpmaddpackagekwargs
+        NAME: 1
+        FORCE: 1
+        VERSION: 1
+        GIT_TAG: 1
+        DOWNLOAD_ONLY: 1
+        GITHUB_REPOSITORY: 1
+        GITLAB_REPOSITORY: 1
+        GIT_REPOSITORY: 1
+        SVN_REPOSITORY: 1
+        SVN_REVISION: 1
+        SOURCE_DIR: 1
+        DOWNLOAD_COMMAND: 1
+        FIND_PACKAGE_ARGUMENTS: 1
+        NO_CACHE: 1
+        GIT_SHALLOW: 1
+        URL: 1
+        URL_HASH: 1
+        URL_MD5: 1
+        DOWNLOAD_NAME: 1
+        DOWNLOAD_NO_EXTRACT: 1
+        HTTP_USERNAME: 1
+        HTTP_PASSWORD: 1
+        OPTIONS: +
+    cpmfindpackage:
+      pargs:
+        nargs: '*'
+        flags: []
+      spelling: CPMFindPackage
+      kwargs: *cpmaddpackagekwargs
+    packageproject:
+      pargs:
+        nargs: '*'
+        flags: []
+      spelling: packageProject
+      kwargs:
+        NAME: 1
+        VERSION: 1
+        NAMESPACE: 1
+        INCLUDE_DIR: 1
+        INCLUDE_DESTINATION: 1
+        BINARY_DIR: 1
+        COMPATIBILITY: 1
+        VERSION_HEADER: 1
+        DEPENDENCIES: +

.github/workflows/style.yml

@@ -0,0 +1,28 @@
+name: Style
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  style:
+
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Install format dependencies
+      run: |
+        brew install clang-format
+        pip3 install cmake_format==0.6.11 pyyaml
+
+    - name: configure
+      run: cmake -Stest/style -Bbuild/style
+
+    - name: check style
+      run: cmake --build build/style --target check-format

CMakeLists.txt

@@ -1,36 +1,32 @@
-
-set(
-  PACKAGE_PROJECT_ROOT_PATH
-  "${CMAKE_CURRENT_LIST_DIR}"
-  CACHE INTERNAL
-  "The path to the PackageProject directory"
+set(PACKAGE_PROJECT_ROOT_PATH
+    "${CMAKE_CURRENT_LIST_DIR}"
+    CACHE INTERNAL "The path to the PackageProject directory"
 )
 
 function(packageProject)
   include(CMakePackageConfigHelpers)
   include(GNUInstallDirs)
 
   cmake_parse_arguments(
-    PROJECT
-    "NO_VERSION_SUFFIX"
+    PROJECT "NO_VERSION_SUFFIX"
     "NAME;VERSION;INCLUDE_DIR;INCLUDE_DESTINATION;BINARY_DIR;COMPATIBILITY;VERSION_HEADER;NAMESPACE"
-    "DEPENDENCIES"
-    ${ARGN}
+    "DEPENDENCIES" ${ARGN}
   )
 
   if(DEFINED PROJECT_NO_VERSION_SUFFIX)
-    unset(_PROJECT_VERSION_SUFFIX)
+    unset(PROJECT_VERSION_SUFFIX)
   else()
-    set(_PROJECT_VERSION_SUFFIX -${PROJECT_VERSION})
+    set(PROJECT_VERSION_SUFFIX -${PROJECT_VERSION})
   endif()
 
   # handle default arguments
   if(NOT DEFINED PROJECT_COMPATIBILITY)
     set(PROJECT_COMPATIBILITY AnyNewerVersion)
   endif()
 
-  # we wanto to automatically add :: to our namespace, so only append if a namespace was given in the first place
-  # we also provide an alias to ensure that local and installed versions have the same name
+  # we wanto to automatically add :: to our namespace, so only append if a namespace was given in
+  # the first place we also provide an alias to ensure that local and installed versions have the
+  # same name
   if(DEFINED PROJECT_NAMESPACE)
     set(PROJECT_NAMESPACE ${PROJECT_NAMESPACE}::)
     add_library(${PROJECT_NAMESPACE}${PROJECT_NAME} ALIAS ${PROJECT_NAME})
@@ -41,8 +37,7 @@ function(packageProject)
     string(TOUPPER ${PROJECT_NAME} UPPERCASE_PROJECT_NAME)
     configure_file(
       ${PACKAGE_PROJECT_ROOT_PATH}/version.h.in
-      ${PROJECT_VERSION_INCLUDE_DIR}/${PROJECT_VERSION_HEADER}
-      @ONLY
+      ${PROJECT_VERSION_INCLUDE_DIR}/${PROJECT_VERSION_HEADER} @ONLY
     )
 
     get_target_property(target_type ${PROJECT_NAME} TYPE)
@@ -51,11 +46,10 @@ function(packageProject)
     else()
       set(VISIBILITY PUBLIC)
     endif()
-    target_include_directories(${PROJECT_NAME} ${VISIBILITY} "$<BUILD_INTERFACE:${PROJECT_VERSION_INCLUDE_DIR}>")
-    install(
-      DIRECTORY ${PROJECT_VERSION_INCLUDE_DIR}/
-      DESTINATION ${PROJECT_INCLUDE_DESTINATION}
+    target_include_directories(
+      ${PROJECT_NAME} ${VISIBILITY} "$<BUILD_INTERFACE:${PROJECT_VERSION_INCLUDE_DIR}>"
     )
+    install(DIRECTORY ${PROJECT_VERSION_INCLUDE_DIR}/ DESTINATION ${PROJECT_INCLUDE_DESTINATION})
   endif()
 
   write_basic_package_version_file(
@@ -67,37 +61,37 @@ function(packageProject)
   install(
     TARGETS ${PROJECT_NAME}
     EXPORT ${PROJECT_NAME}Targets
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX} COMPONENT Runtime
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX} COMPONENT Development
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX} COMPONENT Runtime
-    BUNDLE DESTINATION ${CMAKE_INSTALL_BINDIR}/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX} COMPONENT Runtime
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}${PROJECT_VERSION_SUFFIX}
+            COMPONENT Runtime
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}${PROJECT_VERSION_SUFFIX}
+            COMPONENT Development
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}/${PROJECT_NAME}${PROJECT_VERSION_SUFFIX}
+            COMPONENT Runtime
+    BUNDLE DESTINATION ${CMAKE_INSTALL_BINDIR}/${PROJECT_NAME}${PROJECT_VERSION_SUFFIX}
+           COMPONENT Runtime
     PUBLIC_HEADER DESTINATION ${PROJECT_INCLUDE_DESTINATION} COMPONENT Development
   )
 
   configure_package_config_file(
-    ${PACKAGE_PROJECT_ROOT_PATH}/Config.cmake.in
-    "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-    INSTALL_DESTINATION lib/cmake/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX}
+    ${PACKAGE_PROJECT_ROOT_PATH}/Config.cmake.in "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+    INSTALL_DESTINATION lib/cmake/${PROJECT_NAME}${PROJECT_VERSION_SUFFIX}
   )
 
   install(
     EXPORT ${PROJECT_NAME}Targets
-    DESTINATION lib/cmake/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX}
+    DESTINATION lib/cmake/${PROJECT_NAME}${PROJECT_VERSION_SUFFIX}
     NAMESPACE ${PROJECT_NAMESPACE}
   )
 
-  install(
-    FILES
-      "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
-      "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-    DESTINATION
-      lib/cmake/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX}
+  install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+                "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+          DESTINATION lib/cmake/${PROJECT_NAME}${PROJECT_VERSION_SUFFIX}
   )
 
-  install(
-    DIRECTORY ${PROJECT_INCLUDE_DIR}/
-    DESTINATION ${PROJECT_INCLUDE_DESTINATION}
-  )
+  install(DIRECTORY ${PROJECT_INCLUDE_DIR}/ DESTINATION ${PROJECT_INCLUDE_DESTINATION})
 
-  set(${PROJECT_NAME}_VERSION ${PROJECT_VERSION} CACHE INTERNAL "")
+  set(${PROJECT_NAME}_VERSION
+      ${PROJECT_VERSION}
+      CACHE INTERNAL ""
+  )
 endfunction()

test/CMakeLists.txt

@@ -2,12 +2,13 @@ cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
 option(TEST_INSTALLED_VERSION "Test the version found by find_package" OFF)
 
-project(PackageProjectTest
+project(
+  PackageProjectTest
   VERSION 1.0
   LANGUAGES CXX
 )
 
-if (TEST_INSTALLED_VERSION)
+if(TEST_INSTALLED_VERSION)
   find_package(dependency 1.2.3 REQUIRED)
   find_package(namespaced_dependency 4.5.6 REQUIRED)
   find_package(transitive_dependency 7.8.9 REQUIRED)
@@ -19,9 +20,6 @@ endif()
 
 add_executable(test main.cpp)
 
-target_link_libraries(test
-  dependency
-  ns::namespaced_dependency
-  transitive_dependency::transitive_dependency
+target_link_libraries(
+  test dependency ns::namespaced_dependency transitive_dependency::transitive_dependency
 )
-

test/dependency/CMakeLists.txt

@@ -1,16 +1,16 @@
 cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
-project(dependency
+project(
+  dependency
   VERSION 1.2.3
   LANGUAGES CXX
 )
 
 add_library(dependency source/dependency.cpp)
 
-target_include_directories(dependency
-  PUBLIC
-    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-    $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+target_include_directories(
+  dependency PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+                    $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
 )
 
 add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../.. ${CMAKE_CURRENT_BINARY_DIR}/PackageProject)

test/dependency/source/dependency.cpp

@@ -1,6 +1,7 @@
-#include <iostream>
 #include <dependency/version.h>
 
+#include <iostream>
+
 void dependencyFunction() {
   std::cout << "Using dependency version " << DEPENDENCY_VERSION << std::endl;
 }

test/main.cpp

@@ -4,6 +4,7 @@
 #include <namespaced_dependency/version.h>
 #include <transitive_dependency/transitive_dependency.h>
 #include <transitive_dependency/version.h>
+
 #include <string>
 
 int main() {

test/namespaced_dependency/CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
-project(namespaced_dependency
+project(
+  namespaced_dependency
   VERSION 4.5.6
   LANGUAGES CXX
 )
@@ -10,10 +11,9 @@ add_library(${PROJECT_NAME} source/namespaced_dependency.cpp)
 # the alias ${PROJECT_NAMESPACE}::${PROJECT_NAME} is automatically provided by PackageProject.cmake
 # if we use the `NAMESPACE` parameter
 
-target_include_directories(namespaced_dependency
-  PUBLIC
-    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-    $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+target_include_directories(
+  namespaced_dependency PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+                               $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
 )
 
 add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../.. ${CMAKE_CURRENT_BINARY_DIR}/PackageProject)

test/namespaced_dependency/include/namespaced_dependency/namespaced_dependency.h

@@ -2,6 +2,6 @@
 
 namespace ns {
 
-	void namespacedDependencyFunction();
+  void namespacedDependencyFunction();
 
 }

test/namespaced_dependency/source/namespaced_dependency.cpp

@@ -1,8 +1,10 @@
-#include <iostream>
 #include <namespaced_dependency/version.h>
 
+#include <iostream>
+
 namespace ns {
-	void namespacedDependencyFunction() {
-		std::cout << "Using namespaced_dependency version " << NAMESPACED_DEPENDENCY_VERSION << std::endl;
-	}
-}
+  void namespacedDependencyFunction() {
+    std::cout << "Using namespaced_dependency version " << NAMESPACED_DEPENDENCY_VERSION
+              << std::endl;
+  }
+}  // namespace ns

test/style/CMakeLists.txt

@@ -0,0 +1,23 @@
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+project(StyleCheck)
+
+set(CPM_DOWNLOAD_VERSION 0.28.1)
+set(CPM_DOWNLOAD_LOCATION "${CMAKE_BINARY_DIR}/cmake/CPM_${CPM_DOWNLOAD_VERSION}.cmake")
+
+if(NOT (EXISTS ${CPM_DOWNLOAD_LOCATION}))
+  message(STATUS "Downloading CPM.cmake v${CPM_DOWNLOAD_VERSION}")
+  file(DOWNLOAD
+       https://github.com/cpm-cmake/CPM.cmake/releases/download/v${CPM_DOWNLOAD_VERSION}/CPM.cmake
+       ${CPM_DOWNLOAD_LOCATION}
+  )
+endif()
+
+include(${CPM_DOWNLOAD_LOCATION})
+
+CPMAddPackage(
+  NAME Format.cmake
+  VERSION 1.6
+  GITHUB_REPOSITORY TheLartians/Format.cmake
+  OPTIONS "FORMAT_CHECK_CMAKE ON"
+)

test/transitive_dependency/CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
-project(transitive_dependency
+project(
+  transitive_dependency
   VERSION 7.8.9
   LANGUAGES CXX
 )
@@ -25,10 +26,9 @@ add_library(${PROJECT_NAME} source/transitive_dependency.cpp)
 target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_17)
 target_link_libraries(${PROJECT_NAME} fmt cxxopts)
 
-target_include_directories(transitive_dependency
-  PUBLIC
-    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-    $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+target_include_directories(
+  transitive_dependency PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+                               $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
 )
 
 add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../.. ${CMAKE_CURRENT_BINARY_DIR}/PackageProject)