Adds the clang-format linter

[daltonv]

Fixes #763

Proposed Changes

1. Adds new clang-format linter

Updates the regular descriptor files for a new linter, but limits this linter to only be installed on the new c_cpp flavor, as the clang-extra-tools package is rather large.

The c and cpp tests were updated to satisfy the clang-formats requirements too.

Readiness Checklist

Author/Contributor

• Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
• If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

• Label as breaking if this is a large fundamental change
• Label as either automation, bug, documentation, enhancement, infrastructure, or performance

[daltonv]

Not sure why the CI tests are failing. Looks like the r linter tests are the ones failing.

[daltonv]

Is there a way I can test this branch against another repo? ie run megalinter locally.

I want to ensure the megalinter run picks up the .clang-format file in the root of a repo by default. I would expect it to do this, but it's always nice to test it for real.

[echoix]

Is there a way I can test this branch against another repo? ie run megalinter locally.

I want to ensure the megalinter run picks up the .clang-format file in the root of a repo by default. I would expect it to do this, but it's always nice to test it for real.

If you build the docker image locally, you can then use npx mega-linter-runner --nodockerpull --image <the name of your image:tag> with other options to run it.

[echoix]

Not sure why the CI tests are failing. Looks like the r linter tests are the ones failing.

It was failing yesterday too #3086

[echoix]

Overall it looks really great!

I myself have other questions for @nvuillam :

• When does a linter descriptor need to include the way to call --version?

• Do we support having a linter descriptor copied two times in order to be in two files? Doesn't this create duplicate entries?

[daltonv]

Is there a way I can test this branch against another repo? ie run megalinter locally.
I want to ensure the megalinter run picks up the .clang-format file in the root of a repo by default. I would expect it to do this, but it's always nice to test it for real.

If you build the docker image locally, you can then use npx mega-linter-runner --nodockerpull --image <the name of your image:tag> with other options to run it.

Okay thanks for the tip. Good thing I tried it. There is actually an issue.

I set cli_config_arg_name: "--style". However to set a config file manually you must call clang-format --style=file:.clang-format note there cannot be a space between --style=file: and the file path.

I updated my descriptor to use ``cli_config_arg_name: "--style=file:"` however this does not fix it. When I run manually I see megalinter tries to run

[clang-format] command: ['clang-format', '--Werror', '--dry-run', '--style=file:', '/tmp/lint/.clang-format', <my c files>

Is there a way I can describe in the descriptor to not add a space?

[daltonv]

Worst case scenario with the cli_config_arg_name: we could remove that and the config_file_name from the descriptor. clang-format itself will search for a root level .clang-format file.

[nvuillam]

When does a linter descriptor need to include the way to call --version?

When the argument is not -v :)

Do we support having a linter descriptor copied two times in order to be in two files? Doesn't this create duplicate entries?

With current ML architecture we have no choice, we just have to make sure that the install block lines are exactly the same, to avoid duplicates in Dockerfile

[daltonv]

Just rebased onto main again. Sorry for the force push. I'm used to the rebase workflow for syncing with main. Let me know if you prefer merge commits and I can use them in the future.

[nvuillam]

@daltonv we merge with "squash & merge" option so merge or rebase, the result is the same in the merge commit :)

[daltonv]

@nvuillam sounds good. Just wanted to ask in case it made it easier to review.

[nvuillam]

@daltonv I didn't want to merge just before a new release, but if you merge conflicts, I'll merge the PR and it will be available in beta, then in next release :)

[daltonv]

@nvuillam no worries. I'll fix the conflicts now.

[echoix]

Thanks a lot!!

[vkucera]

Thanks a lot @daltonv ! This is a significant improvement of MegaLinter's assets!

[vkucera]

Is the option to format files in place with the -i option implemented as well?

[daltonv]

@vkucera I didn't add the -i option. Taking another look at the descriptor schema though it should be simple for me to add that as well, I'll make a new issue to track this and I should be able to implement and test this before the next release.

[daltonv]

Adding -i support is tracked at #3137

[vkucera]

@vkucera I didn't add the -i option. Taking another look at the descriptor schema though it should be simple for me to add that as well, I'll make a new issue to track this and I should be able to implement and test this before the next release.

Thanks a lot!