lgeiger / napi-prebuild-starter

Create and package Node.js N-API modules using prebuildify and Azure pipelines

N-API Prebuild Starter

This is a small sample repository that uses prebuildify and Azure Pipelines to automatically build and publish a fully contained N-API hello world app.

It can be installed without the need for setting up a complete node-gyp build toolchain. It ships with prebuilt binaries for the following platforms:

• Windows (x64 and ia32)
• macOS (x64)
• Linux (x64, ARM and ARM64)

Install it just like any other npm module not containing any native C++ code:

npm i @lgeiger/napi-prebuild-starter

Further reading:

• https://www.nearform.com/blog/the-future-of-native-modules-in-node-js/
• https://github.com/mafintosh/prebuildify
• https://azure.microsoft.com/en-us/services/devops/pipelines/
• https://nodejs.org/api/n-api.html
• https://github.com/nodejs/node-addon-examples/tree/master/1_hello_world
• https://github.com/nodejs/node-addon-api

napi-prebuild-starter's Issues

Improve npm publish

Currently the publish job runs on every commit and relies on npms behavior not to publish existing versions twice.

This should be changed to only run when a tag is pushed.

Investigate in better ways to authenticate npm

Currently the tag is written to the .npmrc file which could be accidentally published in the module.