453af362cb
Co-authored-by: rpitre-wetdog <129877142+rpitre-wetdog@users.noreply.github.com> Co-authored-by: Tadej Novak <tadej@tano.si> Co-authored-by: Robin <boldtrn@users.noreply.github.com> Co-authored-by: Siarhei Fedartsou <siarhei.fedartsou@gmail.com>
108 lines
3.4 KiB
Markdown
108 lines
3.4 KiB
Markdown
# Developing the Maplibre GL Native Node.js module
|
||
|
||
This document explains how to build the [Node.js](https://nodejs.org/) bindings for [Maplibre GL Native](../../README.md) for contributing to the development of the bindings themselves. If you just want to use the module, you can simply install it via `npm`; see [README.md](README.md) for installation and usage instructions.
|
||
|
||
## Building
|
||
|
||
To develop these bindings, you’ll need to build them from source. Building requires the prerequisites listed in either
|
||
the [macOS](../macos/INSTALL.md#requirements) or [Linux](../linux/README.md#prerequisites) install documentation, depending
|
||
on the target platform.
|
||
|
||
First you'll need to install dependencies:
|
||
|
||
|
||
#### MacOS
|
||
|
||
```bash
|
||
brew install \
|
||
cmake \
|
||
ccache \
|
||
ninja \
|
||
pkg-config \
|
||
glfw3 \
|
||
libuv
|
||
```
|
||
|
||
#### Linux (Ubuntu)
|
||
|
||
```bash
|
||
sudo apt-get install -y \
|
||
ccache \
|
||
cmake \
|
||
ninja-build \
|
||
pkg-config \
|
||
xvfb \
|
||
libcurl4-openssl-dev \
|
||
libglfw3-dev \
|
||
libuv1-dev \
|
||
g++-10 \
|
||
libc++-9-dev \
|
||
libc++abi-9-dev
|
||
/usr/sbin/update-ccache-symlinks
|
||
```
|
||
|
||
### Compiling
|
||
|
||
To compile the Node.js bindings and install module dependencies, from the repository root directory, first run:
|
||
|
||
#### MacOS
|
||
|
||
```bash
|
||
cmake . -B build -G Ninja -DMLN_WITH_NODE=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_BUILD_TYPE=Debug -DMBGL_WITH_COVERAGE=ON
|
||
```
|
||
|
||
#### Linux
|
||
|
||
```bash
|
||
cmake . -B build -G Ninja -DMLN_WITH_NODE=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_C_COMPILER=gcc-10 -DCMAKE_CXX_COMPILER=g++-10
|
||
```
|
||
|
||
### Building
|
||
|
||
Finally, build:
|
||
```bash
|
||
cmake --build build -j $(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null)
|
||
```
|
||
|
||
|
||
If you are rebuilding after time has passed.
|
||
|
||
Then do:
|
||
|
||
```bash
|
||
make node
|
||
```
|
||
|
||
## Testing
|
||
|
||
To test the Node.js bindings:
|
||
|
||
```bash
|
||
npm test
|
||
```
|
||
|
||
|
||
## Merging your pull request
|
||
|
||
To clean up your pull request and prepare it for merging, update your local `main` branch, then run `git rebase -i main` from your pull request branch to squash/fixup commits as needed. When your work is ready to be merged, you can run `git merge --ff-only YOUR_BRANCH` from `main` or click the green merge button in the GitHub UI, which will automatically squash your branch down into a single commit before merging it.
|
||
|
||
## Publishing
|
||
|
||
To publish a new version of the package:
|
||
- [ ] make a commit in the release branch which includes:
|
||
- [ ] an updated version number in [`package.json`](../../package.json#L3)
|
||
- [ ] an entry in [`platform/node/CHANGELOG.md`](CHANGELOG.md) describing the changes in the release
|
||
- [ ] run `git tag node-v{VERSION}` where `{VERSION}` matches the version in `package.json`, e.g. `git tag node-v3.3.2`
|
||
- [ ] run `git push && git push --tags`
|
||
|
||
The CI builds for tag pushes will check if the tag matches the version listed in `package.json`, and if so, will run with `BUILDTYPE=Release` and publish a binary with `node-pre-gyp`.
|
||
|
||
Once binaries have been published for Linux and macOS (which can be verified with `./node_modules/.bin/node-pre-gyp info`), you can run a quick final check to ensure they're being fetched properly by simply running `rm -rf lib && npm install`.
|
||
|
||
If everything looks good:
|
||
- [ ] run `mbx npm publish`
|
||
|
||
### Preleases
|
||
|
||
Publishing a prerelease binary can be useful for testing downstream integrations - the workflow is pretty much the same except that you'll be making your version number commit and `git tag node-v{VERSION}` (like `git tag node-v3.3.2-pre.1`) on a pull request branch before merging it rather than on `main`.
|