Merge pull request #7 from stlab/sean-parent/cleanup

Cleanup

Author: sean-parent

README.md

@@ -12,7 +12,6 @@ Modern CMake template for C++ libraries with comprehensive infrastructure.
 `cpp-library` provides a standardized CMake infrastructure template for C++ libraries. It eliminates boilerplate and provides consistent patterns for:
 
 - **Project Declaration**: Uses existing `project()` declaration with automatic git tag-based versioning
-- **Library Setup**: INTERFACE targets with proper installation and package config
 - **Testing**: Integrated doctest with CTest and compile-fail test support
 - **Documentation**: Doxygen with doxygen-awesome-css theme
 - **Development Tools**: clangd integration, CMakePresets.json, clang-tidy support
@@ -29,7 +28,10 @@ cmake_minimum_required(VERSION 3.20)
 # Project declaration - cpp_library_setup will use this name and detect version from git tags
 project(your-library)
 
-set(CPM_SOURCE_CACHE ${CMAKE_SOURCE_DIR}/.cache/cpm CACHE PATH "CPM cache")
+# Setup cpp-library infrastructure
+if(PROJECT_IS_TOP_LEVEL)
+    set(CPM_SOURCE_CACHE ${CMAKE_SOURCE_DIR}/.cache/cpm CACHE PATH "CPM cache")
+endif()
 include(cmake/CPM.cmake)
 
 # Fetch cpp-library via CPM
@@ -64,13 +66,13 @@ cpp_library_setup(
     DESCRIPTION description        # e.g., "Type-safe operators for enums"
     NAMESPACE namespace            # e.g., "stlab"
     HEADERS header_list            # List of header filenames (e.g., "your_header.hpp")
-    
+
     # Source specification for non-header-only libraries
     SOURCES source_list            # List of source filenames (e.g., "your_library.cpp", omit for header-only libraries)
 
     # Optional features
     [EXAMPLES example_list]        # Example source files to build (e.g., "example.cpp example_fail.cpp")
-    [TESTS test_list]              # Test source files to build (e.g., "tests.cpp")  
+    [TESTS test_list]              # Test source files to build (e.g., "tests.cpp")
     [DOCS_EXCLUDE_SYMBOLS symbols] # Symbols to exclude from docs
     [REQUIRES_CPP_VERSION 17|20|23] # C++ version (default: 17)
 )
@@ -118,6 +120,7 @@ The template automatically generates the full paths based on these conventions.
 ### Library Types
 
 **Header-only libraries**: Specify only `HEADERS`, omit `SOURCES`
+
 ```cmake
 cpp_library_setup(
     DESCRIPTION "Header-only library"
@@ -128,6 +131,7 @@ cpp_library_setup(
 ```
 
 **Non-header-only libraries**: Specify both `HEADERS` and `SOURCES`
+
 ```cmake
 cpp_library_setup(
     DESCRIPTION "Library with implementation"
@@ -138,15 +142,15 @@ cpp_library_setup(
 ```
 
 ## Features
+
 ### Non-Header-Only Library Support
 
 - **Non-header-only library support**: For libraries with source files, specify them explicitly with the `SOURCES` argument as filenames (e.g., `"your_library.cpp"`).
-    Both header-only and compiled libraries are supported seamlessly.
+  Both header-only and compiled libraries are supported seamlessly.
 
 ### Automated Infrastructure
 
 - **CMakePresets.json**: Generates standard presets (default, test, docs, clang-tidy, init)
-- **Installation**: Modern CMake package config with FILE_SET headers
 - **Testing**: doctest integration with CTest and compile-fail test support
 - **Documentation**: Doxygen with doxygen-awesome-css theme
 - **Development**: clangd compile_commands.json symlink
@@ -155,12 +159,12 @@ cpp_library_setup(
 ### Smart Defaults
 
 - **C++17** standard requirement (configurable)
-- **Ninja** generator in presets  
+- **Ninja** generator in presets
 - **Debug** builds for testing, **Release** for default
 - **Build isolation** with separate build directories
 - **Two-mode operation**: Full infrastructure when top-level, lightweight when consumed
 - **Automatic version detection**: Version is automatically extracted from git tags (e.g., `v1.2.3` becomes `1.2.3`)
-- **Always-enabled features**: CI/CD, CMakePresets.json, and proper installation are always generated
+- **Always-enabled features**: CI/CD, and CMakePresets.json, are always generated
 
 ### Testing Features
 
@@ -172,7 +176,7 @@ cpp_library_setup(
 ### Documentation Features
 
 - **Doxygen integration** with modern configuration
-- **[email protected].0** theme for beautiful output
+- **[email protected].1** theme for beautiful output
 - **Symbol exclusion** support for implementation details
 - **GitHub Pages deployment** via CI
 - **Custom Doxyfile support** (falls back to template)
@@ -223,7 +227,9 @@ cmake_minimum_required(VERSION 3.20)
 project(enum-ops)
 
 # Setup cpp-library infrastructure
-set(CPM_SOURCE_CACHE ${CMAKE_SOURCE_DIR}/.cache/cpm CACHE PATH "CPM cache" FORCE)
+if(PROJECT_IS_TOP_LEVEL)
+    set(CPM_SOURCE_CACHE ${CMAKE_SOURCE_DIR}/.cache/cpm CACHE PATH "CPM cache")
+endif()
 include(cmake/CPM.cmake)
 
 # Fetch cpp-library via CPM
@@ -244,13 +250,14 @@ cpp_library_setup(
 ## Quick Start
 
 1. **Initialize a new project**:
+
    ```bash
    # Clone or create your project
    mkdir my-library && cd my-library
-   
+
     # Create basic structure
     mkdir -p include/your_namespace src examples tests cmake
-   
+
    # Add CPM.cmake
    curl -L https://github.com/cpm-cmake/CPM.cmake/releases/latest/download/get_cpm.cmake -o cmake/CPM.cmake
    ```
@@ -264,6 +271,7 @@ cpp_library_setup(
 5. **Add tests** to `tests/` (use `_fail` suffix for compile-fail tests, e.g., `tests.cpp`, `tests_fail.cpp`)
 
 6. **Build and test**:
+
    ```bash
    cmake --preset=test
    cmake --build --preset=test
@@ -280,11 +288,11 @@ cpp_library_setup(
 
 The template automatically generates:
 
- - **CMakePresets.json**: Build configurations for different purposes
- - **.github/workflows/ci.yml**: Multi-platform CI/CD pipeline
- - **.gitignore**: Standard ignores for C++ projects
- - **src/**: Source directory for non-header-only libraries (auto-detected)
- - **Package config files**: For proper CMake integration
+- **CMakePresets.json**: Build configurations for different purposes
+- **.github/workflows/ci.yml**: Multi-platform CI/CD pipeline
+- **.gitignore**: Standard ignores for C++ projects
+- **src/**: Source directory for non-header-only libraries (auto-detected)
+- **Package config files**: For proper CMake integration
 
 ## License
 

cmake/cpp-library-docs.cmake

@@ -11,28 +11,29 @@ function(_cpp_library_setup_docs)
     set(multiValueArgs
         DOCS_EXCLUDE_SYMBOLS
     )
-    
+
     cmake_parse_arguments(ARG "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
-    
+
     find_package(Doxygen REQUIRED)
     if(NOT DOXYGEN_FOUND)
         message(WARNING "Doxygen not found. Documentation will not be built.")
         return()
     endif()
-    
+
     # Download doxygen-awesome-css theme via CPM
+    # https://github.com/jothepro/doxygen-awesome-css
     CPMAddPackage(
-        URI gh:jothepro/[email protected].0
+        URI gh:jothepro/[email protected].1
         DOWNLOAD_ONLY YES
     )
-    
+
     # Set the CSS directory path
     set(AWESOME_CSS_DIR ${doxygen-awesome-css_SOURCE_DIR})
-    
+
     # Configure Doxyfile from template
     set(DOXYFILE_IN ${CPP_LIBRARY_ROOT}/templates/Doxyfile.in)
     set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
-    
+
     # Set variables for Doxyfile template
     set(PROJECT_NAME "${ARG_NAME}")
     set(PROJECT_BRIEF "${ARG_DESCRIPTION}")
@@ -41,27 +42,27 @@ function(_cpp_library_setup_docs)
     set(OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}")
     set(AWESOME_CSS_PATH "${AWESOME_CSS_DIR}")
     set(EXAMPLES_PATH "${CMAKE_CURRENT_SOURCE_DIR}/examples")
-    
+
     # Convert exclude symbols list to space-separated string
     if(ARG_DOCS_EXCLUDE_SYMBOLS)
         string(REPLACE ";" " " EXCLUDE_SYMBOLS_STR "${ARG_DOCS_EXCLUDE_SYMBOLS}")
         set(EXCLUDE_SYMBOLS "${EXCLUDE_SYMBOLS_STR}")
     else()
         set(EXCLUDE_SYMBOLS "")
     endif()
-    
+
     # Check if we have a custom Doxyfile, otherwise use template
     if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile")
         configure_file("${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile" ${DOXYFILE_OUT} @ONLY)
     else()
         configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
     endif()
-    
+
     # Add custom target for documentation with proper stderr capture
     if(WIN32)
         # On Windows, use PowerShell to redirect stderr to stdout
         add_custom_target(docs
-            COMMAND PowerShell -Command "& { ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} 2>&1 }"
+            COMMAND PowerShell -Command "& '${DOXYGEN_EXECUTABLE}' '${DOXYFILE_OUT}' 2>&1"
             WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
             COMMENT "Generating API documentation with Doxygen"
             VERBATIM
@@ -75,11 +76,11 @@ function(_cpp_library_setup_docs)
             VERBATIM
         )
     endif()
-    
+
     # Ensure the output directory exists
     file(MAKE_DIRECTORY ${OUTPUT_DIR})
-    
+
     message(STATUS "Documentation target 'docs' configured")
     message(STATUS "Run 'cmake --build . --target docs' to generate documentation")
-    
+
 endfunction()

cmake/cpp-library-setup.cmake

@@ -12,7 +12,7 @@ function(_cpp_library_get_git_version OUTPUT_VAR)
         OUTPUT_STRIP_TRAILING_WHITESPACE
         ERROR_QUIET
     )
-    
+
     # If git tag found, use it (remove 'v' prefix if present)
     if(GIT_TAG_VERSION)
         string(REGEX REPLACE "^v" "" CLEAN_VERSION "${GIT_TAG_VERSION}")
@@ -27,7 +27,7 @@ endfunction()
 function(_cpp_library_setup_core)
     set(oneValueArgs
         NAME
-        VERSION 
+        VERSION
         DESCRIPTION
         NAMESPACE
         REQUIRES_CPP_VERSION
@@ -37,28 +37,27 @@ function(_cpp_library_setup_core)
         HEADERS
         SOURCES
     )
-    
+
     cmake_parse_arguments(ARG "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
-    
+
     # Get version from git tags if not provided
     if(NOT ARG_VERSION)
         _cpp_library_get_git_version(GIT_VERSION)
         set(ARG_VERSION "${GIT_VERSION}")
     endif()
-    
+
     # Note: Project declaration is now handled in the main cpp_library_setup function
     # No need to check ARG_TOP_LEVEL here for project declaration
-    
+
     # Extract the library name without namespace prefix for target naming
     string(REPLACE "${ARG_NAMESPACE}-" "" CLEAN_NAME "${ARG_NAME}")
-    
+
     if(ARG_SOURCES)
         # Create a regular library if sources are present
         add_library(${ARG_NAME} STATIC ${ARG_SOURCES})
         add_library(${ARG_NAMESPACE}::${CLEAN_NAME} ALIAS ${ARG_NAME})
         target_include_directories(${ARG_NAME} PUBLIC
             $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-            $<INSTALL_INTERFACE:include>
         )
         target_compile_features(${ARG_NAME} PUBLIC cxx_std_${ARG_REQUIRES_CPP_VERSION})
         if(ARG_HEADERS)
@@ -75,7 +74,6 @@ function(_cpp_library_setup_core)
         add_library(${ARG_NAMESPACE}::${CLEAN_NAME} ALIAS ${ARG_NAME})
         target_include_directories(${ARG_NAME} INTERFACE
             $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-            $<INSTALL_INTERFACE:include>
         )
         target_compile_features(${ARG_NAME} INTERFACE cxx_std_${ARG_REQUIRES_CPP_VERSION})
         if(ARG_HEADERS)
@@ -87,46 +85,7 @@ function(_cpp_library_setup_core)
             )
         endif()
     endif()
-    
-    # Only set up full installation when building as top-level project
-    if(ARG_TOP_LEVEL)
-        include(GNUInstallDirs)
-        include(CMakePackageConfigHelpers)
-        
-        # Install the target
-        install(TARGETS ${ARG_NAME}
-            EXPORT ${ARG_NAME}Targets
-            FILE_SET headers DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-        )
-        
-        # Generate package config files
-        write_basic_package_version_file(
-            "${CMAKE_CURRENT_BINARY_DIR}/${ARG_NAME}ConfigVersion.cmake"
-            VERSION ${ARG_VERSION}
-            COMPATIBILITY SameMajorVersion
-        )
-        
-        configure_file(
-            "${CPP_LIBRARY_ROOT}/templates/Config.cmake.in"
-            "${CMAKE_CURRENT_BINARY_DIR}/${ARG_NAME}Config.cmake"
-            @ONLY
-        )
-        
-        # Install export targets
-        install(EXPORT ${ARG_NAME}Targets
-            FILE ${ARG_NAME}Targets.cmake
-            NAMESPACE ${ARG_NAMESPACE}::
-            DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${ARG_NAME}
-        )
-        
-        # Install config files
-        install(FILES
-            "${CMAKE_CURRENT_BINARY_DIR}/${ARG_NAME}Config.cmake"
-            "${CMAKE_CURRENT_BINARY_DIR}/${ARG_NAME}ConfigVersion.cmake"
-            DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${ARG_NAME}
-        )
-    endif()
-    
+
 endfunction()
 
 # Function to copy static template files
@@ -148,15 +107,15 @@ function(_cpp_library_copy_templates)
     foreach(template_file IN LISTS TEMPLATE_FILES)
         set(source_file "${CPP_LIBRARY_ROOT}/templates/${template_file}")
         set(dest_file "${CMAKE_CURRENT_SOURCE_DIR}/${template_file}")
-        
+
         # Check if template file exists
         if(EXISTS "${source_file}")
             # Copy if file doesn't exist or FORCE_INIT is enabled
             if(NOT EXISTS "${dest_file}" OR ARG_FORCE_INIT)
                 # Create directory if needed
                 get_filename_component(dest_dir "${dest_file}" DIRECTORY)
                 file(MAKE_DIRECTORY "${dest_dir}")
-                
+
                 # Copy the file
                 file(COPY "${source_file}" DESTINATION "${dest_dir}")
                 message(STATUS "Copied template file: ${template_file}")