Improving code formatting docs with additional efficiency recommendations - Githubissues

mapbox / node-cpp-skel

Skeleton for bindings to C++ libraries for Node.js using node-addon-api

Creative Commons Zero v1.0 Universal

72 stars 10 forks source link

Improving code formatting docs with additional efficiency recommendations #97

Open springmeyer opened 6 years ago

springmeyer commented 6 years ago

node-cpp-skel has support for:

a .clang-format style file that provides formatting rules (which can be modified/customized)
make format an easy command to run to consistently format all the code (and ensure a consistent version of clang-format is available)
a travis job that runs a check to catch when you've forgotten to format your code and in contains incorrectly formatted code (uses same clang-format version as is used locally by make format)

We can improve by adding docs/recommendations for developers for how to:

add a git commit hook to ensure code is formatted (before pushing) - refs http://www.duskborn.com/git-pre-commit-clang-format-hook/
integrate the mason installed clang-format with common text editors such that formatting happens during coding (like seen in https://youtu.be/uZI_Qla4pNA?t=1904)