Skip to content

doc: add instructions to build with ninja #1709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
legendecas wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

doc: add instructions to build with ninja #1709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ Multiple filter conditions can be joined to broaden the test selection
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:
Expand Down
16 changes: 16 additions & 0 deletions doc/contributing/build_with_ninja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```