Draft: Cmake lint

This merge request enables the use of pre-commit run --all-files for checking our CMake build system for inconsistencies. Pre-commit can be installed via: https://pre-commit.com/#install

Example output on a recent state of cdi:

cmake-format.............................................................Failed
- hook id: cmake-format
- files were modified by this hook
cmake-lint...............................................................Failed
- hook id: cmake-lint
- exit code: 1

app/CMakeLists.txt
==================

CMakeLists.txt
==============

cmake/FindNetCDF.cmake
======================
cmake/FindNetCDF.cmake:12,00: [C0111] Missing docstring on function or macro declaration
cmake/FindNetCDF.cmake:12,09: [C0103] Invalid function name "FindNetCDF_get_is_parallel_aware" doesn't match `[0-9a-z_]+`
cmake/FindNetCDF.cmake:25,08: [C0103] Invalid PARENT_SCOPE variable name "NetCDF_HAS_PARALLEL" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+|[a-z][a-z0-9_]+`
cmake/FindNetCDF.cmake:30,08: [C0103] Invalid PARENT_SCOPE variable name "NetCDF_HAS_PARALLEL" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+|[a-z][a-z0-9_]+`
cmake/FindNetCDF.cmake:41,06: [C0103] Invalid directory variable name "NetCDF_FOUND" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:42,06: [C0103] Invalid directory variable name "NetCDF_INCLUDE_DIRS" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:43,06: [C0103] Invalid directory variable name "NetCDF_LIBRARIES" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:44,06: [C0103] Invalid directory variable name "NetCDF_VERSION" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:82,08: [C0103] Invalid directory variable name "NetCDF_FOUND" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:83,08: [C0103] Invalid directory variable name "NetCDF_INCLUDE_DIRS" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:84,08: [C0103] Invalid directory variable name "NetCDF_LIBRARIES" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:85,08: [C0103] Invalid directory variable name "NetCDF_VERSION" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:158,06: [C0103] Invalid directory variable name "NetCDF_VERSION" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:178,06: [C0103] Invalid directory variable name "NetCDF_INCLUDE_DIRS" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`
cmake/FindNetCDF.cmake:179,06: [C0103] Invalid directory variable name "NetCDF_LIBRARIES" doesn't match `[A-Z][0-9A-Z_]+|_[0-9a-z_]+`

src/CMakeLists.txt
==================

Summary
=======
files scanned: 4
found lint:
  Convention: 15

tests/CMakeLists.txt
====================

Summary
=======
files scanned: 1
found lint:

requested review from @m214003

assigned to @m300433

@m300488 Is this ready to go or is there anything else that should be done?

marked this merge request as draft

@m300488 Are there additional tools that make our job easier where I can find more things that need to be changed before we go over the rest?

added 3 commits

• 883c27e5 - 1 commit from branch develop
• 0deca3dc - added cmake format config file
• 7025fdb6 - added pre-commit config file

Compare with previous version

Some (most) of the errors above do not make much sense. For example, NetCDF_FOUND seems fine. You have two options here:

1. Exclude cmake/FindNetCDF.cmake from the check (see pre-commit docs).
2. Override the regular expressions for variable names (e.g. here).

added 26 commits

• 7025fdb6...34bec0e7 - 24 commits from branch develop
• 0a7e6326 - added cmake format config file
• 8a0d96bd - added pre-commit config file

Compare with previous version