Code suggestions do not respect .clang-format

[jmillan]

PR suggestions generated by clang-tidy-review are taken from the exported fixes ('--export-fixes' option). For example:

- DiagnosticName:  misc-const-correctness
    DiagnosticMessage:
      Message:         'variable ''isSyncPacket'' of type ''bool'' can be declared ''const'''
      FilePath:        '/Users/jmillan/src/mediasoup/worker/src/RTC/SvcConsumer.cpp'
      FileOffset:      19028
      Replacements:
        - FilePath:        '/Users/jmillan/src/mediasoup/worker/src/RTC/SvcConsumer.cpp'
          Offset:          19033
          Length:          0
          ReplacementText: 'const '
    Level:           Warning
    BuildDirectory:  '/Users/jmillan/src/mediasoup/worker/out/Release/build'

These fixes do not consider the format defined in .clang-format, even though .clang-tidy indicates so via FormatStyle: file.

This is a known limitation as indicated here.

The problem is that the current flow is broken:

1. Create a PR.
2. clang-tidy-review github action runs.
3. It suggests a code change (with wrong format)
4. Suggestion is committed.
5. GH actions are restarted.
6. The GH action running clang-format fails.

[ZedThree]

Hmm, I'm not sure how we can fix this. In step 4, you're talking about committing the suggestions through GitHub's interface, right? So it's not like we can use clang-apply-replacements here.

I guess we could use clang-apply-replacements for each fix one at a time, and then report the new diff as the suggestion?

Sounds like a bit of a cop-out from clang-tidy to not do this properly themselves! 😄

[jmillan]

you're talking about committing the suggestions through GitHub's interface, right?

Correct.

I don't have a solution neither. I've verified that run-clang-tidy creates the proper fix when indicating -fix -format.

I guess one can always:
4. Suggestion commited.
5. Pull.
6. Run clang-format locally.
7. Push.