doc: add instructions to build with ninja (#1709)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36f5639..6485f42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md
@@ -92,6 +92,9 @@ compile and run all tests under folders threadsafe_function and typed_threadsafe_function and also the objectwrap.cc file npm run unit --filter='*function objectwrap' +As an alternative, `ninja` can be used to build the tests. Please +follow the instructions in [Build with ninja](doc/contributing/build_with_ninja.md). + ## Debug To run the **node-addon-api** tests with `--debug` option:
diff --git a/doc/contributing/build_with_ninja.md b/doc/contributing/build_with_ninja.md new file mode 100644 index 0000000..d59e9bb --- /dev/null +++ b/doc/contributing/build_with_ninja.md
@@ -0,0 +1,16 @@ +# Build Test with Ninja + +Ninja can be used to speed up building tests with optimized parallelism. + +To build the tests with ninja and node-gyp, run the following commands: + +```sh +/node-addon-api $ node-gyp configure -C test -- -f ninja +/node-addon-api $ ninja -C test/build/Release +# Run tests +/node-addon-api $ node ./test/index.js + +# Run tests with debug addon +/node-addon-api $ ninja -C test/build/Debug +/node-addon-api $ NODE_API_BUILD_CONFIG=Debug node ./test/index.js +```