tree-sitter-rsm

tree-sitter-rsm

This is the reference implementation of the Readable Science Markup (RSM) language, written as a tree-sitter grammar. RSM is one of the cornerstone components of the Aris system. For more information see here.

Development

The two main files are grammar.js and src/scanner.c which implement the language grammar and the external scanner, respectively. The tests are defined in test/corpus/*.txt, and can be executed via npx tree-sitter test.

Compile the grammar locally by executing

npx tree-sitter generate --abi 14

and build locally by executing

npx tree-sitter build

Once development of a feature is complete, submit a PR.

Publishing

The grammar is released as a PyPI package by following these intructions. At the time of writing, a summarized version of the instructions are the following:

• Bump the grammar version with npx tree-sitter version <version> and commit the changes generated.
• Tag the commit with git tag -- v<version>.
• Push the commit and tag with git push --tags origin main.
• The publish.yml GitHub workflow will take care of the rest.