[ci] Run 'cmakelint' in CI

[jameslamb]

Summary

LightGBM's continuous integration (CI) should use cmakelint to enforce consistency in the formatting of CMakeLists.txt.

Motivation

Following this tool's recommendations should make CMakeLists.txt a bit easier to read and maintain, by enforcing consistency in formatting.

You can run cmakelint --filter to see a list of the supported checks.

convention/filename
linelength
package/consistency
readability/logic
readability/mixedcase
readability/wonkycase
syntax
whitespace/eol
whitespace/extra
whitespace/indent
whitespace/mismatch
whitespace/newline
whitespace/tabs

Description

Similar to the approach taken in LightGBM with cpplint (#1990) and mypy (#3867), for a time these checks might be run in continuous integration without blocking merges, just as extra information about the state of the code.

How to Contribute

To contribute to this issue, run the following commands

pip install --upgrade cmakelint
cmakelint --linelength=120

Make a pull request that addresses some of the warnings. In the pull request description, list the specific warnings your changes address.

Small, focused pull requests are appreciate. Do not try to fix all of the warnings in a single PR.

References

• https://github.com/cmake-lint/cmake-lint
• this issue was created from the discussion in prefer spaces to tabs in CMakeLists.txt #4593
• those interested in improving static analysis of C/C++ code in the project might also explore [ci] warnings from cppcheck #4539

[github-actions]

This issue has been automatically locked since there has not been any recent activity since it was closed.
To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues
including a reference to this.