1. Introduction
  3. Editor Integration
  4. Common Configurations
  5. 1. Editor Frontends
    1. 1.1. VS Cod(e,ium)
    2. 1.2. Neovim
    3. 1.3. Emacs
    4. 1.4. Sublime Text
    5. 1.5. Helix
    6. 1.6. Zed
  8. Features
  9. 2. Command line interface
  10. 3. Code Documentation
  11. 4. Code Completion
  12. 5. Exporting Documents
  13. 6. Document Preview
  14. 7. Testing
  15. 8. Linting
  16. 9. Other Features
  18. Service Overview
  19. Overview of Service
  20. 10. Principles
  21. 11. Commands System
  22. 12. LSP Inputs
  23. 13. Type System
  25. Service Development
  26. 14. Crate Docs
  27. 15. LSP and CLI
  28. 16. Language Queries
  29. 17. Document Preview

Tinymist Docs

The extra features are exposed via LSP's workspace/executeCommand request, forming a command system. The commands in the system share a name convention.

  • exportFmt. these commands perform export on some document, with a specific format (Fmt), e.g. exportPdf.

  • interactCodeContext({kind}[]). The code context requests are useful for Editor Frontends to extend some semantic actions. A batch of requests are sent at the same time, to get code context atomically.

  • getResources("path/to/resource/", opts). The resources required by Editor Frontends should be arranged in paths. A second arguments can be passed as options to request a resource. This resemebles a restful POST action to LSP, with a url path and a HTTP body, or a RPC with a method name and params.

    Note you can also hide some commands in list of commands in UI by putting them in getResources command.

  • doXxx. these commands are internally for Editor Frontends, and you'd better not to invoke them directly. You can still invoke them manually, as long as you know what would happen.

  • The rest commands are public and tend to be user-friendly.

#

Code Context

The code context requests are useful for Editor Frontends to check syntax and semantic the multiple positions. For example an editor frontend can filter some completion list by acquire the code context at current position.