Best way to implement custom language support with Tree-sitter in Sora Editor?

[mbedjoko]

I’m experimenting with integrating custom language support in Sora Editor using the Tree-sitter module.

From the documentation, it seems that Tree-sitter can be used to build an incremental syntax tree and enable accurate syntax highlighting and analysis. However, I’m not sure what the recommended workflow is for adding a completely new language.

For example:
• What is the correct process for compiling a Tree-sitter grammar for Android?
• How should the required query files (highlights.scm, locals.scm, etc.) be structured for compatibility with Sora Editor?
• Are there examples of integrating a custom language beyond the provided modules?

Any guidance or references to example implementations would be very helpful.

[mbedjoko]

Thank you in advance

[mbedjoko]

Waiting for your response

[Rosemoe]

• For compiling a new language for tree-sitter, take a look at the original repository of android-tree-sitter. Language sources can be found under tree-sitter organization
• For an example of tree-sitter based language implementation, see langJava.kt
• For scm formats:
  • highlight.scm: can be obtained usually in the language repository or nvim-treesitter. The capture names can be used in TsThemeBuilder to highlight the captured regions
  • brackets.scm, blocks.scm: view the explanation at the example file beginning
  • locals.scm: can be obtained also from nvim-treesitter. Adjust the capture name spec to make it compatible with sora-editor implementation. Take a look at LocalsCaptureSpec.kt
• Generally, we recommend using TextMate for syntax-highlighting and LSP to offer language-specific completions, inlay hints, etc. That's also what our end-developers usually do. So it's rare to find a custom language implementation.
• Using tree-sitter instead might need a analysis system from scratch to provide exact semantic completions. The module is originally proposed and designed for AndroidIDE, which also implemented its own language analysis system.