Merge branch 'main' into conan-quiet

Author: aminya

.cmake-format.yaml

@@ -10,126 +10,3 @@ markup:
   bullet_char: "*"
   enum_char: .
   enable_markup: false
-parse:
-  additional_commands:
-    project_options:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: project_options
-      kwargs:
-        CLANG_WARNINGS: 1
-        GCC_WARNINGS: 1
-        MSVC_WARNINGS: 1
-        CONAN_OPTIONS: +
-    catch_discover_tests:
-      pargs:
-        nargs: "*"
-        flags: []
-      kwargs:
-        OUTPUT_DIR: 1
-        OUTPUT_PREFIX: 1
-        OUTPUT_SUFFIX: 1
-        REPORTER: 1
-        TEST_PREFIX: 1
-    conan_add_remote:
-      pargs:
-        nargs: "*"
-        flags: []
-      kwargs:
-        INDEX: 1
-        NAME: 1
-        URL: 1
-    conan_cmake_install:
-      pargs:
-        nargs: "*"
-        flags: []
-      kwargs:
-        BUILD: +
-        INSTALL_FOLDER: 1
-        LOCKFILE: 1
-        LOCKFILE_NODE_ID: 1
-        LOCKFILE_OUT: 1
-        PATH_OR_REFERENCE: 1
-        REFERENCE: 1
-        REMOTE: 1
-        ENV: +
-        ENV_BUILD: +
-        ENV_HOST: +
-        GENERATOR: +
-        OPTIONS: +
-        OPTIONS_BUILD: +
-        OPTIONS_HOST: +
-        PROFILE: +
-        PROFILE_BUILD: +
-        PROFILE_HOST: +
-        SETTINGS: +
-        SETTINGS_BUILD: +
-        SETTINGS_HOST: +
-    cpmaddpackage:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: CPMAddPackage
-      kwargs: &id001
-        DOWNLOAD_COMMAND: 1
-        DOWNLOAD_NAME: 1
-        DOWNLOAD_NO_EXTRACT: 1
-        DOWNLOAD_ONLY: 1
-        FIND_PACKAGE_ARGUMENTS: 1
-        FORCE: 1
-        GITHUB_REPOSITORY: 1
-        GITLAB_REPOSITORY: 1
-        GIT_REPOSITORY: 1
-        GIT_SHALLOW: 1
-        GIT_TAG: 1
-        HTTP_PASSWORD: 1
-        HTTP_USERNAME: 1
-        NAME: 1
-        NO_CACHE: 1
-        SOURCE_DIR: 1
-        SVN_REPOSITORY: 1
-        SVN_REVISION: 1
-        URL: 1
-        URL_HASH: 1
-        URL_MD5: 1
-        VERSION: 1
-        OPTIONS: +
-    cpmfindpackage:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: CPMFindPackage
-      kwargs: *id001
-    cpmdeclarepackage:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: CPMDeclarePackage
-      kwargs: *id001
-    packageproject:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: packageProject
-      kwargs:
-        BINARY_DIR: 1
-        COMPATIBILITY: 1
-        DISABLE_VERSION_SUFFIX: 1
-        EXPORT_HEADER: 1
-        INCLUDE_DESTINATION: 1
-        INCLUDE_DIR: 1
-        NAME: 1
-        NAMESPACE: 1
-        VERSION: 1
-        VERSION_HEADER: 1
-        DEPENDENCIES: +
-    cpmusepackagelock:
-      pargs: 1
-      spelling: CPMUsePackageLock
-    cpmregisterpackage:
-      pargs: 1
-      spelling: CPMRegisterPackage
-    cpmgetpackageversion:
-      pargs: 2
-      spelling: CPMGetPackageVersion

.github/workflows/ci.yml

@@ -60,4 +60,12 @@ jobs:
         run: |
           task test
           task test_release
-          task test_install
+          task test_install
+
+      - name: Lint
+        if: ${{ matrix.os == 'ubuntu-20.04' && matrix.compiler == 'gcc' }}
+        run: |
+          # TODO add to setup-cpp
+          python3 -m pip install --user cmakelint cmake-format
+
+          task lint

README.md

@@ -15,11 +15,11 @@ cmake_minimum_required(VERSION 3.16)
 # If commented, the latest supported standard for your compiler is automatically set.
 # set(CMAKE_CXX_STANDARD 20)
 
-# Add project_options v0.18.1
+# Add project_options v0.19.0
 # https://github.com/cpp-best-practices/project_options
 # Change the version in the following URL to update the package (watch the releases of the repository for future updates)
 include(FetchContent)
-FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.18.1.zip)
+FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.19.0.zip)
 FetchContent_MakeAvailable(_project_options)
 include(${_project_options_SOURCE_DIR}/Index.cmake)
 
@@ -283,11 +283,11 @@ cmake_minimum_required(VERSION 3.16)
 # If commented, the latest supported standard for your compiler is automatically set.
 # set(CMAKE_CXX_STANDARD 20)
 
-# Add project_options v0.18.1
+# Add project_options v0.19.0
 # https://github.com/cpp-best-practices/project_options
 # Change the version in the following URL to update the package (watch the releases of the repository for future updates)
 include(FetchContent)
-FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.18.1.zip)
+FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.19.0.zip)
 FetchContent_MakeAvailable(_project_options)
 include(${_project_options_SOURCE_DIR}/Index.cmake)
 

Taskfile.yml

@@ -13,21 +13,32 @@ tasks:
     - cd ./test/build && ctest -C Release --verbose
 
   test_install:
-      cmds:
+    cmds:
       - task: test_release
       - cmake --install ./test/build --config Release --prefix ./install
       - cmake ./test_install -B ./test_install/build -DCMAKE_BUILD_TYPE:STRING=Release -G "Ninja Multi-Config" -DCMAKE_PREFIX_PATH:STRING={{.CWD}}/install;
       - cmake --build ./test_install/build --config Release
       - cd ./test_install/build && ctest -C Release --verbose
-      vars:
-        CWD:
-          sh: git rev-parse --show-toplevel
+    vars:
+      CWD:
+        sh: git rev-parse --show-toplevel
 
-  format:
-    - clang-format -i ./test/src/*/*.cpp ./test/include/*/*.hpp ./test_install/*.cpp
-    - cmake-format --in-place ./Index.cmake ./src/*.cmake ./test/CMakeLists.txt ./test_install/CMakeLists.txt
+  lint:
+    - |
+      {{if eq OS "windows"}} 
+        powershell -c '$files=(git ls-files --exclude-standard); foreach ($file in $files) { if ((get-item $file).Extension -in ".cpp", ".hpp", ".c", ".cc", ".cxx", ".hxx", ".ixx") { clang-format -i -style=file $file } }' 
+      {{else}} 
+        git ls-files --exclude-standard | grep -E '\.(cpp|hpp|c|cc|cxx|hxx|ixx)$' | xargs clang-format -i -style=file 
+      {{end}}
+    - |
+      {{if eq OS "windows"}} 
+      powershell -c '$files=(git ls-files --exclude-standard); foreach ($file in $files) { $item=(get-item $file); if (($item.Name -eq "CMakeLists.txt") -or ($item.Extension -in ".cmake")) { cmake-format --in-place $file; cmake-lint $file --disabled-codes C0103 C0301 R0912 R0915 R0913 --suppress-decorations } }'
+      {{else}}
+        git ls-files --exclude-standard | grep -E '(CMakeLists\.txt)|(\.(cmake))$' | xargs cmake-format --in-place | xargs cmake-lint --disabled-codes C0103 C0301 R0912 R0915 R0913 --suppress-decorations
+      {{end}}
 
-  lint: cmake-lint ./Index.cmake ./src/*.cmake
+    - ~/vcpkg/vcpkg format-manifest ./test/vcpkg.json ./test_install/vcpkg.json
+    - npx -y cspell lint --no-progress --show-suggestions
 
   clean: |
     {{if eq OS "windows"}} 

cspell.config.yaml

@@ -0,0 +1,103 @@
+version: "0.2"
+files:
+  - "**/*"
+ignorePaths:
+  - pnpm-lock.yaml
+  - .git/
+  - dist/
+useGitignore: true
+language: en, en-GB
+allowCompoundWords: true
+enableGlobDot: true
+words:
+  - aarch
+  - aminya
+  - anotherproj
+  - applellvm
+  - ARGN
+  - asan
+  - buildtools
+  - ccache
+  - ccmake
+  - choco
+  - cmake
+  - cmakelint
+  - cmds
+  - cond
+  - CPATH
+  - Cppcheck
+  - cppcoreguidelines
+  - CPPFLAGS
+  - cpprc
+  - ctest
+  - Cuda
+  - DCMAKE
+  - deps
+  - DOPT
+  - dyld
+  - dylib
+  - Eigen
+  - fargs
+  - fcolor
+  - fdiagnostics
+  - ftime
+  - gcovr
+  - Graphviz
+  - hwrap
+  - kcov
+  - LDFLAGS
+  - libc
+  - libcuda
+  - libstdc
+  - LPSTR
+  - LPWSTR
+  - mdfile
+  - msbuild
+  - msvc
+  - msys
+  - multilib
+  - mylib
+  - myprogram
+  - myproj
+  - myproject
+  - nothrow
+  - nvcc
+  - Opencppcoverage
+  - pargs
+  - pnpm
+  - pwsh
+  - rmrf
+  - rpath
+  - sccache
+  - setx
+  - shlib
+  - suppr
+  - TOLOWER
+  - ubsan
+  - vcpkg
+  - vcvarsall
+  - visualc
+  - visualcpp
+  - VSCMD
+  - VSINSTALLDIR
+  - vsversion
+  - Wcast
+  - Wconversion
+  - Wdouble
+  - Wduplicated
+  - Werror
+  - Weverything
+  - Wextra
+  - Wformat
+  - Wlogical
+  - Wmisleading
+  - Wnon
+  - Wnull
+  - Woverloaded
+  - Wpedantic
+  - Wshadow
+  - Wsign
+  - Wunused
+  - Wuseless
+  - xcrun
+  - Yahyaabadi

src/CompilerWarnings.cmake

@@ -1,7 +1,7 @@
-# from here:
+# Set the compiler warnings
 #
+# https://clang.llvm.org/docs/DiagnosticsReference.html
 # https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md
-
 function(
   set_project_warnings
   project_name

src/Conan.cmake

@@ -1,3 +1,4 @@
+# Run Conan for dependency management
 macro(run_conan)
   # Download automatically, you can also just copy the conan.cmake file
   if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")
@@ -18,10 +19,17 @@ macro(run_conan)
   # Add (or remove) remotes as needed
   # conan_add_remote(NAME conan-center URL https://conan.bintray.com)
   conan_add_remote(
-    NAME cci
-    URL https://center.conan.io
-    INDEX 0)
-  conan_add_remote(NAME bincrafters URL https://bincrafters.jfrog.io/artifactory/api/conan/public-conan)
+    NAME
+    cci
+    URL
+    https://center.conan.io
+    INDEX
+    0)
+  conan_add_remote(
+    NAME
+    bincrafters
+    URL
+    https://bincrafters.jfrog.io/artifactory/api/conan/public-conan)
 
   # For multi configuration generators, like VS and XCode
   if(NOT CMAKE_CONFIGURATION_TYPES)
@@ -49,13 +57,20 @@ macro(run_conan)
     # the external "conanfile.py" provided with the project
     # Alternatively a conanfile.txt could be used
     conan_cmake_install(
-      PATH_OR_REFERENCE ${CMAKE_SOURCE_DIR}
-      BUILD missing
+      PATH_OR_REFERENCE
+      ${CMAKE_SOURCE_DIR}
+      BUILD
+      missing
       # Pass compile-time configured options into conan
-      OPTIONS ${ProjectOptions_CONAN_OPTIONS}
+      OPTIONS
+      ${ProjectOptions_CONAN_OPTIONS}
       # Pass CMake compilers to Conan
-      ENV "CC=${CMAKE_C_COMPILER}" "CXX=${CMAKE_CXX_COMPILER}"
-      SETTINGS ${settings} ${OUTPUT_QUIET})
+      ENV
+      "CC=${CMAKE_C_COMPILER}"
+      "CXX=${CMAKE_CXX_COMPILER}"
+      SETTINGS
+      ${settings}
+      ${OUTPUT_QUIET})
   endforeach()
 
 endmacro()

src/Doxygen.cmake

@@ -29,9 +29,9 @@ function(enable_doxygen DOXYGEN_THEME)
 
   if("${DOXYGEN_THEME}" STREQUAL "awesome" OR "${DOXYGEN_THEME}" STREQUAL "awesome-sidebar")
     # use a modern doxygen theme
-    # https://github.com/jothepro/doxygen-awesome-css v1.6.1
+    # https://github.com/jothepro/doxygen-awesome-css v2.0.2
     FetchContent_Declare(_doxygen_theme
-                         URL https://github.com/jothepro/doxygen-awesome-css/archive/refs/tags/v1.6.1.zip)
+                         URL https://github.com/jothepro/doxygen-awesome-css/archive/refs/tags/v2.0.2.zip)
     FetchContent_MakeAvailable(_doxygen_theme)
     if("${DOXYGEN_THEME}" STREQUAL "awesome" OR "${DOXYGEN_THEME}" STREQUAL "awesome-sidebar")
       set(DOXYGEN_HTML_EXTRA_STYLESHEET "${_doxygen_theme_SOURCE_DIR}/doxygen-awesome.css")