CI: Use cmake-lint

Author: jayvdb

.cmake-format.yaml

@@ -0,0 +1,63 @@
+parse: {}
+format:
+  line_width: 227
+  tab_size: 2
+  use_tabchars: false
+  fractional_tab_policy: use-space
+  max_subgroups_hwrap: 2
+  max_pargs_hwrap: 6
+  max_rows_cmdline: 2
+  separate_ctrl_name_with_space: false
+  separate_fn_name_with_space: false
+  dangle_parens: false
+  dangle_align: prefix
+  min_prefix_chars: 4
+  max_prefix_chars: 10
+  max_lines_hwrap: 2
+  line_ending: unix
+  command_case: canonical
+  keyword_case: unchanged
+  always_wrap: []
+  enable_sort: true
+  autosort: false
+  require_valid_layout: false
+  layout_passes: {}
+markup:
+  bullet_char: '*'
+  enum_char: .
+  first_comment_is_literal: false
+  literal_comment_pattern: null
+  fence_pattern: ^\s*([`~]{3}[`~]*)(.*)$
+  ruler_pattern: ^\s*[^\w\s]{3}.*[^\w\s]{3}$
+  explicit_trailing_pattern: '#<'
+  hashruler_min_length: 10
+  canonicalize_hashrulers: true
+  enable_markup: true
+lint:
+  disabled_codes:
+    - C0103  # Invalid argument name
+    - C0113  # Missing COMMENT in statement which allows it
+    - C0111  # Missing docstring on function or macro declaration
+  function_pattern: '[0-9a-z_]+'
+  macro_pattern: '[0-9A-Z_]+'
+  global_var_pattern: '[A-Z][0-9A-Z_]+'
+  internal_var_pattern: _[A-Z][0-9A-Z_]+
+  local_var_pattern: '[a-z][a-z0-9_]+'
+  private_var_pattern: _[0-9a-z_]+
+  public_var_pattern: '[A-Z][0-9A-Z_]+'
+  argument_var_pattern: '[a-z][a-z0-9_]+'
+  keyword_pattern: '[A-Z][0-9A-Z_]+'
+  max_conditionals_custom_parser: 2
+  min_statement_spacing: 1
+  max_statement_spacing: 2
+  max_returns: 6
+  max_branches: 30  # Default target: 12
+  max_arguments: 6  # Default target: 5
+  max_localvars: 15
+  max_statements: 103  # Default target: 50
+encode:
+  emit_byteorder_mark: false
+  input_encoding: utf-8
+  output_encoding: utf-8
+misc:
+  per_command: {}

.github/workflows/lint.yaml

@@ -9,14 +9,18 @@ on:
   pull_request:
 jobs:
   lint:
-    name: Test
+    name: Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Setup
-        run: pip install trim
+        run: pip install trim cmakelang
 
       - name: Check whitespace
         run: |
           trim *.cmake
           git diff --exit-code
+
+      - name: Lint cmake files
+        run: |
+          cmake-lint *.cmake

ClangFormat.cmake

@@ -98,11 +98,11 @@ function(create_clang_format_targets)
   add_custom_target(clang-format-all-${PROJECT_NAME}
       COMMAND ${x_ALL_COMMAND}
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-      )
+  )
   add_custom_target(clang-format-diff-${PROJECT_NAME}
       COMMAND ${x_DIFF_COMMAND}
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-      )
+  )
 
   # Top level projects will create the targets clang-format-all and
   # clang-format-diff with the same commands as the namespaced targets
@@ -112,21 +112,21 @@ function(create_clang_format_targets)
     add_custom_target(clang-format-all
         COMMAND ${x_ALL_COMMAND}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
     add_custom_target(clang-format-diff
         COMMAND ${x_DIFF_COMMAND}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
     add_custom_target(clang-format-all-check
         COMMAND git diff --exit-code
         DEPENDS clang-format-all
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
     add_custom_target(clang-format-diff-check
         COMMAND git diff --exit-code
         DEPENDS clang-format-diff
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
   endif()
 endfunction()
 
@@ -184,7 +184,7 @@ function(swift_setup_clang_format)
           TOP_LEVEL ${top_level_project}
           ALL_COMMAND ${x_SCRIPT} all
           DIFF_COMMAND ${x_SCRIPT} diff
-          )
+      )
     else()
       message(FATAL_ERROR "Specified clang-format script ${x_SCRIPT} doesn't exist")
     endif()
@@ -202,7 +202,7 @@ function(swift_setup_clang_format)
           TOP_LEVEL ${top_level_project}
           ALL_COMMAND ${script} all
           DIFF_COMMAND ${script} diff
-          )
+      )
       return()
     endif()
   endforeach()
@@ -221,7 +221,7 @@ function(swift_setup_clang_format)
         clang-format35 clang-format-3.5
         clang-format34 clang-format-3.4
         clang-format
-       )
+    )
   endif()
   find_program(CLANG_FORMAT NAMES ${x_CLANG_FORMAT_NAMES})
 

ClangTidy.cmake

@@ -107,12 +107,12 @@ function(create_clang_tidy_targets)
       clang-tidy-all-${PROJECT_NAME}
       COMMAND ${x_ALL_COMMAND}
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-      )
+  )
   add_custom_target(
       clang-tidy-diff-${PROJECT_NAME}
       COMMAND ${x_DIFF_COMMAND}
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-      )
+  )
 
   # Top level projects will create the targets clang-tidy-all and
   # clang-tidy-diff with the same commands as the namespaced targets
@@ -123,22 +123,22 @@ function(create_clang_tidy_targets)
         clang-tidy-all
         COMMAND ${x_ALL_COMMAND}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
     add_custom_target(
         clang-tidy-diff
         COMMAND ${x_DIFF_COMMAND}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
     add_custom_target(clang-tidy-all-check
         COMMAND test ! -f fixes.yaml
         DEPENDS clang-tidy-all
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
     add_custom_target(clang-tidy-diff-check
         COMMAND test ! -f fixes.yaml
         DEPENDS clang-tidy-diff
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        )
+    )
   endif()
 endfunction()
 
@@ -234,7 +234,7 @@ function(swift_setup_clang_tidy)
           TOP_LEVEL ${top_level_project}
           ALL_COMMAND ${x_SCRIPT} all
           DIFF_COMMAND ${x_SCRIPT} diff
-          )
+      )
       return()
     endif()
     message(FATAL_ERROR "Specified clang-tidy script ${x_SCRIPT} doesn't exist")
@@ -250,7 +250,7 @@ function(swift_setup_clang_tidy)
           TOP_LEVEL ${top_level_project}
           ALL_COMMAND ${script} all
           DIFF_COMMAND ${script} diff
-          )
+      )
       return()
     endif()
   endforeach()
@@ -269,7 +269,7 @@ function(swift_setup_clang_tidy)
         clang-tidy35 clang-tidy-3.5
         clang-tidy34 clang-tidy-3.4
         clang-tidy
-       )
+    )
   endif()
   find_program(CLANG_TIDY NAMES ${x_CLANG_TIDY_NAMES})
 
@@ -303,6 +303,6 @@ function(swift_setup_clang_tidy)
         git diff --diff-filter=ACMRTUXB --quiet --name-only master -- ${srcs} ||
         ${${PROJECT_NAME}_CLANG_TIDY} ${x_EXTRA_ARGS} -p ${CMAKE_BINARY_DIR} --export-fixes=${CMAKE_CURRENT_SOURCE_DIR}/fixes.yaml
           `git diff --diff-filter=ACMRTUXB --name-only master -- ${srcs}`
-        )
+    )
   endif()
 endfunction()

CodeCoverage.cmake

@@ -93,10 +93,10 @@ option(
 
 # Programs
 if (NOT LLVM_COV_PATH)
-    if (NOT LLVM_COV_NAME)
-        set(LLVM_COV_NAME llvm-cov)
-    endif()
-    find_program(LLVM_COV_PATH ${LLVM_COV_NAME})
+  if (NOT LLVM_COV_NAME)
+    set(LLVM_COV_NAME llvm-cov)
+  endif()
+  find_program(LLVM_COV_PATH ${LLVM_COV_NAME})
 endif()
 find_program(GCOV_PATH gcov)
 find_program(LCOV_PATH lcov)
@@ -134,8 +134,8 @@ if(CODE_COVERAGE AND NOT CODE_COVERAGE_ADDED)
       if(LLVM_COV_VERSION VERSION_LESS "7.0.0")
         message(
           WARNING
-            "target_code_coverage()/add_code_coverage_all_targets() 'EXCLUDE' option only available on llvm-cov >= 7.0.0"
-          )
+          "target_code_coverage()/add_code_coverage_all_targets() 'EXCLUDE' option only available on llvm-cov >= 7.0.0"
+        )
       endif()
     endif()
 
@@ -156,14 +156,14 @@ if(CODE_COVERAGE AND NOT CODE_COVERAGE_ADDED)
       if(NOT ${upper_build_type} STREQUAL "DEBUG")
         message(
           WARNING
-            "Code coverage results with an optimized (non-Debug) build may be misleading"
-          )
+          "Code coverage results with an optimized (non-Debug) build may be misleading"
+        )
       endif()
     else()
       message(
         WARNING
-          "Code coverage results with an optimized (non-Debug) build may be misleading"
-        )
+        "Code coverage results with an optimized (non-Debug) build may be misleading"
+      )
     endif()
     if(NOT LCOV_PATH)
       message(FATAL_ERROR "lcov not found! Aborting...")
@@ -336,7 +336,7 @@ function(target_code_coverage TARGET_NAME)
         COMMAND ;
         COMMENT
           "Open ${CMAKE_COVERAGE_OUTPUT_DIRECTORY}/${TARGET_NAME}/index.html in your browser to view the coverage report."
-        )
+      )
 
       # AUTO
       if(target_code_coverage_AUTO)
@@ -359,8 +359,8 @@ function(target_code_coverage TARGET_NAME)
         if(NOT TARGET ccov-all-processing)
           message(
             FATAL_ERROR
-              "Calling target_code_coverage with 'ALL' must be after a call to 'add_code_coverage_all_targets'."
-            )
+            "Calling target_code_coverage with 'ALL' must be after a call to 'add_code_coverage_all_targets'."
+          )
         endif()
 
         add_dependencies(ccov-all-processing ccov-run-${TARGET_NAME})
@@ -403,13 +403,13 @@ function(add_code_coverage_all_targets)
                         ${ARGN})
 
   if(${PROJECT_NAME} STREQUAL ${CMAKE_PROJECT_NAME})
-      # This is the top level project, ie the CMakeLists.txt which cmake was run
-      # on directly, not a submodule/subproject. We can do some special things now.
-      # The option to enable code coverage will be enabled by default only for
-      # top level projects.
-      set(TOP_LEVEL_PROJECT ON)
+    # This is the top level project, ie the CMakeLists.txt which cmake was run
+    # on directly, not a submodule/subproject. We can do some special things now.
+    # The option to enable code coverage will be enabled by default only for
+    # top level projects.
+    set(TOP_LEVEL_PROJECT ON)
   else()
-      set(TOP_LEVEL_PROJECT OFF)
+    set(TOP_LEVEL_PROJECT OFF)
   endif()
 
   if(CODE_COVERAGE AND TOP_LEVEL_PROJECT)
@@ -501,6 +501,6 @@ function(add_code_coverage_all_targets)
       COMMAND ;
       COMMENT
         "Open ${CMAKE_COVERAGE_OUTPUT_DIRECTORY}/all-merged/index.html in your browser to view the coverage report."
-      )
+    )
   endif()
 endfunction()