RsvimSyn

The Rsvim.syn global object for javascript runtime (editor process).

Example

// Create a alias to 'Rsvim.syn'.
const syn = Rsvim.syn;

Type Aliases

Type Alias	Description
LoadParserOptions	Options to load a tree-sitter parser. See RsvimSyn.loadParser
ParserMetadata	Tree-sitter parser metadata. See RsvimSyn.getParserMetadata

Functions

Function	Description
getParserMetadata	Get tree-sitter parser metadata by parser name. Example // Get parser metadata by name. const parserMetadata = Rsvim.syn.getParserMetadata("rust"); Rsvim.cmd.echo(`Rust parser metadata: ${parserMetadata}`);
listParsers	List all loaded tree-sitter parsers. Example // Print all loaded parser names. const allParserNames = Rsvim.syn.listParsers(); Rsvim.cmd.echo(`All loaded parsers: ${allParserNames}`);
loadParser	Load tree-sitter parsers. See tree-sitter - List of parsers Throws Throws TypeError if options is an invalid option, throws Error if failed to load. Example // Load `tree-sitter-c` parser. const parserNames = await Rsvim.syn.loadParser({grammarPath: "./tree-sitter-c"}); Rsvim.cmd.echo(`Loaded parsers: ${parserNames}`);
loadParserSync	Load tree-sitter parsers synchronizely. See loadParser Throws Throws TypeError if options is an invalid option, throws Error if failed to load. Example // Load `tree-sitter-c` parser synchronizely. const parserNames = Rsvim.syn.loadParserSync({grammarPath: "./tree-sitter-c"}); Rsvim.cmd.echo(`Loaded parsers: ${parserNames}`);