Working on this project

This project uses git submodules, so the correct way to get it is:

git clone --recursive git@github.com:uhop/node-re2.git
cd node-re2

For older versions of git:

git clone git@github.com:uhop/node-re2.git
cd node-re2
git submodule update --init --recursive

Make sure you have the necessary node-gyp dependencies for your platform, then run:

npm install

By default npm install downloads a prebuilt binary matching the version in package.json. To force a local build, either change the version to something like 2.0.0-pre, or create a .development file in the project root (it is gitignored).

.gitignore also lists .developmentx and .xdevelopment as convenient rename targets for .development when you want to toggle between local builds and prebuilt downloads.

To update a vendored dependency (e.g., google/re2):

cd vendor/re2
git checkout TAG # e.g., git checkout 2022-06-01