mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-08-04 18:28:02 +00:00

docs: maintain readme and command docs (#733 )

* docs: maintain readme and command docs

* docs: update inline images

* test: update snapshot

* test: update baseline

* test: update baseline

2024-10-26 22:47:12 +08:00

3.1 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_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.

Installing Toolchain

Cargo – Cargo is the Rust package manager.
Yarn – Yarn is a package manager that doubles down as project manager.

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.

Local Documentation

To serve the documentation locally, run:

yarn docs

To generate and open crate documentation, run:

yarn docs:rs --open

Tip

Check Shiroa to install the shiroa command for documentation generation.

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

Tip

Check Cargo Insta to learn and install the insta command.

Running Syntax Grammar Tests

This is required if you are going to change the textmate grammar in syntaxes/textmate.

# in root
yarn test:grammar
# Or in syntaxes/textmate
cd syntaxes/textmate && yarn test

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

3.1 KiB Raw Blame History Unescape Escape