Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SUMMARY: Build "Add CMake linting"
Purpose of change
As mentioned in #46818 this pull adds linting rules for CMake and the appropriate github action to run on changes to CMakeLists.txt files.
Describe the solution
Using this tool: https://github.com/cheshirekow/cmake_format
Albeit still being quite limited in linting capabilities (see cheshirekow/cmake_format#240 / cheshirekow/cmake_format#239), it's the best out there short of rolling our own parser.
What It can do well is:
What it lacks is:
The formatting part of the tool (cmake-format) supports everything required for a proper style, but the linter (cmake-lint) is still catching up, but issues are open, and the dev has acknowledged them in the tracker as well as documentation pertaining upcoming features.
Overview of all config options:
https://cmake-format.readthedocs.io/en/latest/configuration.html
Currently implemented and future linter rules:
https://cmake-format.readthedocs.io/en/latest/lint-summary.html
Describe alternatives you've considered
None
Testing
Ran the linter as github action and locally.
Additional context
None