Basic syntax highlighting

[ktminks]

Description

Implement basic syntax highlighting of rulebook files.

• Create a basic TextMate grammar for declarative (syntax) highlighting,
• Use ANTLR grammar directly via programmatic (semantic) highlighting instead,
• or both.

Tasks

Declarative Approach

• [x] ~Convert ANTLR grammar into a simple TextMate grammar~
  • ~Use ChatGPT as a starting point~
• [x] ~Contribute this grammar to the server appropriately~
• [x] ~Provide very basic highlighting based on this grammar~
• [x] Contribute declarative features using language configuration via the languages contribution point.
  • Can later be supplemented by semantic token recognition
  • This is a common approach

Programmatic Approach

• [x] Completely avoid the use of TextMate grammars
• [x] Determine what data & API routes are needed to implement programmatic (semantic) highlighting
• [x] Implement basic semantic highlighting using regexes based off of ConfigMate grammar
• [ ] Use ANTLR grammar directly via ConfigMate API
• [ ] Implement basic semantic highlighting using mock API routes

Resources

• Syntax highlight guide
• Semantic highlight guide
• Semantic tokens sample
• Relevant Reddit post
• Example LSP that uses an ANTLR-generated parser
• vscode-textmate helper package
• Language configuration guide

[ktminks]

Basic semantic highlighting

using regexes based off the grammar.

Right now, most non-primitive tokens are being recognized as 'keywords'.

API Route

Ideally, I would be able to send a request to the API with the path to a .cms file, and receive its tokenized contents in response.

There is also the option of a "superType" for each type, like primitives, and I can make use of any other relevant information that might be of interest to the user.

Technically all that is required, though, is:

{
   line,              //row number, 0-based index 
   startCharacter,    //col number, 0-based index
   length,            //string length
   tokenType: type,   //standard or custom type
   tokenModifiers: [] //standard or custom modifiers (declaration, definition, readonly, static, etc.), optional 
}