tinymist

Tinymist

Tinymist [ˈtaɪni mɪst] is an integrated language service for Typst [taɪpst]. You can also call it 微wēi霭ǎi in Chinese.

It contains:

• an analyzing library for Typst, see tinymist-query.
• a CLI for Typst, see tinymist.
  • which provides a language server for Typst, see Language Features.
  • which provides a preview server for Typst, see Preview Feature.
• a VSCode extension for Typst, see Tinymist VSCode Extension.

Features

Language service (LSP) features:

• Semantic highlighting
  • The “semantic highlighting” is supplementary to “syntax highlighting”.
• Code actions
  • Also known as “quick fixes” or “refactorings”.
• Formatting (Reformatting)
  • Provide the user with support for formatting whole documents, using typstfmt or typstyle.
• Document highlight
  • Highlight all break points in a loop context.
  • (Todo) Highlight all exit points in a function context.
  • (Todo) Highlight all captures in a closure context.
  • (Todo) Highlight all occurrences of a symbol in a document.
• Document links
  • Renders path or link references in the document, such as image("path.png") or bibliography(style: "path.csl").
• Document symbols
  • Also known as “document outline” or “table of contents” in Typst.
• Folding ranges
  • You can collapse code/content blocks and headings.
• Goto definitions
  • Right-click on a symbol and select “Go to Definition”.
  • Or ctrl+click on a symbol.
• References
  • Right-click on a symbol and select “Go to References” or “Find References”.
  • Or ctrl+click on a symbol.
• Hover tips
  • Also known as “hovering tooltip”.
  • Render docs according to tidy style.
• Inlay hints
  • Inlay hints are special markers that appear in the editor and provide you with additional information about your code, like the names of the parameters that a called method expects.
• Color Provider
  • View all inlay colorful label for color literals in your document.
  • Change the color literal’s value by a color picker or its code presentation.
• Code Lens
  • Should give contextual buttons along with code. For example, a button for exporting your document to various formats at the start of the document.
• Rename symbols and embedded paths
• Help with function and method signatures
• Workspace Symbols
• Code Action
  • Increasing/Decreasing heading levels.
  • Turn equation into “inline”, “block” or “multiple-line block” styles.
• experimental/onEnter
  • Enter inside triple-slash comments automatically inserts ///
  • Enter in the middle or after a trailing space in // inserts //
  • Enter inside //! doc comments automatically inserts //!
  • Enter inside equation markups automatically inserts indents.

Extra features:

• Compiles to PDF on save (configurable to as-you-type, or other options). Check Docs: Exporting Documents.
• Also compiles to SVG, PNG, HTML, Markdown, Text, and other formats by commands, vscode tasks, or code lenses.
• Provides test, benchmark, coverage collecting on documents and modules. Check Docs: Testing Features.
• Provides builtin linting. Check Docs: Linting Features.
• Provides a status bar item to show the current document’s compilation status and words count.
• Editor tools:
  • View a list of templates in template gallery. (tinymist.showTemplateGallery)
  • Click a button in template gallery to initialize a new project with a template. (tinymist.initTemplate and tinymist.initTemplateInPlace)
  • Trace execution in current document (tinymist.profileCurrentFile).

Versioning and Release Cycle

Tinymist’s versions follow the Semantic Versioning scheme, in format of MAJOR.MINOR.PATCH. Besides, tinymist follows special rules for the version number:

• If a version is suffixed with -rcN (), e.g. 0.11.0-rc1 and 0.12.1-rc1, it means this version is a release candidate. It is used to test publish script and E2E functionalities. These versions will not be published to the marketplace.
• If the PATCH number is odd, e.g. 0.11.1 and 0.12.3, it means this version is a nightly release. The nightly release will use both tinymist and typst at main branch. They will be published as prerelease version to the marketplace. Note that in nightly releases, we change #sys.version to the next minor release to help develop documents with nightly features. For example, in tinymist nightly v0.12.1 or v0.12.3, the #sys.version is changed to version(0, 13, 0).
• Otherwise, if the PATCH number is even, e.g. 0.11.0 and 0.12.2, it means this version is a regular release. The regular release will always use the recent stable version of tinymist and typst.

The release cycle is as follows:

• If there is a typst version update, a new major or minor version will be released intermediately. This means tinymist will always align the minor version with typst.
• If there is at least a bug or feature added this week, a new patch version will be released.

Installation

Follow the instructions to enable tinymist in your favorite editor.

• VS Cod(e,ium)
• Neovim
• Emacs
• Sublime Text
• Helix
• Zed

Installing Regular/Nightly Prebuilds from GitHub

Note: if you don’t know what is a regular/nightly release, please don’t follow this section.

Besides published releases specific to each editor, you can also download the latest regular/nightly prebuilts from GitHub and install them manually.

• Regular prebuilts can be found in GitHub Releases.
• Nightly prebuilts can be found in GitHub Actions.
  • (Suggested) Use the tinymist-nightly-installer to install the nightly prebuilts automatically.
    • Unix (Bash):

      curl -sSL https://github.com/hongjr03/tinymist-nightly-installer/releases/latest/download/run.sh | bash
      

    • Windows (PowerShell):

      iwr https://github.com/hongjr03/tinymist-nightly-installer/releases/latest/download/run.ps1 -UseBasicParsing | iex
      

  • The prebuilts for other revisions can also be found manually. For example, if you are seeking a nightly release for the featured PR: build: bump version to 0.11.17-rc1, you could click and go to the action page run for the related commits and download the artifacts.

To install extension file (the file with .vsix extension) manually, please Ctrl+Shift+X in the editor window and drop the downloaded vsix file into the opened extensions view.

Documentation

See Online Documentation.

Packaging

Stable Channel:

Nightly Channel:

Roadmap

Short Terms

To encourage contributions, we create many Pull Requests in draft to navigate short-term plans. They give you a hint of what or where to start in this large repository.

Long Terms

We are planning to implement the following features in typst v0.14.0 or spare time in weekend:

• Type checking: Complete the type checker.
• Periscope renderer: Disabled since vscode rejects to render SVGs containing foreignObjects.
• Inlay hints: Disabled by default because of performance issues.
• Find references of dictionary fields and named function arguments.
• Improve symbol view’s appearance.
• Improve package view.
  • Navigate to symbols by clicking on the symbol name in the view.
  • Automatically locate the symbol item in the view when viewing local documentation.
  • Remember the recently invoked package commands, e.g. “Open Docs of @preview/cetz:0.3.1”, “Open directory of @preview/touying:0.5.3”.
• Improve label view.
  • Group labels.
  • Search labels.
  • Keep (persist) group preferences.
• Improve Typst Preview.
  • Pin drop-down: Set the file to preview in the drop-down for clients that doesn’t support passing arguments to the preview command.
  • Render in web worker (another thread) to reduce overhead on the electron’s main thread.
• Spell checking: There is already a branch but no suitable (default) spell checking library is found.
  • typos is great for typst. harper looks promise.

If you are interested in any of the above features, please feel free to send Issues to discuss or PRs to implement to GitHub.

Contributing

Please read the CONTRIBUTING.md file for contribution guidelines.

Sponsoring

Tinymist thrives on community love and remains proudly independent. While we don’t accept direct project funding, we warmly welcome support for our maintainers’ personal efforts. Please go to Maintainers Page and Contributors Page and find their personal pages for more information. It is also welcomed to directly ask questions about sponsoring on the GitHub Issues.

Acknowledgements

• Part of the code is inherited from typst-lsp
• The integrating offline handwritten-stroke recognizer is powered by Detypify.
• The integrating preview service is powered by typst-preview.
• The integrating local package management functions are adopted from vscode-typst-sync.