Is it possible to use cpp-linter-action with PlatformIO?

[AlexandreHiroyuki]

I tried implementing the GitHub Action in a repository using PlatformIO, but it has issues finding libraries provided by the package manager.

Posting comment(s)
  Notice: File test/test_TamanduContext/TamanduContext.test.cpp does not conform to LLVM style guidelines. (lines 42)
  Error: 'Arduino.h' file not found
  Error: 'TamanduContext.hpp' file not found
  INFO:CPP Linter:1 clang-format-checks-failed
  INFO:CPP Linter:2 clang-tidy-checks-failed
  INFO:CPP Linter:3 checks-failed

Question

PlatformIO has support for linting but I wanted to have a better CI using cpp-linter-action.

Would it be possible to integrate those systems?

If not, could cpp-lint support packages / build from PlatformIO with proper configuration?

[2bndy5]

It is, but you would need a way of indicating where the Arduino Core (or PlatformIO BSP) sources exists. Typically this would be done with a compilation database generated by CMake. But you can also use extra-args to pass in -I arguments to clang-tidy.

Assuming that nothing in PIO is installed globally (a practice that is strongly discouraged now), you might be able to point clang-tidy to somewhere in the git-ignored .pio folder (build env).

---

PS: I've been using cpp-linter to run clang-format on a majority of the nRF24 repos (Arduino-based C++ libs) since I joined the cpp-linter org.

[2bndy5]

I think PIO supports building a compilation database. (see PIO docs)

pio run --target compiledb

In the past, long ago, I tried using Arduino CLI to generate a compilation database, but it didn't work at the time. I'm not sure if the bugs have been resolved since then.

[2bndy5]

I should also mention that cpp-linter does not support multiple targets (during 1 CI event) at this time. This is only problematic if your project has a lot of #ifdef-guarded portability code (specific to a MCU board or chip family).

[AlexandreHiroyuki]

Thank you so much; it has helped a lot! I tried setting things up with compiledb and it worked fine!

I'll leave my action and tests here if someone researches it and wants to see the results.
The action file: .github/workflows/lint.yml
Pull Request purposely made with errors to test the linter action