language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-12-23 08:47:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
tinymist/CONTRIBUTING.md
Myriad-Dreamin db314c2ea9
docs: write some developer guides (#372)
2024-07-07 11:26:35 +08:00

2.3 KiB
Raw Blame History

Contributing

Tinymist provides a single integrated language service for Typst.

Multiple Actors – The main component, tinymist, starts as a thread or process, obeying the Language Server Protocol. tinymist will bootstrap multiple actors, each of which provides some typst feature.

Multi-level Analysis – The most critical features are lsp functions, built on the tinymist-query crate. To achieve low latency, functions are classified into different levels of analysis.

  • query_token_cache – TokenRequest – locks and accesses token cache.
  • query_source – SyntaxRequest – locks and accesses a single source unit.
  • query_world – SemanticRequest – locks and accesses multiple source units.
  • query_state – StatefulRequest – acquires to accesses a specific version of compile results.

Optional Features – All rest features in tinymist are optional. The significant features are enabled by default, but you can disable them with feature flags. For example, tinymist provides preview server features powered by typst-preview.

Editor Frontends – Leveraging the interface of LSP, tinymist provides frontends to each editor, located in the editor folder.

Building and Running

To build tinymist LSP:

git clone https://github.com/Myriad-Dreamin/tinymist.git
# Debug
cargo build
# Release
cargo build --release
# RelWithDebInfo (GitHub Release)
cargo build --profile=gh-release

To run VS Code extension locally, open the repository in VS Code and press F5 to start a debug session to extension.

Server Entries

  • tinymist probe – do nothing, which just probes that the binary is working.
  • tinymist lsp – starts the language server.
  • tinymist preview – starts a standalone preview server.

Running Analyzer Tests

This is required if you have changed any code in crates/tinymist-query.

To run analyzer tests for tinymist:

cargo insta test -p tinymist-query --accept

Running E2E Tests

This is required if you have changed any code in crates/tinymist or crates/tinymist-query.

To run e2e tests for tinymist on Unix systems:

./scripts/e2e.sh

To run e2e tests for tinymist on Windows:

./scripts/e2e.ps1