Cleanup with pre-commit

Author: ClausKlein

.TODO.txt

@@ -21,16 +21,16 @@ test 1
 1:   CMake's support for `import std;` in C++23 and newer is experimental.  It
 1:   is meant only for experimentation and feedback to CMake developers.
 1: This warning is for project developers.  Use -Wno-dev to suppress it.
-1: 
+1:
 1: Generating done (0.0s)
 1: Build files have been written to: /Users/clausklein/Workspace/cpp/cxx20/fmt-module/build/dev/tests/find-package-test
 1: ======== End CMake output ======
 1: Change Dir: '/Users/clausklein/Workspace/cpp/cxx20/fmt-module/build/dev/tests/find-package-test'
-1: 
+1:
 1: Run Clean Command: /Users/clausklein/.local/bin/ninja clean
 1: [1/1] Cleaning all built files...
 1: Cleaning... 22 files.
-1: 
+1:
 1: Run Build Command(s): /Users/clausklein/.local/bin/ninja
 1: [1/12] Scanning /usr/local/Cellar/gcc/15.2.0/include/c++/15/bits/std.compat.cc for CXX dependencies
 1: [2/12] Scanning /usr/local/Cellar/gcc/15.2.0/include/c++/15/bits/std.cc for CXX dependencies
@@ -44,7 +44,7 @@ test 1
 1: [10/12] Building CXX object 'CMakeFiles/fmt__fmt@synth_439f33eb51e5.dir/f6569b67b774.bmi'
 1: [11/12] Building CXX object CMakeFiles/module_header-only-test.dir/Users/clausklein/Workspace/cpp/cxx20/fmt-module/tests/header-only-test.cc.o
 1: [12/12] Linking CXX executable module_header-only-test
-1: FAILED: [code=1] module_header-only-test 
+1: FAILED: [code=1] module_header-only-test
 1: : && /usr/local/bin/g++-15 -stdlib=libstdc++ -O3 -DNDEBUG -Wl,-search_paths_first -Wl,-headerpad_max_install_names -stdlib=libstdc++ CMakeFiles/module_header-only-test.dir/Users/clausklein/Workspace/cpp/cxx20/fmt-module/tests/header-only-test.cc.o -o module_header-only-test  /Users/clausklein/Workspace/cpp/cxx20/fmt-module/stagedir/lib/libfmt.a && :
 1: Undefined symbols for architecture x86_64:
 1:   "initializer for module std", referenced from:
@@ -54,7 +54,7 @@ test 1
 1: ld: symbol(s) not found for architecture x86_64
 1: collect2: error: ld returned 1 exit status
 1: ninja: build stopped: subcommand failed.
-1: 
+1:
 1/1 Test #1: find-package-test ................***Failed    9.90 sec
 Internal cmake changing into directory: /Users/clausklein/Workspace/cpp/cxx20/fmt-module/build/dev/tests/find-package-test
 ======== CMake output     ======
@@ -88,7 +88,7 @@ Run Build Command(s): /Users/clausklein/.local/bin/ninja
 [10/12] Building CXX object 'CMakeFiles/fmt__fmt@synth_439f33eb51e5.dir/f6569b67b774.bmi'
 [11/12] Building CXX object CMakeFiles/module_header-only-test.dir/Users/clausklein/Workspace/cpp/cxx20/fmt-module/tests/header-only-test.cc.o
 [12/12] Linking CXX executable module_header-only-test
-FAILED: [code=1] module_header-only-test 
+FAILED: [code=1] module_header-only-test
 : && /usr/local/bin/g++-15 -stdlib=libstdc++ -O3 -DNDEBUG -Wl,-search_paths_first -Wl,-headerpad_max_install_names -stdlib=libstdc++ CMakeFiles/module_header-only-test.dir/Users/clausklein/Workspace/cpp/cxx20/fmt-module/tests/header-only-test.cc.o -o module_header-only-test  /Users/clausklein/Workspace/cpp/cxx20/fmt-module/stagedir/lib/libfmt.a && :
 Undefined symbols for architecture x86_64:
   "initializer for module std", referenced from:

.bumpversion.cfg

@@ -6,33 +6,33 @@ tag_name = v{new_version}
 tag = False
 current_version = 12.1.0-dev1
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)([-](?P<release>(dev|rc))+(?P<build>\d+))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}-{release}{build}
 	{major}.{minor}.{patch}
 
 [bumpversion:part:release]
 first_value = dev
 optional_value = ga
-values = 
+values =
 	dev
 	rc
 	ga
 
 [bumpversion:file:CMakeLists.txt]
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<build>\d+))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}.{build}
 	{major}.{minor}.{patch}
 
 [bumpversion:file:tests/CMakeLists.txt]
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<build>\d+))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}.{build}
 	{major}.{minor}.{patch}
 
 [bumpversion:file:module/tests/CMakeLists.txt]
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<build>\d+))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}.{build}
 	{major}.{minor}.{patch}
 

.bumpversion.md

@@ -5,7 +5,6 @@ bumpversion flow:
     1.0.0 => 1.0.1-dev0 => 1.0.1-dev1 = > 1.0.1-rc0 => 1.0.1-rc1 => 1.0.1
              patch         build          release      build        release
 
-
 ## Details
 
 Start with an initial release, say `1.0.0`.
@@ -34,14 +33,12 @@ Start with an initial release, say `1.0.0`.
         git tag => v1.0.1-rc1
         CMake PROJECT_VERSION => 1.0.1.1
 
-4. Finally, bump `release` to generate a final release for the current
-   `major` / `minor` / `patch` version.
+5. Finally, bump `release` to generate a final release for the current `major` / `minor` / `patch` version.
 
         $ bumpversion release --tag
         git tag => v1.0.1
         CMake PROJECT_VERSION => 1.0.1
 
-
 ## Notes
 
 * Once the final release has been reached, it is not possible to bump
@@ -52,12 +49,10 @@ Start with an initial release, say `1.0.0`.
 
     bumpversion --new-version 12.1.0 release --no-commit --no-tag --allow-dirty
 
-# Reference
+## Reference
 
 To install bumpversion:
 
-    pip install --upgrade bump2version
-
-https://github.com/c4urself/bump2version#installation
-https://cmake.org/cmake/help/latest/variable/PROJECT_VERSION.html#variable:PROJECT_VERSION
+    pipx install bump2version
 
+[cmke PROJECT_VERSION](https://cmake.org/cmake/help/latest/variable/PROJECT_VERSION.html#variable:PROJECT_VERSION)

.markdownlint.yaml

@@ -0,0 +1,10 @@
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md033.md
+# Disable inline html linter is needed for <details> <summary>
+MD033: false
+
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
+# Conforms to .clang-format ColumnLimit
+# Update the comment in .clang-format if we no-longer tie these two column limits.
+MD013:
+  line_length: 119
+  code_blocks: false

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: trailing-whitespace
+        exclude: ^fmt\.(patch|diff)$
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+        exclude: ^\.clang-(format|tidy)$
+    -   id: check-added-large-files
+
+  # Clang-format for C++
+  # This brings in a portable version of clang-format.
+  # See also: https://github.com/ssciwr/clang-format-wheel
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v21.1.7
+    hooks:
+    - id: clang-format
+      types_or: [c++, c, json]
+
+  # CMake linting and formatting
+  - repo: https://github.com/BlankSpruce/gersemi
+    rev: 0.23.2
+    hooks:
+    - id: gersemi
+      name: CMake linting
+      exclude: ^.*/tests/.*/data/ # Exclude test data directories
+
+  # Markdown linting
+  # Config file: .markdownlint.yaml
+  # Commented out to disable this by default. Uncomment to enable markdown linting.
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.46.0
+    hooks:
+    - id: markdownlint
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: ["--write"]
+
+exclude: 'build/'

BUILDING.md

@@ -33,6 +33,13 @@ variable to provide them to CMake during configuration.
 CMake supports building on Apple Silicon properly since 3.20.1. Make sure you
 have the [latest version][1] installed.
 
+```sh
+CXX=c++ cmake -S . -B build -G Ninja -D CMAKE_CXX_SCAN_FOR_MODULES=NO -D CMAKE_BUILD_TYPE=Release -D FMT_DEVELOPER_MODE=YES --fresh
+ninja -C build all_verify_interface_header_sets
+ninja -C build build install
+ninja -C build build tests
+```
+
 ## Install
 
 This project doesn't require any special command-line flags to install to keep

CMakeLists.txt

@@ -3,23 +3,19 @@ cmake_minimum_required(VERSION 3.30...4.2)
 
 include(cmake/prelude.cmake)
 
-set(CMAKE_CXX_SCAN_FOR_MODULES ON)
+option(
+    CMAKE_CXX_SCAN_FOR_MODULES
+    "Whether to scan C++ source files for module dependencies"
+    ON
+)
+option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
 
 # Set experimental flag to enable `import std` support from CMake.
 # This must be enabled before C++ language support.
 if(CMAKE_CXX_SCAN_FOR_MODULES)
     set(CMAKE_EXPERIMENTAL_CXX_IMPORT_STD
         "d0edc3af-4c50-42ea-a356-e2862fe7a444"
     )
-    # if(APPLE AND $ENV{CXX} STREQUAL g++-15)
-    #     set(CMAKE_CXX_STDLIB_MODULES_JSON
-    #         $ENV{GCC_DIR}/lib/gcc/current/libstdc++.modules.json
-    #     )
-    # else()
-    #     set(CMAKE_CXX_STDLIB_MODULES_JSON
-    #         $ENV{LLVM_DIR}/lib/c++/libc++.modules.json
-    #     )
-    # endif()
 endif()
 
 #==================================================
@@ -39,16 +35,12 @@ set(CMAKE_CXX_EXTENSIONS ON)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 set(CMAKE_DEBUG_POSTFIX D)
-# to prevent -Winclude-angled-in-module-purview in fmt/os.h
-# see /Users/clausklein/.cache/CPM/fmt/297020319ba1d5d14e1599714def59a1788711c5/include/fmt/os.h:33
-set(CPPdefinitions FMT_USE_FCNTL=0)
-set(ADD_STDLIB_MODULES)
+set(CMAKE_SKIP_TEST_ALL_DEPENDENCY OFF)
 
-option(
-    FMT_SEPARATE_COMPILATION
-    "build fmt lib too"
-    ${CMAKE_CXX_SCAN_FOR_MODULES}
-)
+# FIXME: to prevent -Winclude-angled-in-module-purview in fmt/os.h
+# see /Users/clausklein/.cache/CPM/fmt/6226dc0d560c5dca8bcd81db09f7e2752ccb8cef/include/fmt/os.h:33
+set(CPPdefinitions FMT_USE_FCNTL=0)
+option(FMT_SEPARATE_COMPILATION "build fmt lib too" ${PROJECT_IS_TOP_LEVEL})
 option(
     FMT_USE_MODULES
     "Export a CXX_MODULE fmt if possible"
@@ -82,35 +74,6 @@ if(CMAKE_GENERATOR STREQUAL "Ninja" AND FMT_USE_MODULES)
         set(LLVM_DIR ${LLVM_DIR} CACHE PATH "")
         message(STATUS "LLVM_DIR=${LLVM_DIR}")
 
-        # if(LINUX AND EXISTS ${LLVM_LIBC_SOURCE}/std.cppm)
-        #     message(WARNING "LLVM_LIBC_SOURCE=${LLVM_LIBC_SOURCE}")
-        #     set(ADD_STDLIB_MODULES stdc++)
-        #     list(APPEND CMAKE_CXX_COMPILER_IMPORT_STD 23)
-        # endif()
-
-        # Build the stdlib module
-        function(add_stdlib_module NAME)
-            add_library(${NAME})
-            target_sources(
-                ${NAME}
-                PUBLIC
-                    FILE_SET CXX_MODULES
-                        BASE_DIRS ${LLVM_LIBC_SOURCE}
-                        FILES
-                            ${LLVM_LIBC_SOURCE}/std.cppm
-                            ${LLVM_LIBC_SOURCE}/std.compat.cppm
-            )
-            target_compile_features(${NAME} PUBLIC cxx_std_23)
-            target_compile_definitions(
-                ${NAME}
-                PUBLIC _LIBCPP_HAS_NO_LOCALIZATION
-            )
-            target_compile_options(
-                ${NAME}
-                PRIVATE -Wno-reserved-module-identifier
-            )
-        endfunction()
-
         add_compile_options(-fexperimental-library)
         add_link_options(-L${LLVM_DIR}/lib/c++ -lc++experimental)
         add_compile_options(-stdlib=libc++)
@@ -129,7 +92,7 @@ if(CMAKE_GENERATOR STREQUAL "Ninja" AND FMT_USE_MODULES)
         set(CMAKE_CXX_MODULE_STD ON)
     endif()
 
-    if(CMAKE_CXX_MODULE_STD OR ADD_STDLIB_MODULES)
+    if(CMAKE_CXX_MODULE_STD)
         list(APPEND CPPdefinitions FMT_IMPORT_STD)
     endif()
 
@@ -141,31 +104,27 @@ if(CMAKE_GENERATOR STREQUAL "Ninja" AND FMT_USE_MODULES)
     message(STATUS "CMAKE_CXX_MODULE_STD=${CMAKE_CXX_MODULE_STD}")
     message(STATUS "CPPdefinitions=${CPPdefinitions}")
 else()
-    set(CMAKE_VERIFY_INTERFACE_HEADER_SETS ${PROJECT_IS_TOP_LEVEL})
+    option(CMAKE_VERIFY_INTERFACE_HEADER_SETS "" ${PROJECT_IS_TOP_LEVEL})
 endif()
 
-#XXX if(MSVC)
-#XXX    include(cmake/example.cmake)
-#XXX endif()
-
 # ---- add dependency libraries ----
 
 include(cmake/CPM.cmake)
 
-# gersemi: off
 cpmaddpackage(
     NAME fmt
     GITHUB_REPOSITORY fmtlib/fmt
     GIT_TAG 12.1.0
     VERSION 12.1.0
     DOWNLOAD_ONLY ON
-    # XXX PATCH_COMMAND git apply -p 1 ${CMAKE_CURRENT_SOURCE_DIR}/fmt.patch
+    # NO! PATCH_COMMAND git apply -p 1 ${CMAKE_CURRENT_SOURCE_DIR}/fmt.patch
 )
-# gersemi: on
 
-# ---- Declare library ----
+# -----------------------------------------
+# ---- Collect the fmt library sources ----
+# -----------------------------------------
 
-# TODO: only if needed (compare) and possible!
+# TODO(CK): manually  apply the patch if needed (compare) and possible!
 if(
     EXISTS ${fmt_SOURCE_DIR}/src/fmt.cc
     AND NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/module/fmt.cppm
@@ -187,13 +146,29 @@ configure_file(
     ${CMAKE_CURRENT_SOURCE_DIR}/module/os.cc
     COPYONLY
 )
-file(GLOB_RECURSE _fmt_all_sources "module/*.cc")
 
-# fmt interface library
+file(
+    GLOB_RECURSE _fmt_all_sources
+    CONFIGURE_DEPENDS
+    RELATIVE ${CMAKE_CURRENT_LIST_DIR}
+    module/*.cc
+)
+
+# -----------------------------------------
+# -----------------------------------------
+
+#
+# build the fmt interface library
+#
 add_library(fmt-header-only INTERFACE)
 add_library(fmt::fmt-header-only ALIAS fmt-header-only)
 
-file(GLOB_RECURSE _fmt_public_header "${fmt_SOURCE_DIR}/include/fmt/*.h")
+file(
+    GLOB_RECURSE _fmt_public_header
+    CONFIGURE_DEPENDS
+    # NO! RELATIVE ${fmt_SOURCE_DIR}/include
+    ${fmt_SOURCE_DIR}/include/fmt/*.h
+)
 target_sources(
     fmt-header-only
     INTERFACE
@@ -211,10 +186,11 @@ target_compile_options(
     INTERFACE $<$<AND:$<COMPILE_LANGUAGE:CXX>,$<CXX_COMPILER_ID:MSVC>>:/utf-8>
 )
 
+#
+# build the fmt library
+#
 if(FMT_SEPARATE_COMPILATION)
-    # file(GLOB_RECURSE _fmt_all_sources "${fmt_SOURCE_DIR}/src/*.cc")
-
-    add_library(fmt STATIC)
+    add_library(fmt)
     target_sources(
         fmt
         PUBLIC
@@ -244,10 +220,10 @@ if(FMT_SEPARATE_COMPILATION)
         )
         target_compile_definitions(fmt PUBLIC ${CPPdefinitions})
     else()
-        message(FATAL_ERROR "FMT_USE_MODULES=${FMT_USE_MODULES}!")
+        message(WARNING "Missing or disabled support for CXX_MODULES!")
         add_library(fmt::fmt ALIAS fmt)
         target_compile_definitions(fmt PUBLIC ${CPPdefinitions})
-        target_sources(fmt PUBLIC ${_fmt_all_sources})
+        target_sources(fmt PRIVATE ${_fmt_all_sources})
     endif()
 
     if(FMT_WARNINGS_AS_ERRORS AND FMT_DEVELOPER_MODE AND UNIX)