Research Language Support

[ktminks]

Description

Form an understanding of VS Code extensions that provide language support using TextMate grammars and semantic highlighting. Look into their options for implementation, tools for debugging, and any popular helper libraries. Document findings in the wiki.

Research

Implementations

• [x] Language Extensions
• [x] Language Client & Server [LSP sample] [Multi-server sample]
• [x] Language Server Protocol
  • standardized interface for a language server
  • works in multiple dev tools (Atom, etc.)
  • can support multiple languages
• [x] TextMate grammars [Intro to TextMate Grammars]
• [x] Semantic Highlighting [Semantic Tokens sample ]

Debug Tools

• [x] scope inspector

Helper libraries

• [x] vscode-textmate

Other Links

These may or may not be useful in our intended implementation.

• Syntax Highlighting
• Defining a Color Theme
• Text Decorator

[ktminks]

Backlogging, potentially to be scrapped. Would be a great stretch goal, but not needed for MVP. Simplified Go server here

[ktminks]

Possible features:

• Add support for a rulebook-specific language:
  • Declarative Language Features
    • Syntax highlighting
    • Bracket matching
    • Bracket autoclosing
    • Bracket autosurrounding
    • Comment toggling
    • Auto indentation
    • Folding (by markers)
  • Programmatic Language Features
    • Semantic highlighting
    • Outline for an initial file
    • Auto-completion proposals using context-aware IntelliSense
    • Symbol definitions that provide:
      • Hover information
      • Description
      • Type
      • Sample usage
• Enhance diagnostic feedback:
  • Suggest Code Actions on error or warning
  • CodeLens actionable, contextual information displayed interspersed with source code