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

This document gives an overview of tinymist service, which provides a single integrated language service for Typst. This document doesn't dive in details unless necessary.

#

Principles

Four principles are followed, as detailed in Principles.

  • Multiple Actors
  • Multi-level Analysis
  • Optional Non-LSP Features
  • Minimal Editor Frontends

#

Command System

The extra features are exposed via LSP's workspace/executeCommand request, forming a command system. They are detailed in Command System.

#

Additional Concepts for Typst Language

#

AST Matchers

Many analyzers don't check AST node relationships directly. The AST matchers provide some indirect structure for analyzers.

  • Most code checks the syntax object matched by get_deref_target or get_check_target.
  • The folding range analyzer and def-use analyzer check the source file on the structure named lexical hierarchy.
  • The type checker checks constraint collected by a trivial node-to-type converter.

#

Type System

Check Type System for more details.

#

Notes on Implementing Language Features

Five basic analysis like lexical hierarchy, def use info and type check info are implemented first. And all rest Language features are implemented based on basic analysis. Check Analyses for more details.