cmake: replace `cmakelint` with `cmake-lint` from `cmakelang`, fix issues by vszakats · Pull Request #17576 · curl/curl

vszakats · 2025-06-10T18:33:03Z

This linter detects formatting and naming issues with minimal amount of
noise. It seems to be an improvement over the existing linter which was
only detecting line width overruns.

Also: fix to exclude CurlTests.c from linter.

Ref: https://cmake-format.readthedocs.io/en/latest/cmake-lint.html
Ref: https://github.com/cheshirekow/cmake_format

TODO:

convert .cmake-lint.yaml to command-line options.
I could not make work passing -c <config> to the tool.
rebase on cmake: drop never propagated C macros #17580.

Delete macros from `curl_config.h.cmake` that were never set by the CMake script: `_LARGE_FILES`, `_THREAD_SAFE`, `const`, `size_t`. Also: - lib/config-riscos.h: drop `#undef _LARGE_FILES`. This is an IBM-specific macro, no need to unset it on other platforms. Cherry-picked from #17576 Closes #17580

`` CMakeLists.txt:2034,35: [W0106] String looks like a variable reference missing an open tag '{PROJECT_SOURCE_DIR' CMakeLists.txt:2035,35: [W0106] String looks like a variable reference missing an open tag '{PROJECT_BINARY_DIR' ```

…ith naming rules

``` CMake/PickyWarnings.cmake:343,08: [C0103] Invalid directory variable name ""${_wlist}"" doesn't match `([A-Z][0-9A-Z_]+|[A-Z][A-Za-z0-9]+_FOUND|[a-z]+_SOURCES)|_[0-9a-z_]+` ```

The warning seems dubious, because `_GSS_VERSION` is defined by `pkg_search_module()`, but either I'm misunderstanding something, or cmake-lint is not recognizing this. ``` CMake/FindGSS.cmake:145,10: [C0103] Invalid directory variable name "_GSS_VERSION" doesn't match `([A-Z][0-9A-Z_]+|[A-Z][A-Za-z0-9]+_FOUND|[a-z]+_SOURCES)|_[0-9a-z_]+` CMake/FindGSS.cmake:273,10: [C0103] Invalid directory variable name "_GSS_VERSION" doesn't match `([A-Z][0-9A-Z_]+|[A-Z][A-Za-z0-9]+_FOUND|[a-z]+_SOURCES)|_[0-9a-z_]+` CMake/FindGSS.cmake:279,10: [C0103] Invalid directory variable name "_GSS_VERSION" doesn't match `([A-Z][0-9A-Z_]+|[A-Z][A-Za-z0-9]+_FOUND|[a-z]+_SOURCES)|_[0-9a-z_]+` CMake/FindGSS.cmake:285,10: [C0103] Invalid directory variable name "_GSS_VERSION" doesn't match `([A-Z][0-9A-Z_]+|[A-Z][A-Za-z0-9]+_FOUND|[a-z]+_SOURCES)|_[0-9a-z_]+` ```

This reverts commit ee0ecaa.

…ith naming rules fixup

Fixing: ``` docs/CMakeLists.txt:35,23: [C0113] Missing COMMENT in statement which allows it docs/CMakeLists.txt:41,22: [C0113] Missing COMMENT in statement which allows it docs/cmdline-opts/CMakeLists.txt:28,19: [C0113] Missing COMMENT in statement which allows it docs/cmdline-opts/CMakeLists.txt:36,18: [C0113] Missing COMMENT in statement which allows it docs/examples/CMakeLists.txt:25,18: [C0113] Missing COMMENT in statement which allows it docs/libcurl/CMakeLists.txt:43,25: [C0113] Missing COMMENT in statement which allows it docs/libcurl/CMakeLists.txt:67,19: [C0113] Missing COMMENT in statement which allows it docs/libcurl/CMakeLists.txt:79,18: [C0113] Missing COMMENT in statement which allows it docs/libcurl/opts/CMakeLists.txt:29,18: [C0113] Missing COMMENT in statement which allows it scripts/CMakeLists.txt:33,25: [C0113] Missing COMMENT in statement which allows it scripts/CMakeLists.txt:39,24: [C0113] Missing COMMENT in statement which allows it scripts/CMakeLists.txt:44,25: [C0113] Missing COMMENT in statement which allows it scripts/CMakeLists.txt:50,24: [C0113] Missing COMMENT in statement which allows it src/CMakeLists.txt:34,04: [C0113] Missing COMMENT in statement which allows it src/CMakeLists.txt:58,06: [C0113] Missing COMMENT in statement which allows it tests/CMakeLists.txt:32,18: [C0113] Missing COMMENT in statement which allows it tests/CMakeLists.txt:62,20: [C0113] Missing COMMENT in statement which allows it tests/CMakeLists.txt:79,20: [C0113] Missing COMMENT in statement which allows it tests/certs/CMakeLists.txt:28,19: [C0113] Missing COMMENT in statement which allows it tests/certs/CMakeLists.txt:33,18: [C0113] Missing COMMENT in statement which allows it tests/certs/CMakeLists.txt:36,18: [C0113] Missing COMMENT in statement which allows it tests/http/clients/CMakeLists.txt:25,18: [C0113] Missing COMMENT in statement which allows it tests/libtest/CMakeLists.txt:31,02: [C0113] Missing COMMENT in statement which allows it tests/libtest/CMakeLists.txt:40,04: [C0113] Missing COMMENT in statement which allows it tests/server/CMakeLists.txt:35,04: [C0113] Missing COMMENT in statement which allows it tests/tunit/CMakeLists.txt:31,04: [C0113] Missing COMMENT in statement which allows it tests/unit/CMakeLists.txt:31,04: [C0113] Missing COMMENT in statement which allows it ``` In most cases it seems to make little sense to add these. ``` # A custom command with one output doesn't really need a comment because # the default "generating XXX" is a good message already. ``` Also disabled in the tool itself: https://github.com/cheshirekow/cmake_format/blob/master/.cmake-format.py

Better this way because disable= directives apply to the whole file, not just the following line (or lines?)

It's a `#cmakedefine VAR ${VAR}` case where the two VARs must be the same string to work as expected.

Sadly this requires passing `--config-files` after the input files, which needs a xargs hack, which invokes the tool for each file, making it significantly slower.

Delete macros from `curl_config.h.cmake` that were never set by the CMake script: `_LARGE_FILES`, `_THREAD_SAFE`, `const`, `size_t`. Also: - lib/config-riscos.h: drop `#undef _LARGE_FILES`. This is an IBM-specific macro, no need to unset it on other platforms. Cherry-picked from curl#17576 Closes curl#17580

…sues This linter detects formatting and naming issues with minimal amount of noise. It seems to be an improvement over the existing linter which was only detecting line width overruns. Also: fix to exclude `CurlTests.c` from linter. Ref: https://cmake-format.readthedocs.io/en/latest/cmake-lint.html Ref: https://github.com/cheshirekow/cmake_format Closes curl#17576

To avoid it applying to all the rest of the script. Follow-up to b761eb5 #17576 Closes #19172

vszakats added the cmake label Jun 10, 2025

github-actions bot added tests CI Continuous Integration labels Jun 10, 2025

vszakats marked this pull request as draft June 10, 2025 18:35

vszakats changed the title ~~cmake: replace cmakelint with cmake-lint from cmakelang~~ cmake: replace cmakelint with cmake-lint from cmakelang, fix warnings Jun 10, 2025

vszakats changed the title ~~cmake: replace cmakelint with cmake-lint from cmakelang, fix warnings~~ cmake: replace cmakelint with cmake-lint from cmakelang, fix warnings Jun 10, 2025

This comment was marked as outdated.

Sign in to view

vszakats marked this pull request as ready for review June 10, 2025 20:53

vszakats changed the title ~~cmake: replace cmakelint with cmake-lint from cmakelang, fix warnings~~ cmake: replace cmakelint with cmake-lint from cmakelang, fix issues Jun 10, 2025

vszakats mentioned this pull request Jun 11, 2025

cmake: drop never propagated C macros #17580

Closed

vszakats added 19 commits June 11, 2025 06:33

fix indentation

29295b9

sync casing with same message in autotools

ec9cc75

silence two false-positive warnings

61a8d50

`` CMakeLists.txt:2034,35: [W0106] String looks like a variable reference missing an open tag '{PROJECT_SOURCE_DIR' CMakeLists.txt:2035,35: [W0106] String looks like a variable reference missing an open tag '{PROJECT_BINARY_DIR' ```

silence warnings for local name exceptions

8441acc

add COMMENT to a COMMAND

d577b11

uppercase a variable used in curl_config.h.cmake

dc61e21

rename cmake-level _FILE_OFFSET_BITS to FILE_OFFSET_BITS to conform w…

105f17a

…ith naming rules

fix indentation

76a693c

cmakelint.sh: exclude CurlTests.c

bb7a95e

fix too short variable name

872e414

FindLibgsasl.cmake: fix indentation

de607d4

fix too short variable name

7fd6f2a

add missing descriptions to macros

1eb3cd2

fix cmake-lint "bad indentation"

241ffd4

silence bogus warning

3f41b04

``` CMake/PickyWarnings.cmake:343,08: [C0103] Invalid directory variable name ""${_wlist}"" doesn't match `([A-Z][0-9A-Z_]+|[A-Z][A-Za-z0-9]+_FOUND|[a-z]+_SOURCES)|_[0-9a-z_]+` ```

omit function used just once

9955d2f

add comments describing local functions

7ba3b59

make local variable name compliant

2f9e4c6

vszakats added 19 commits June 11, 2025 06:33

replace cmakelint with cmake-lint (from cmakelang)

c4ce744

Revert "omit function used just once"

01a33a2

This reverts commit ee0ecaa.

add function description

38b6db1

rename cmake-level _FILE_OFFSET_BITS to FILE_OFFSET_BITS to conform w…

1284d43

…ith naming rules fixup

cleanup

492df4a

cleanup

af5eccb

tweak exception

89c5cbb

Better this way because disable= directives apply to the whole file, not just the following line (or lines?)

rename a variable

67550e9

they are a special case, silence instead

8f017ac

It's a `#cmakedefine VAR ${VAR}` case where the two VARs must be the same string to work as expected.

cleanup

af5f3df

fix yaml style

840c5a0

.cmake-format.yaml cleanups

e6c0db6

except differently

47645a4

move config

e96a9b0

Sadly this requires passing `--config-files` after the input files, which needs a xargs hack, which invokes the tool for each file, making it significantly slower.

replace config file with command-line options

b2f2306

re-add links

1c6e1cc

cleanup

ee735a1

update names

9d3af02

vszakats force-pushed the cm-lint branch from b230fd6 to 9d3af02 Compare June 11, 2025 04:33

vszakats closed this in b761eb5 Jun 11, 2025

vszakats deleted the cm-lint branch June 11, 2025 05:08

vszakats mentioned this pull request Oct 20, 2025

cmake: inline linter instructions #19172

Closed

vszakats added a commit that referenced this pull request Oct 20, 2025

cmake: inline linter instructions

b4f57c8

To avoid it applying to all the rest of the script. Follow-up to b761eb5 #17576 Closes #19172

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

cmake: replace `cmakelint` with `cmake-lint` from `cmakelang`, fix issues#17576

cmake: replace `cmakelint` with `cmake-lint` from `cmakelang`, fix issues#17576
vszakats wants to merge 38 commits intocurl:masterfrom
vszakats:cm-lint

vszakats commented Jun 10, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

vszakats commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

vszakats commented Jun 10, 2025 •

edited

Loading