Repository navigation
Build clang-tidy support into node-cpp-skel #63
Description
The clang-tidy command is a powerful tool from the llvm suite with the ability to:
- apply a large set of robustness checks
- automatically modernize code
Details at https://clang.llvm.org/extra/clang-tidy/
clang-tidy uses static analysis
We should integrate an easy clang-tidy workflow into node-cpp-skel by following the lead of both nodejs core, mapbox-gl-native, and OSRM:
- tools: add compile_commands.json gyp generator nodejs/node#7986
- Re-enable tidy checks mapbox-gl-native#5325
- Project-OSRM/osrm-backend@998abf0
Note: I presume clang-tidy will find very few issues with the current node-cpp-skel code, since it is fairly simple. The main idea here is to put this in place so that modules based on node-cpp-skel will more readily catch bugs before they hit production.
Activity
springmeyer commentedon Aug 17, 2017
One challenge here is that clang-tidy needs to compile the code to do its checks. And to compile node-cpp-skel code requires a variety of unique include paths to node-gyp bundled headers and
nan.hin node_modules, and any mason deps.To avoid needing to write a second build system to collect and pass all these paths, it is best to have the build system generate a
compile_commands.jsonthatclang-tidycan consume. The format is basically an JSON array of which files are compiled, with what compiler args should be used. It is described in detail at https://clang.llvm.org/docs/JSONCompilationDatabase.html.The
cmakebuild system has support for outputting compile commands this withcmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON. But we don't usecmakehere because the nodejs standard isgyp. So the question becomes how to generate thecompile_commands.jsonourselves.I've found https://github.com/rizsotto/Bear, but it looks like overkill. It would need to be compiled itself, packaged in mason, and who knows how well it works.
So, instead I think we should write a command that captures the output of the existing build, parses it, and rewrites the
compile_commands.jsonfrom it. We can pipe the output of the existing build into this tool in order to capture it.fix two errors identified by clang-tidy
springmeyer commentedon Aug 25, 2017
Done in #64