Add linting/codestyle control about flipperzero-firmware HOT 12 CLOSED

(from #39) At this time I prefer default rustfmt settings as code style (https://rust-lang.github.io/rustfmt/?version=master&search=) even in C/C++ code (where applicable, of course)

I suggest adapt rustfmt defaults to clang format

from flipperzero-firmware.

@officialdarksheao can I assign you to this task?

from flipperzero-firmware.

We have a lot of thirdparty SDK code in target_f* folders now, I don't like its style and maybe we should ignore it

from flipperzero-firmware.

@nikita-b can I assign you to this task?

from flipperzero-firmware.

@glitchcore Yes, sure

from flipperzero-firmware.

@nikita-b Do you still want to do this task?

from flipperzero-firmware.

CI pipeline to prevent merge of pull requests if the style check was not successful

Here's an example of an action that executes clang-format on each push. If the code changes after formatting, this action creates an additional commit with a fixed commit message ("apply clang-format").

What do you think about this approach?

from flipperzero-firmware.

@glitchcore Yes, sorry for the delay. I'll start today.

from flipperzero-firmware.

CI pipeline to prevent merge of pull requests if the style check was not successful

Here's an example of an action that executes clang-format on each push. If the code changes after formatting, this action creates an additional commit with a fixed commit message ("apply clang-format").

What do you think about this approach?

Wouldn't it be better if a pre-commit hook ran clang-format check, detected if the output differed from the input file and notified the developer with a warning and a hint to run clang-format manually?

This way developers are encouraged to periodically (or automatically) run clang-format themselves and even more importantly, will prevent pollution of git history with formatting commits.

from flipperzero-firmware.

Wouldn't it be better if a pre-commit hook ran clang-format check, detected if the output differed from the input file and notified the developer with a warning and a hint to run clang-format manually?

Since the pre-commit hooks run locally on the developer's machine, and the clang-format parameters change from version to version, we'll need to make sure that all developers have the same clang-format version.

from flipperzero-firmware.

Formatting errors can be detected with the following command:

clang-format --dry-run --Werror --ferror-limit=1 <file>

from flipperzero-firmware.

CI pipeline to prevent merge of pull requests if the style check was not successful

Here's an example of an action that executes clang-format on each push. If the code changes after formatting, this action creates an additional commit with a fixed commit message ("apply clang-format").
What do you think about this approach?

Wouldn't it be better if a pre-commit hook ran clang-format check, detected if the output differed from the input file and notified the developer with a warning and a hint to run clang-format manually?

This way developers are encouraged to periodically (or automatically) run clang-format themselves and even more importantly, will prevent pollution of git history with formatting commits.

Pre-commit hook is a great idea, but I think it'll be more complicated for contributors with the Windows machine and new contributors. I suggest starting with CI and git history won't be a problem if we squash commits before a merge.

from flipperzero-firmware.