Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.74 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.74 KB
Raw

treesitter4s

Tree-sitter wrapper for Scala (JVM). Uses JNA to wrap the native library.

Usage

Work in progress note

This project is still in the oven and under active development. Don't assume anything will work or that anything will stay as it is right now.

Feel free to try it if that's okay with you ;)

libraryDependencies ++= Seq(
  // Pure Scala interface - cross-compiled for JVM & JS platforms
  "org.polyvariant.treesitter4s" %% "core" % version,
  // Bindings for the JVM artifact. Brings in JNA and the native library.
  // You probably want to use this one.
  "org.polyvariant.treesitter4s" %% "bindings" % version,
  // Language support for a specific language.
  // There's active work to split these out to separate artifacts.
  // "org.polyvariant.treesitter4s" %% "language-scala" % version,
  // "org.polyvariant.treesitter4s" %% "language-python" % version,
)

Goals

  • immutable, read-only, Scala-friendly API
  • complete, 1-1 native/Java interface via JNA
  • binary convenience: no dealing with native libraries if you're on a supported system
  • extensible language support

Supported systems

Support can vary, but the following platforms are considered supported:

  • macOS x86_64
  • macOS aarch64
  • Linux x86_64
  • Linux aarch64

CI runs on x86_64 macOS/Linux machines. Development is currently done on an aarch64 Mac. linux-aarch64 binaries are included thanks to the magic of Nix and Nixbuild, but the library isn't being tested on that platform because GitHub doesn't offer runners for it yet (there's hope).