make it optional to install the package ... (#15)

* make it optional to install the package ...

to version less subdirectories with:
set(INCLUDE_DESTINATION include/${PROJECT_NAME})

* respect review comments

remove diagnostig messages

* according review, use NO_VERSION_SUFFIX option

if set, the install directories are NOT suffixed with -${PROJECT_VERSION}

* Update README.md

Co-authored-by: Lars Melchior <TheLartians@users.noreply.github.com>

* remove comment

still no test for NO_VERSION_SUFFIX?

* Update CMakeLists.txt

Co-authored-by: Lars Melchior <TheLartians@users.noreply.github.com>

* unset _PROJECT_VERSION_SUFFIX if not needed

Co-authored-by: Lars Melchior <TheLartians@users.noreply.github.com>

Author: ClausKlein

CMakeLists.txt

@@ -12,34 +12,41 @@ function(packageProject)
 
   cmake_parse_arguments(
     PROJECT
-    ""
+    "NO_VERSION_SUFFIX"
     "NAME;VERSION;INCLUDE_DIR;INCLUDE_DESTINATION;BINARY_DIR;COMPATIBILITY;VERSION_HEADER;NAMESPACE"
     "DEPENDENCIES"
     ${ARGN}
   )
 
+  if(DEFINED PROJECT_NO_VERSION_SUFFIX)
+    unset(_PROJECT_VERSION_SUFFIX)
+  else()
+    set(_PROJECT_VERSION_SUFFIX -${PROJECT_VERSION})
+  endif()
+
   # handle default arguments
-  if (NOT DEFINED PROJECT_COMPATIBILITY)
+  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
-  if (DEFINED PROJECT_NAMESPACE)
+  if(DEFINED PROJECT_NAMESPACE)
     set(PROJECT_NAMESPACE ${PROJECT_NAMESPACE}::)
     add_library(${PROJECT_NAMESPACE}${PROJECT_NAME} ALIAS ${PROJECT_NAME})
   endif()
 
-  if (DEFINED PROJECT_VERSION_HEADER)
+  if(DEFINED PROJECT_VERSION_HEADER)
     set(PROJECT_VERSION_INCLUDE_DIR ${PROJECT_BINARY_DIR}/PackageProjectInclude)
     string(TOUPPER ${PROJECT_NAME} UPPERCASE_PROJECT_NAME)
     configure_file(
       ${PACKAGE_PROJECT_ROOT_PATH}/version.h.in
       ${PROJECT_VERSION_INCLUDE_DIR}/${PROJECT_VERSION_HEADER}
       @ONLY
     )
+
     get_target_property(target_type ${PROJECT_NAME} TYPE)
-    if (target_type STREQUAL "INTERFACE_LIBRARY")
+    if(target_type STREQUAL "INTERFACE_LIBRARY")
       set(VISIBILITY INTERFACE)
     else()
       set(VISIBILITY PUBLIC)
@@ -60,31 +67,31 @@ function(packageProject)
   install(
     TARGETS ${PROJECT_NAME}
     EXPORT ${PROJECT_NAME}Targets
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}-${PROJECT_VERSION} COMPONENT Runtime
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}-${PROJECT_VERSION} COMPONENT Development
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}/${PROJECT_NAME}-${PROJECT_VERSION} COMPONENT Runtime
-    BUNDLE DESTINATION ${CMAKE_INSTALL_BINDIR}/${PROJECT_NAME}-${PROJECT_VERSION} COMPONENT Runtime
-    PUBLIC_HEADER DESTINATION ${INCLUDE_DESTINATION} COMPONENT Development
+    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}
+    INSTALL_DESTINATION lib/cmake/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX}
   )
 
   install(
     EXPORT ${PROJECT_NAME}Targets
-    DESTINATION lib/cmake/${PROJECT_NAME}-${PROJECT_VERSION}
+    DESTINATION lib/cmake/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX}
     NAMESPACE ${PROJECT_NAMESPACE}
   )
 
   install(
-    FILES 
+    FILES
       "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
       "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
     DESTINATION
-      lib/cmake/${PROJECT_NAME}-${PROJECT_VERSION}
+      lib/cmake/${PROJECT_NAME}${_PROJECT_VERSION_SUFFIX}
   )
 
   install(
@@ -93,4 +100,4 @@ function(packageProject)
   )
 
   set(${PROJECT_NAME}_VERSION ${PROJECT_VERSION} CACHE INTERNAL "")
-endfunction()
+endfunction()

README.md

@@ -33,10 +33,15 @@ packageProject(
   # semicolon separated list of the project's dependencies
   DEPENDENCIES "fmt 7.1.3;cxxopts 2.2.0"
   # (optional) create a header containing the version info
-  # note that the path should be lowercase 
+  # note that the path should be lowercase
   VERSION_HEADER "${PROJECT_NAME}/version.h"
   # (optional) install your library with a namespace (do NOT add extra '::')
   NAMESPACE ${PROJECT_NAMESPACE}
+  # (optional) define the project's version compatibility, defaults to `AnyNewerVersion`
+  # supported values: `AnyNewerVersion|SameMajorVersion|SameMinorVersion|ExactVersion`
+  COMPATIBILITY AnyNewerVersion
+  # (optional) flag to disable the versioning of install destinations
+  NO_VERSION_SUFFIX
 )
 ```
 

test/CMakeLists.txt

@@ -2,7 +2,7 @@ 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
 )
@@ -19,9 +19,9 @@ endif()
 
 add_executable(test main.cpp)
 
-target_link_libraries(test 
-  dependency 
-  ns::namespaced_dependency 
+target_link_libraries(test
+  dependency
+  ns::namespaced_dependency
   transitive_dependency::transitive_dependency
 )
 

test/dependency/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
-project(dependency 
+project(dependency
   VERSION 1.2.3
   LANGUAGES CXX
 )