CONTRIBUTING.md

CONTRIBUTING

(TBD)

Dev

Setup node

Node version should be matched with package.json engines field.

ex) Install node using mise

$ mise use node@{version}
$ npm install

Run docs locally

$ cd docs/
$ npx live-server

wasm build should be updated

Run playground locally

$ npm exec -- tree-sitter build --wasm
$ npm exec tree-sitter playground

Build

$ npm run install
$ npm exec -- tree-sitter build --wasm

# update docs assets and versions

Publish Bindings

After update release version, change version in package.json and Cargo.toml. Also update lockfile with npm i --package-lock-only and cargo clean.

Bindings will be published by publish workflow. To publish manually, follow below.

Node (npm)

• https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages

$ npm login
$ npm publish

Check before publish with --dry-run

Rust (crates.io)

• https://doc.rust-lang.org/cargo/reference/publishing.html

$ cargo login
$ cargo publish

Check before publish with --dry-run

python

• https://packaging.python.org/en/latest/tutorials/packaging-projects/

$ rye sync
$ rye add twine

Setup python and install twine (ex. rye)

$ rye build --sdist --wheel

Build python package. Note that this will build wheel only for the current platform.

go

(TBD)