tree-sitter-rstml

Rust + html grammar for the tree-sitter parser library.

Rust web frameworks, like Leptos, rely on JSX-style templates embedded inside Rust code using the rstml library. This project enables the parsing of those templates for various purposes, such as syntax highlighting in text editors.

Usage

Since rstml isn't a supposed to be a standalone language, there are two grammars defined for convenience:

<div>Hello, world</div>

view! {
    <div>Hello, world</div>
}

let code = "<div>Hello, world</div>";
let mut parser = tree_sitter::Parser::new();
parser.set_language(tree_sitter_rstml::language_rstml()).expect("Error loading rstml grammar");
let tree = parser.parse(code, None).unwrap();

let code = r#"
    view! {
        <div>hello, world</div>
    }
"#;
let mut parser = tree_sitter::Parser::new();
parser.set_language(tree_sitter_rstml::language_rust_with_rstml()).expect("Error loading rust_with_rstml grammar");
let tree = parser.parse(code, None).unwrap();

const Parser = require('tree-sitter')
const code = '<div>Hello, world</div>'
const parser = new Parser()
parser.setLanguage(require('tree-sitter-rstml').rstml)
const tree = parser.parse(code)

const Parser = require('tree-sitter')
const code = `
    view! {
        <div>Hello, world</div>
    }
`
const parser = new Parser()
parser.setLanguage(require('tree-sitter-rstml').rust_with_rstml)
const tree = parser.parse(code)

Editor support

Neovim

Neovim's tree-sitter integration supports syntax highlighting, indentation, and code folding.

Without rstml highlighting	With rstml highlighting

To use the Neovim support with nvim-treesitter, you should:

• Ensure "nvim-treesitter/nvim-treesitter" is installed and configured correctly.
• Install the "rayliwell/tree-sitter-rstml" plugin in your preferred package manager.
• Ensure require("tree-sitter-rstml").setup() is ran after every time nvim-treesitter is loaded.

Here's an example config using lazy.nvim:

require("lazy").setup({
    {
        "nvim-treesitter/nvim-treesitter",
        build = ":TSUpdate",
        config = function ()
            local configs = require("nvim-treesitter.configs")

            configs.setup({
                ensure_installed = { "c", "lua", "vim", "vimdoc", "query", "rust" },
                sync_install = false,
                highlight = { enable = true },
                indent = { enable = true },
            })
        end
    },
    {
        "rayliwell/tree-sitter-rstml",
        dependencies = { "nvim-treesitter" },
        build = ":TSUpdate",
        config = function ()
    	   require("tree-sitter-rstml").setup()
        end
    },
    -- Experimental automatic tag closing and renaming (optional)
    {
        "rayliwell/nvim-ts-autotag",
        config = function()
            require("nvim-ts-autotag").setup()
        end,
    },
})

[!NOTE] Neovim support is intended to work on the latest Neovim release and version of nvim-treesitter. If you are using a Neovim distribution, like LunarVim, support is not guarenteed.

NixVim (Advanced)

To use the NixVim integration with flakes, you should:

• Add github:rayliwell/tree-sitter-rstml as a flake input.
• Import inputs.tree-sitter-rstml.nixvimModule inside of your NixVim configuration.

For example:

{
  description = "NixVim configuration with tree-sitter-rstml.";

  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
    nixvim.url = "github:nix-community/nixvim";
    tree-sitter-rstml.url = "github:rayliwell/tree-sitter-rstml/flake";
  };

  outputs =
    {
      system,
      nixpkgs,
      nixvim,
      tree-sitter-rstml,
      ...
    }:
    let
      forAllSystems =
        function:
        nixpkgs.lib.genAttrs [
          "aarch64-darwin"
          "aarch64-linux"
          "x86_64-darwin"
          "x86_64-linux"
        ] (system: function nixpkgs.legacyPackages.${system});
    in
    {
      packages = forAllSystems (pkgs: {
        default = nixvim.legacyPackages.${system}.makeNixvimWithModule {
          inherit pkgs;
          module = {
            imports = [ tree-sitter-rstml.nixvimModule ];
          };
        };
      });
    };
}

Emacs

Emacs' (29.1+) tree-sitter integration supports syntax highlighting and indentation.

Before (rust-ts-mode)	After (rstml-ts-mode)

Emacs support is provided by the rstml-ts-mode package.

You can read more on the project's GitHub.

Acknowledgements

This project extends and heavily relies upon the tree-sitter-rust grammar. It would not be possible without its contributors, as well as those who have contributed to the wider tree-sitter ecosystem.

Additionally, this project is based on the work of the rstml library. Originating as a fork of syn-rsx, whose creator, unfortunately, has passed away.

License

Licensed under the MIT License.

Copyright © 2024 Ryan Halliwell