Merge pull request #102 from cpp-best-practices/lint-task [skip ci]

Author: aminya

.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

Taskfile.yml

@@ -13,21 +13,31 @@ 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
 
   clean: |
     {{if eq OS "windows"}} 

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")

src/DynamicProjectOptions.cmake

@@ -4,21 +4,21 @@
 #  * ENABLE_CLANG_TIDY: ON for Ninja/Makefiles
 #  * ENABLE_SANITIZER_UNDEFINED: ON for Compilers that support it
 #  * ENABLE_CPPCHECK: ON for Ninja/Makefiles
-
+#
 # For non-developer builds
 #  -DENABLE_DEVELOPER_MODE:BOOL=OFF
 # Is recommended
-
+#
 # In developer mode, all features have options that show up in the CMake GUI tools
-
+#
 # dynamic_project_options() macro enables all recommended defaults with appropriately
 # applied options from the GUI which are set
-
+#
 # Any default can be overridden
 # set(<feature_name>_DEFAULT <value>) - set default for both user and developer modes
 # set(<feature_name>_DEVELOPER_DEFAULT <value>) - set default for developer mode
 # set(<feature_name>_USER_DEFAULT <value>) - set default for user mode
-
+#
 macro(dynamic_project_options)
   option(ENABLE_DEVELOPER_MODE "Set up defaults for a developer of the project, and let developer change options" OFF)
   if(NOT ${ENABLE_DEVELOPER_MODE})

src/Linker.cmake

@@ -1,3 +1,6 @@
+# TODO use function arguments instead of CMake cache variables and options
+
+# Set the linker to use for the linking phase
 macro(configure_linker project_name)
   include(CheckCXXCompilerFlag)
 

src/PackageProject.cmake

@@ -1,5 +1,7 @@
 # Uses ycm (permissive BSD-3-Clause license) and ForwardArguments (permissive MIT license)
 
+# A function that packages the project for external usage (e.g. from vcpkg, Conan, etc).
+# See the [README.md] for more details
 function(package_project)
   cmake_policy(SET CMP0103 NEW) # disallow multiple calls with the same NAME
 

src/Standards.cmake

@@ -1,3 +1,4 @@
+# Set the default copmiler standards if not specified
 macro(set_standards)
 
   # if the default CMAKE_CXX_STANDARD is not set, detect the latest CXX standard supported by the compiler and use it.
@@ -21,7 +22,7 @@ macro(set_standards)
     set(CMAKE_CXX_STANDARD ${CXX_LATEST_STANDARD})
   endif()
 
-  if("{CMAKE_C_STANDARD}" STREQUAL "")
+  if("${CMAKE_C_STANDARD}" STREQUAL "")
     if(NOT
        ${ProjectOptions_ENABLE_CPPCHECK} # cppcheck doesn't support C17 https://sourceforge.net/p/cppcheck/discussion/general/thread/19ea152bba/
        AND DEFINED CMAKE_C17_STANDARD_COMPILE_OPTION

src/StaticAnalyzers.cmake

@@ -1,3 +1,4 @@
+# Enable static analysis with Cppcheck
 macro(enable_cppcheck CPPCHECK_OPTIONS)
   find_program(CPPCHECK cppcheck)
   if(CPPCHECK)
@@ -52,6 +53,7 @@ macro(enable_cppcheck CPPCHECK_OPTIONS)
   endif()
 endmacro()
 
+# Enable static analysis with clang-tidy
 macro(enable_clang_tidy)
   find_program(CLANGTIDY clang-tidy)
   if(CLANGTIDY)
@@ -115,6 +117,7 @@ macro(enable_clang_tidy)
   endif()
 endmacro()
 
+# Enable static analysis with include-what-you-use
 macro(enable_include_what_you_use)
   find_program(INCLUDE_WHAT_YOU_USE include-what-you-use)
   if(INCLUDE_WHAT_YOU_USE)

src/Tests.cmake

@@ -1,3 +1,4 @@
+# Enable coverage reporting for gcc/clang
 function(enable_coverage project_name)
   if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
     target_compile_options(${project_name} INTERFACE --coverage -O0 -g)