Cmakeformat

[nordicjm]

No description provided.

[tejlmand]

Thanks for looking into this.

I think having a tool for checking CMake formatting can be very useful to ensure
consistency in CMake code-base.

I assume you have also looked into how the tool can be used to check the code, and not just reformat it.

Cause I think it's important that we can check changes and not requesting contributors to re-format all files.

I'm generally not so fixed into a specific coding style, to me consistency is
most important, but what I do find important is that:

• It should be clear to users how code should be written.
  For example it is not clear to me why one message puts FATAL_ERROR together with the text, and on another occasion decides that a newline should be used.
  Ref:
  https://github.com/zephyrproject-rtos/zephyr/blob/fc23487e98f0fbfb55549c52a432d2fec32b5c81/cmake/modules/zephyr_default.cmake#L130
  vs.
  https://github.com/zephyrproject-rtos/zephyr/blob/fc23487e98f0fbfb55549c52a432d2fec32b5c81/cmake/modules/zephyr_default.cmake#L67-L68
• For readability, then it should be allowed to have <arg> <value> on same line.
  For example the following should be allowed to do:

  NO_POLICY_SCOPE
  NAMES ZephyrApp
  PATHS ${APPLICATION_SOURCE_DIR}
  

  compared to:
  https://github.com/zephyrproject-rtos/zephyr/blob/fc23487e98f0fbfb55549c52a432d2fec32b5c81/cmake/modules/zephyr_default.cmake#L48-L52
• We should not need to double maintain function description, which seems to be needed if wanting to tell the tool what a valid arg / val pair is.
  I'm concerned that this will cost to much maintenance to keep up-to-date, and frustration when tool complains for functions where a new argument has suddenly been added.
  If the check can be configured so that it doesn't request a newline but only check indentation in those cases, then I think a lot is already achieved.
  I don't mind the risk of someone doing QUIET NO_POLICY_SCOPE on same line
  Ref:
  https://github.com/zephyrproject-rtos/zephyr/blob/fc23487e98f0fbfb55549c52a432d2fec32b5c81/.cmake-format#L5-L13

[github-actions]

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.