Crate tinymist

tinymist

This crate provides a CLI that starts services for Typst. It provides:

• tinymist lsp: A language server following the Language Server Protocol.
• tinymist preview: A preview server for Typst.

Usage

See Features: Command Line Interface.

Documentation

See Crate Docs.

Also see Developer Guide: Tinymist LSP.

Contributing

See CONTRIBUTING.md.

Re-exports

• pub use tinymist_query as query;

Modules

• export
• project
  The project.
• tool
  All the language tools provided by the tinymist crate.
• world
  World implementation of typst for tinymist.

Structs

• BackgroundPreviewOpts
  Options for background preview.
• BrowsingPreviewOpts
  Options for browsing preview.
• CompileFontArgs
  The font arguments for the compiler.
• CompileOnceArgs
  Common arguments of compile, watch, and query.
• CompilePackageArgs
  Arguments related to where packages are stored in the system.
• Config
  The user configuration read from the editor.
• ConstConfig
  Configuration set at initialization that won’t change within a single session.
• ConstDapConfig
  Configuration set at initialization that won’t change within a single DAP session.
• DapRegularInit
  The regular initializer.
• DapSuperInit
  The super DAP initializer.
• LintFeat
  The lint features.
• LspClient
  The host for the language server, or known as the LSP client.
• PreviewFeat
  The preview features.
• RegularInit
  The regular initializer.
• ServerState
  The object providing the language server functionality.
• SuperInit
  The super LSP initializer.
• TypstExtraArgs
  The extra typst arguments passed to the language server. You can pass any arguments as you like, and we will try to follow behaviors of the same version of typst-cli.
• UserActionTask
  The user action task.

Enums

• FormatterMode
  The mode of the formatter.
• SemanticTokensMode
  The mode of semantic tokens.
• ServerEvent
  An event sent to the language server.

Traits

• AddCommands
  Capability to add valid commands to the arguments.

Type Aliases

• DapPathFormat
  Determines in what format paths are specified. The default is path, which is the native format.